ORIONIS API REFERENCE

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.

module documentation

Storage driver backed by the local filesystem.

Function _path_mode Read path metadata while distinguishing absence from an I/O failure.
Function _raise_walk_error Propagate a directory scan error instead of returning a partial listing.
Constant _ALLOWED_MODES Binary modes accepted by open().
Constant _CHUNK_SIZE Default chunk size for streaming operations (64 KiB).
Constant _FILE_MODES POSIX permission bits applied per visibility level.
Constant _STAGING_SUFFIX Identify the reserved sibling suffix used for atomic publication.
def _path_mode(path: Path) -> int | None: (source)

Read path metadata while distinguishing absence from an I/O failure.

Parameters
path:pathlib.PathFilesystem path whose object type is required.
Returns
int | NoneNative mode bits, or None when the path or a parent is absent.
Raises
OSErrorIf metadata cannot be read for a reason other than absence.
def _raise_walk_error(error: OSError) -> NoReturn: (source)

Propagate a directory scan error instead of returning a partial listing.

Parameters
error:OSErrorOriginal error raised while traversing the selected directory.
Returns
typing.NoReturnNever return; propagate the original scan failure.
Raises
OSErrorAlways propagate the supplied error.
_ALLOWED_MODES: frozenset[str] = (source)

Binary modes accepted by open().

Value
frozenset(set(['rb', 'wb', 'ab', 'rb+', 'wb+', 'ab+']))
_CHUNK_SIZE: int = (source)

Default chunk size for streaming operations (64 KiB).

Value
64 * 1024
_FILE_MODES: dict[str, int] = (source)

POSIX permission bits applied per visibility level.

Value
{Visibility.PUBLIC.value: 420, Visibility.PRIVATE.value: 384}
_STAGING_SUFFIX = (source)

Identify the reserved sibling suffix used for atomic publication.

Value
re.compile(r'\.[0-9a-f]{16}\.tmp\Z')