:py:mod:`philh_myftp_biz.file`
==============================

.. py:module:: philh_myftp_biz.file

.. autodoc2-docstring:: philh_myftp_biz.file
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`_Template <philh_myftp_biz.file._Template>`
     - .. autodoc2-docstring:: philh_myftp_biz.file._Template
          :summary:
   * - :py:obj:`XML <philh_myftp_biz.file.XML>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.XML
          :summary:
   * - :py:obj:`PKL <philh_myftp_biz.file.PKL>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.PKL
          :summary:
   * - :py:obj:`VHDX <philh_myftp_biz.file.VHDX>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.VHDX
          :summary:
   * - :py:obj:`JSON <philh_myftp_biz.file.JSON>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.JSON
          :summary:
   * - :py:obj:`INI <philh_myftp_biz.file.INI>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.INI
          :summary:
   * - :py:obj:`YAML <philh_myftp_biz.file.YAML>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.YAML
          :summary:
   * - :py:obj:`TXT <philh_myftp_biz.file.TXT>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.TXT
          :summary:
   * - :py:obj:`ZIP <philh_myftp_biz.file.ZIP>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.ZIP
          :summary:
   * - :py:obj:`CSV <philh_myftp_biz.file.CSV>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.CSV
          :summary:
   * - :py:obj:`TOML <philh_myftp_biz.file.TOML>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.TOML
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`temp <philh_myftp_biz.file.temp>`
     - .. autodoc2-docstring:: philh_myftp_biz.file.temp
          :summary:

API
~~~

.. py:function:: temp(name: str = 'undefined', ext: str = 'ph', id: typing.Any = None) -> philh_myftp_biz.pc.Path
   :canonical: philh_myftp_biz.file.temp

   .. autodoc2-docstring:: philh_myftp_biz.file.temp

.. py:class:: _Template(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file._Template

   .. autodoc2-docstring:: philh_myftp_biz.file._Template

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file._Template.__init__

   .. py:attribute:: parsed
      :canonical: philh_myftp_biz.file._Template.parsed
      :type: typing.Any
      :value: None

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.parsed

   .. py:attribute:: _read
      :canonical: philh_myftp_biz.file._Template._read
      :value: None

      .. autodoc2-docstring:: philh_myftp_biz.file._Template._read

   .. py:attribute:: _save
      :canonical: philh_myftp_biz.file._Template._save
      :value: None

      .. autodoc2-docstring:: philh_myftp_biz.file._Template._save

   .. py:method:: read()
      :canonical: philh_myftp_biz.file._Template.read

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.read

   .. py:method:: save(data: typing.Any)
      :canonical: philh_myftp_biz.file._Template.save

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.save

   .. py:property:: raw
      :canonical: philh_myftp_biz.file._Template.raw
      :type: bytes

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.raw

   .. py:method:: Dict()
      :canonical: philh_myftp_biz.file._Template.Dict

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.Dict

   .. py:method:: List()
      :canonical: philh_myftp_biz.file._Template.List

      .. autodoc2-docstring:: philh_myftp_biz.file._Template.List

.. py:class:: XML(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.XML

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.XML

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.XML.__init__

   .. py:method:: _read() -> dict
      :canonical: philh_myftp_biz.file.XML._read

      .. autodoc2-docstring:: philh_myftp_biz.file.XML._read

   .. py:method:: _save(data: dict) -> None
      :canonical: philh_myftp_biz.file.XML._save

      .. autodoc2-docstring:: philh_myftp_biz.file.XML._save

.. py:class:: PKL(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.PKL

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.PKL

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.PKL.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.PKL._read

      .. autodoc2-docstring:: philh_myftp_biz.file.PKL._read

   .. py:method:: _save(value: typing.Any) -> None
      :canonical: philh_myftp_biz.file.PKL._save

      .. autodoc2-docstring:: philh_myftp_biz.file.PKL._save

.. py:class:: VHDX(VHD: philh_myftp_biz.pc.Path, MNT: philh_myftp_biz.pc.Path, timeout: int = 30, readonly: bool = False)
   :canonical: philh_myftp_biz.file.VHDX

   .. autodoc2-docstring:: philh_myftp_biz.file.VHDX

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.VHDX.__init__

   .. py:method:: mount() -> None
      :canonical: philh_myftp_biz.file.VHDX.mount

      .. autodoc2-docstring:: philh_myftp_biz.file.VHDX.mount

   .. py:method:: dismount() -> None
      :canonical: philh_myftp_biz.file.VHDX.dismount

      .. autodoc2-docstring:: philh_myftp_biz.file.VHDX.dismount

.. py:class:: JSON(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.JSON

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.JSON

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.JSON.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.JSON._read

      .. autodoc2-docstring:: philh_myftp_biz.file.JSON._read

   .. py:method:: _save(data: dict) -> None
      :canonical: philh_myftp_biz.file.JSON._save

      .. autodoc2-docstring:: philh_myftp_biz.file.JSON._save

.. py:class:: INI(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.INI

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.INI

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.INI.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.INI._read

      .. autodoc2-docstring:: philh_myftp_biz.file.INI._read

   .. py:method:: _save(data: dict) -> None
      :canonical: philh_myftp_biz.file.INI._save

      .. autodoc2-docstring:: philh_myftp_biz.file.INI._save

.. py:class:: YAML(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.YAML

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.YAML

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.YAML.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.YAML._read

      .. autodoc2-docstring:: philh_myftp_biz.file.YAML._read

   .. py:method:: _save(data: dict) -> None
      :canonical: philh_myftp_biz.file.YAML._save

      .. autodoc2-docstring:: philh_myftp_biz.file.YAML._save

.. py:class:: TXT(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.TXT

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.TXT

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.TXT.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.TXT._read

      .. autodoc2-docstring:: philh_myftp_biz.file.TXT._read

   .. py:method:: _save(data: str) -> None
      :canonical: philh_myftp_biz.file.TXT._save

      .. autodoc2-docstring:: philh_myftp_biz.file.TXT._save

.. py:class:: ZIP
   :canonical: philh_myftp_biz.file.ZIP

   .. autodoc2-docstring:: philh_myftp_biz.file.ZIP

   .. py:attribute:: path
      :canonical: philh_myftp_biz.file.ZIP.path
      :type: philh_myftp_biz.pc.Path
      :value: None

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.path

   .. py:class:: Member
      :canonical: philh_myftp_biz.file.ZIP.Member

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.Member

      .. py:attribute:: _zip
         :canonical: philh_myftp_biz.file.ZIP.Member._zip
         :type: zipfile.ZipFile
         :value: None

         .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.Member._zip

      .. py:attribute:: path
         :canonical: philh_myftp_biz.file.ZIP.Member.path
         :type: str
         :value: None

         .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.Member.path

      .. py:method:: open()
         :canonical: philh_myftp_biz.file.ZIP.Member.open

         .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.Member.open

   .. py:method:: _zip() -> zipfile.ZipFile
      :canonical: philh_myftp_biz.file.ZIP._zip

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP._zip

   .. py:property:: members
      :canonical: philh_myftp_biz.file.ZIP.members
      :type: list[Member]

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.members

   .. py:method:: search(term: str) -> list[Member]
      :canonical: philh_myftp_biz.file.ZIP.search

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.search

   .. py:method:: extractFile(member: Member, path: philh_myftp_biz.pc.Path) -> None
      :canonical: philh_myftp_biz.file.ZIP.extractFile

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.extractFile

   .. py:method:: extractAll(path: philh_myftp_biz.pc.Path) -> None
      :canonical: philh_myftp_biz.file.ZIP.extractAll

      .. autodoc2-docstring:: philh_myftp_biz.file.ZIP.extractAll

.. py:class:: CSV(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.CSV

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.CSV

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.CSV.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.CSV._read

      .. autodoc2-docstring:: philh_myftp_biz.file.CSV._read

   .. py:method:: _save(data: list[list]) -> None
      :canonical: philh_myftp_biz.file.CSV._save

      .. autodoc2-docstring:: philh_myftp_biz.file.CSV._save

.. py:class:: TOML(path: philh_myftp_biz.pc.Path, default: typing.Any = None)
   :canonical: philh_myftp_biz.file.TOML

   Bases: :py:obj:`philh_myftp_biz.file._Template`

   .. autodoc2-docstring:: philh_myftp_biz.file.TOML

   .. rubric:: Initialization

   .. autodoc2-docstring:: philh_myftp_biz.file.TOML.__init__

   .. py:method:: _read()
      :canonical: philh_myftp_biz.file.TOML._read

      .. autodoc2-docstring:: philh_myftp_biz.file.TOML._read

   .. py:method:: _save(data: dict) -> None
      :canonical: philh_myftp_biz.file.TOML._save

      .. autodoc2-docstring:: philh_myftp_biz.file.TOML._save