orionis.storage.drivers.functions

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

module documentation

(source)

Undocumented

Function	`__getattr__`	Resolve and cache a legacy driver helper name.
Function	`_directory_ancestors`	Yield every directory prefix implied by key down to base.
Function	`assert_binary_mode`	Validate a stream mode against the supported binary modes.
Function	`derive_directories`	Derive the directory paths implied by object keys under base.
Function	`filter_files`	Select the object keys that represent files under base.
Function	`import_driver_dependency`	Import an optional SDK module required by a storage driver.
Function	`resolve_download_target`	Resolve the local target path for a download operation.
Constant	`_ALLOWED_MODES`	Undocumented
Constant	`_LEGACY_EXPORTS`	Undocumented

def __getattr__(name: str) -> object: (source) ¶

Resolve and cache a legacy driver helper name.

Parameters
name:`str`	Attribute requested from this module.

Returns
`object`	Existing helper function bound to the requested name.

Raises
`AttributeError`	If the requested name is not a compatibility export.

def _directory_ancestors(key: str, base: str) -> Iterator[str]: (source) ¶

Yield every directory prefix implied by key down to base.

Markers (keys ending with /) name a directory directly, while file keys imply their parent chain.

Parameters
key:`str`	Object key, relative to the disk root.
base:`str`	Canonical directory path acting as the traversal floor.

Returns
`Iterator[str]`	Undocumented

Yields
`str`	Directory paths between key and base, exclusive.

def assert_binary_mode(mode: str): (source) ¶

Validate a stream mode against the supported binary modes.

Parameters
mode:`str`	Mode requested by the caller.

Returns
`None`	Undocumented

Raises
`UnsupportedStorageOperationException`	If mode is not one of `'rb'`, `'wb'`, `'ab'`, `'rb+'`, `'wb+'`, or `'ab+'`.

def derive_directories(keys: Iterable[str], base: str, *, recursive: bool) -> list[str]: (source) ¶

Derive the directory paths implied by object keys under base.

Object stores have no physical directories: prefixes are inferred from the stored keys, and keys ending with / act as explicit directory markers.

Parameters
keys:`Iterable[str]`	Object keys, relative to the disk root.
base:`str`	Canonical directory path acting as the listing root. The empty string denotes the disk root.
recursive:`bool`	When `True`, include all nested directories.

Returns
`list[str]`	Sorted directory paths under base.

def filter_files(keys: Iterable[str], base: str, *, recursive: bool) -> list[str]: (source) ¶

Select the object keys that represent files under base.

Keys ending with / are treated as directory markers and are always excluded.

Parameters
keys:`Iterable[str]`	Object keys, relative to the disk root.
base:`str`	Canonical directory path acting as the listing root. The empty string denotes the disk root.
recursive:`bool`	When `True`, include files from all nested prefixes.

Returns
`list[str]`	Sorted file keys under base.

def import_driver_dependency(module: str, package: str, extra: str) -> ModuleType: (source) ¶

Import an optional SDK module required by a storage driver.

Cloud drivers rely on the official SDK of each platform, which is not installed with the framework. This helper performs the import lazily and converts a missing package into a descriptive storage exception with installation instructions.

Parameters
module:`str`	Dotted module path to import (e.g. `'boto3'`).
package:`str`	PyPI package that provides the module (e.g. `'boto3'`).
extra:`str`	Orionis extra that pulls the package (e.g. `'s3'`), used to suggest `uv add 'orionis[extra]'`.

Returns
`ModuleType`	The imported module.

Raises
`MissingStorageDependencyException`	If the package is not installed in the active environment.

def resolve_download_target(normalized: str, destination: str | Path) -> Path: (source) ¶

Resolve the local target path for a download operation.

When destination points to an existing directory, the file keeps its original name inside that directory. Missing parent directories are created.

Parameters
normalized:`str`	Canonical root-relative path of the remote file.
destination:`str \| Path`	Local target file or existing directory.

Returns
`Path`	Local path where the file must be written.

_ALLOWED_MODES: frozenset[str] = (source) ¶

Undocumented

Value

frozenset(set(['rb', 'wb', 'ab', 'rb+', 'wb+', 'ab+']))

_LEGACY_EXPORTS = (source) ¶

Undocumented

Value

{'importDriverDependency': import_driver_dependency,
 'assertBinaryMode': assert_binary_mode,
 'resolveDownloadTarget': resolve_download_target,
 'filterFiles': filter_files,
 'deriveDirectories': derive_directories}