:py:mod:`agentic_fabric.tools.file_tools`
=========================================

.. py:module:: agentic_fabric.tools.file_tools

.. autodoc2-docstring:: agentic_fabric.tools.file_tools
   :parser: myst
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`GameCodeWriterTool <agentic_fabric.tools.file_tools.GameCodeWriterTool>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeWriterTool
          :parser: myst
          :summary:
   * - :py:obj:`GameCodeReaderTool <agentic_fabric.tools.file_tools.GameCodeReaderTool>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeReaderTool
          :parser: myst
          :summary:
   * - :py:obj:`DirectoryListTool <agentic_fabric.tools.file_tools.DirectoryListTool>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.DirectoryListTool
          :parser: myst
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_workspace_root <agentic_fabric.tools.file_tools.get_workspace_root>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.get_workspace_root
          :parser: myst
          :summary:
   * - :py:obj:`configure_write_restrictions <agentic_fabric.tools.file_tools.configure_write_restrictions>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.configure_write_restrictions
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ALLOWED_WRITE_DIRS <agentic_fabric.tools.file_tools.ALLOWED_WRITE_DIRS>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ALLOWED_WRITE_DIRS
          :parser: myst
          :summary:
   * - :py:obj:`ALLOWED_EXTENSIONS <agentic_fabric.tools.file_tools.ALLOWED_EXTENSIONS>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ALLOWED_EXTENSIONS
          :parser: myst
          :summary:
   * - :py:obj:`WriteFileInput <agentic_fabric.tools.file_tools.WriteFileInput>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.WriteFileInput
          :parser: myst
          :summary:
   * - :py:obj:`ReadFileInput <agentic_fabric.tools.file_tools.ReadFileInput>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ReadFileInput
          :parser: myst
          :summary:
   * - :py:obj:`ListDirInput <agentic_fabric.tools.file_tools.ListDirInput>`
     - .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ListDirInput
          :parser: myst
          :summary:

API
~~~

.. py:function:: get_workspace_root(package_name: str | None = None) -> pathlib.Path
   :canonical: agentic_fabric.tools.file_tools.get_workspace_root

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.get_workspace_root
      :parser: myst

.. py:data:: ALLOWED_WRITE_DIRS
   :canonical: agentic_fabric.tools.file_tools.ALLOWED_WRITE_DIRS
   :type: list[str]
   :value: 'list(...)'

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ALLOWED_WRITE_DIRS
      :parser: myst

.. py:data:: ALLOWED_EXTENSIONS
   :canonical: agentic_fabric.tools.file_tools.ALLOWED_EXTENSIONS
   :type: set[str]
   :value: 'set(...)'

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ALLOWED_EXTENSIONS
      :parser: myst

.. py:function:: configure_write_restrictions(allowed_dirs: list[str] | None = None, allowed_extensions: set[str] | None = None) -> None
   :canonical: agentic_fabric.tools.file_tools.configure_write_restrictions

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.configure_write_restrictions
      :parser: myst

.. py:data:: WriteFileInput
   :canonical: agentic_fabric.tools.file_tools.WriteFileInput
   :value: '_build_pydantic_schema(...)'

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.WriteFileInput
      :parser: myst

.. py:class:: GameCodeWriterTool
   :canonical: agentic_fabric.tools.file_tools.GameCodeWriterTool

   Bases: :py:obj:`crewai.tools.BaseTool`

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeWriterTool
      :parser: myst

   .. py:attribute:: name
      :canonical: agentic_fabric.tools.file_tools.GameCodeWriterTool.name
      :type: str
      :value: 'Write Game Code File'

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeWriterTool.name
         :parser: myst

   .. py:attribute:: description
      :canonical: agentic_fabric.tools.file_tools.GameCodeWriterTool.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeWriterTool.description
         :parser: myst

   .. py:attribute:: args_schema
      :canonical: agentic_fabric.tools.file_tools.GameCodeWriterTool.args_schema
      :type: typing.Any
      :value: None

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeWriterTool.args_schema
         :parser: myst

.. py:data:: ReadFileInput
   :canonical: agentic_fabric.tools.file_tools.ReadFileInput
   :value: '_build_pydantic_schema(...)'

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ReadFileInput
      :parser: myst

.. py:class:: GameCodeReaderTool
   :canonical: agentic_fabric.tools.file_tools.GameCodeReaderTool

   Bases: :py:obj:`crewai.tools.BaseTool`

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeReaderTool
      :parser: myst

   .. py:attribute:: name
      :canonical: agentic_fabric.tools.file_tools.GameCodeReaderTool.name
      :type: str
      :value: 'Read Game Code File'

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeReaderTool.name
         :parser: myst

   .. py:attribute:: description
      :canonical: agentic_fabric.tools.file_tools.GameCodeReaderTool.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeReaderTool.description
         :parser: myst

   .. py:attribute:: args_schema
      :canonical: agentic_fabric.tools.file_tools.GameCodeReaderTool.args_schema
      :type: typing.Any
      :value: None

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.GameCodeReaderTool.args_schema
         :parser: myst

.. py:data:: ListDirInput
   :canonical: agentic_fabric.tools.file_tools.ListDirInput
   :value: '_build_pydantic_schema(...)'

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.ListDirInput
      :parser: myst

.. py:class:: DirectoryListTool
   :canonical: agentic_fabric.tools.file_tools.DirectoryListTool

   Bases: :py:obj:`crewai.tools.BaseTool`

   .. autodoc2-docstring:: agentic_fabric.tools.file_tools.DirectoryListTool
      :parser: myst

   .. py:attribute:: name
      :canonical: agentic_fabric.tools.file_tools.DirectoryListTool.name
      :type: str
      :value: 'List Directory Contents'

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.DirectoryListTool.name
         :parser: myst

   .. py:attribute:: description
      :canonical: agentic_fabric.tools.file_tools.DirectoryListTool.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.DirectoryListTool.description
         :parser: myst

   .. py:attribute:: args_schema
      :canonical: agentic_fabric.tools.file_tools.DirectoryListTool.args_schema
      :type: typing.Any
      :value: None

      .. autodoc2-docstring:: agentic_fabric.tools.file_tools.DirectoryListTool.args_schema
         :parser: myst