vendor_fabric.secrets_sync.files

File syncing capabilities built on Extended Data file workflows.

Module Contents

Classes

FileSyncResult	File sync operation result.
LocalFileStore	Local file store using Extended Data decoding and export.
S3FileStore	S3 file store using the AWS connector.

Functions

sync_mapping_to_file

Sync a mapping to a local file through Extended Data export rules.

API

class vendor_fabric.secrets_sync.files.FileSyncResult

File sync operation result.

source: str = None

destination: str = None

changed: bool = None

dry_run: bool = False

bytes_written: int = 0

error_message: str = <Multiline-String>

to_dict() → extended_data.containers.ExtendedDict

Return an Extended Data payload.

class vendor_fabric.secrets_sync.files.LocalFileStore

Local file store using Extended Data decoding and export.

read(path: str | pathlib.Path, *, suffix: str | None = None) → extended_data.io.DataFile

Read a local file.

write(path: str | pathlib.Path, data: Any, *, encoding: str | None = None, dry_run: bool = False) → vendor_fabric.secrets_sync.files.FileSyncResult

Write a local file.

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

S3 file store using the AWS connector.

Initialization

read(bucket: str, key: str, *, suffix: str | None = None) → extended_data.io.DataFile

Read an object from S3 into a DataFile.

write(bucket: str, key: str, data: Any, *, encoding: str | None = None, dry_run: bool = False) → vendor_fabric.secrets_sync.files.FileSyncResult

Write data to S3.

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

Sync a mapping to a local file through Extended Data export rules.