:py:mod:`vendor_fabric.secrets_sync.files`
==========================================

.. py:module:: vendor_fabric.secrets_sync.files

.. autodoc2-docstring:: vendor_fabric.secrets_sync.files
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`FileSyncResult <vendor_fabric.secrets_sync.files.FileSyncResult>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult
          :parser: myst
          :summary:
   * - :py:obj:`LocalFileStore <vendor_fabric.secrets_sync.files.LocalFileStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.LocalFileStore
          :parser: myst
          :summary:
   * - :py:obj:`S3FileStore <vendor_fabric.secrets_sync.files.S3FileStore>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.S3FileStore
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`sync_mapping_to_file <vendor_fabric.secrets_sync.files.sync_mapping_to_file>`
     - .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.sync_mapping_to_file
          :parser: myst
          :summary:

API
~~~

.. py:class:: FileSyncResult
   :canonical: vendor_fabric.secrets_sync.files.FileSyncResult

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult
      :parser: myst

   .. py:attribute:: source
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.source
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.source
         :parser: myst

   .. py:attribute:: destination
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.destination
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.destination
         :parser: myst

   .. py:attribute:: changed
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.changed
      :type: bool
      :value: None

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.changed
         :parser: myst

   .. py:attribute:: dry_run
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.dry_run
      :type: bool
      :value: False

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.dry_run
         :parser: myst

   .. py:attribute:: bytes_written
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.bytes_written
      :type: int
      :value: 0

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.bytes_written
         :parser: myst

   .. py:attribute:: error_message
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.error_message
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.error_message
         :parser: myst

   .. py:method:: to_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.secrets_sync.files.FileSyncResult.to_dict

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.FileSyncResult.to_dict
         :parser: myst

.. py:class:: LocalFileStore
   :canonical: vendor_fabric.secrets_sync.files.LocalFileStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.LocalFileStore
      :parser: myst

   .. py:method:: read(path: str | pathlib.Path, *, suffix: str | None = None) -> extended_data.io.DataFile
      :canonical: vendor_fabric.secrets_sync.files.LocalFileStore.read

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.LocalFileStore.read
         :parser: myst

   .. py:method:: write(path: str | pathlib.Path, data: typing.Any, *, encoding: str | None = None, dry_run: bool = False) -> vendor_fabric.secrets_sync.files.FileSyncResult
      :canonical: vendor_fabric.secrets_sync.files.LocalFileStore.write

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.LocalFileStore.write
         :parser: myst

.. py:class:: S3FileStore(connector: vendor_fabric.aws.AWSConnector | None = None, *, execution_role_arn: str | None = None)
   :canonical: vendor_fabric.secrets_sync.files.S3FileStore

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.S3FileStore
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.S3FileStore.__init__
      :parser: myst

   .. py:method:: read(bucket: str, key: str, *, suffix: str | None = None) -> extended_data.io.DataFile
      :canonical: vendor_fabric.secrets_sync.files.S3FileStore.read

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.S3FileStore.read
         :parser: myst

   .. py:method:: write(bucket: str, key: str, data: typing.Any, *, encoding: str | None = None, dry_run: bool = False) -> vendor_fabric.secrets_sync.files.FileSyncResult
      :canonical: vendor_fabric.secrets_sync.files.S3FileStore.write

      .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.S3FileStore.write
         :parser: myst

.. py:function:: sync_mapping_to_file(data: collections.abc.Mapping[str, typing.Any], destination: str | pathlib.Path, *, encoding: str | None = 'json', dry_run: bool = False) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.secrets_sync.files.sync_mapping_to_file

   .. autodoc2-docstring:: vendor_fabric.secrets_sync.files.sync_mapping_to_file
      :parser: myst