orionis.storage.paths

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 path function name.
Function	`normalize_file_path`	Normalize a storage path and require it to reference a file.
Function	`normalize_path`	Normalize a storage path into a canonical root-relative form.
Constant	`_LEGACY_EXPORTS`	Undocumented

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

Resolve and cache a legacy path function name.

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

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

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

def normalize_file_path(path: str) -> str: (source) ¶

Normalize a storage path and require it to reference a file.

Apply normalize_path and additionally reject the empty result, since the disk root can never be treated as a file.

Parameters
path:`str`	Raw storage path as supplied by the caller.

Returns
`str`	Canonical, non-empty relative path using `/` as separator.

Raises
`StoragePathException`	If the path is invalid or resolves to the disk root.

def normalize_path(path: str) -> str: (source) ¶

Normalize a storage path into a canonical root-relative form.

Converts backslashes to forward slashes, removes empty and . segments, resolves .. segments logically, and rejects any path that would escape the disk root or contains forbidden characters. The returned path never has a leading or trailing slash; the empty string represents the disk root.

Parameters
path:`str`	Raw storage path as supplied by the caller.

Returns
`str`	Canonical relative path using `/` as separator, or an empty string when the path resolves to the disk root.

Raises
`StoragePathException`	If the path contains a null byte, a `:` character, or a `..` sequence that escapes the disk root.

_LEGACY_EXPORTS = (source) ¶

Undocumented

Value

{'normalizePath': normalize_path, 'normalizeFilePath': normalize_file_path}