zyra.connectors package

Subpackages

• zyra.connectors.discovery package
  • Submodules
  • Module contents

Module contents

Connectors package: ingest and egress submodules and shared backends.

Primary usage favors functional backends under zyra.connectors.backends. For flows that benefit from a light OO wrapper (e.g., persisting bucket/host config), thin connector classes are available in zyra.connectors.clients.

class zyra.connectors.ByteRanged(*args, **kwargs)

Bases: Protocol

download_byteranges(*args: Any, **kwargs: Any) → bytes

class zyra.connectors.Connector

Bases: object

Minimal abstract base for connector wrappers.

Provides only introspection helpers and context manager convenience. It does not impose a lifecycle or specific methods on subclasses. Concrete wrapper classes are free to delegate to functional backends.

property capabilities: set[str]

class zyra.connectors.Deletable(*args, **kwargs)

Bases: Protocol

delete(*args: Any, **kwargs: Any) → bool

class zyra.connectors.Existsable(*args, **kwargs)

Bases: Protocol

exists(*args: Any, **kwargs: Any) → bool

class zyra.connectors.FTPConnector(host: str, port: int = 21, username: str = 'anonymous', password: str = 'test@test.com', timeout: int = 30)

Bases: Connector

Thin OO wrapper around the FTP backend for convenience.

Stores host/credentials and exposes methods that accept path-only inputs. All methods delegate to functional backends.

CAPABILITIES = {'fetch', 'list', 'upload'}

delete(path: str) → bool

Delete a remote path on this FTP host.

exists(path: str) → bool

Return True if the path exists on this FTP host.

fetch_bytes(path: str) → bytes

Fetch a remote file from this FTP host as bytes.

list_files(remote_dir: str, pattern: str | None = None, *, since: str | None = None, until: str | None = None, date_format: str | None = None) → list[str] | None

List files under a remote directory with optional filters.

stat(path: str)

Return minimal metadata mapping for a remote path.

sync_directory(remote_dir: str, local_dir: str, *, pattern: str | None = None, since: str | None = None, until: str | None = None, date_format: str | None = None, sync_options: SyncOptions | None = None) → None

Mirror a remote directory on this FTP host to a local directory.

Args:

remote_dir: Remote FTP directory path. local_dir: Local directory to sync files to. pattern: Optional regex pattern to filter filenames. since: ISO date string for start of date range filter. until: ISO date string for end of date range filter. date_format: Custom date format for parsing dates in filenames. sync_options: Configuration for file replacement behavior.

upload_bytes(data: bytes, path: str) → bool

Upload bytes to a remote path on this FTP host.

class zyra.connectors.Fetchable(*args, **kwargs)

Bases: Protocol

fetch_bytes(*args: Any, **kwargs: Any) → bytes

class zyra.connectors.Indexable(*args, **kwargs)

Bases: Protocol

get_idx_lines(*args: Any, **kwargs: Any) → Iterable[str]

class zyra.connectors.Listable(*args, **kwargs)

Bases: Protocol

list_files(*args: Any, **kwargs: Any) → Iterable[str] | None

class zyra.connectors.S3Connector(bucket: str, *, unsigned: bool = False)

Bases: Connector

Thin OO wrapper around the S3 backend for convenience.

Stores bucket configuration and exposes familiar object operations.

CAPABILITIES = {'fetch', 'list', 'upload'}

delete(key: str) → bool

Delete an object from the configured bucket.

download_byteranges(key: str, byte_ranges: Iterable[str], *, max_workers: int = 10) → bytes

Download multiple byte ranges and concatenate them in order.

exists(key: str) → bool

Return True if the object exists in the configured bucket.

fetch_bytes(key: str) → bytes

Fetch object bytes from the configured bucket.

get_idx_lines(key: str) → list[str]

Fetch and parse the GRIB .idx for an object in the bucket.

list_files(prefix: str | None = None, *, pattern: str | None = None, since: str | None = None, until: str | None = None, date_format: str | None = None) → list[str] | None

List keys under an optional prefix with optional filters.

stat(key: str)

Return basic metadata mapping for an object in the bucket.

upload_bytes(data: bytes, key: str) → bool

Upload bytes as an object to the configured bucket.

class zyra.connectors.Statable(*args, **kwargs)

Bases: Protocol

stat(*args: Any, **kwargs: Any) → Any

class zyra.connectors.Uploadable(*args, **kwargs)

Bases: Protocol

upload_bytes(data: bytes, *args: Any, **kwargs: Any) → bool