orionis.storage.StorageManager

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

class documentation

class StorageManager(IStorageManager): (source)

Constructor: StorageManager(app)

View In Hierarchy

Coordinate disk resolution for the storage component.

The manager reads the filesystems configuration, builds ~orionis.storage.disk.Disk objects bound to their drivers, and caches them per name. It knows nothing about files or directories: that behavior lives in the domain objects returned by each disk.

Method	`__buildDriver`	Instantiate the driver for the disk named name.
Method	`__buildLocalDriver`	Build a local driver from a disk configuration entity.
Method	`__diskConfig`	Return the configuration entity for the disk named name.
Method	`__init__`	Initialize the manager and resolve the active configuration.
Method	`default`	Resolve the default disk from the configuration.
Method	`disk`	Resolve the disk registered under name.
Method	`extend`	Register a custom driver factory under driver.
Method	`uploaded`	Wrap an HTTP multipart payload as a storable uploaded file.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_app`	Undocumented
Instance Variable	`_base_path`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_custom`	Undocumented
Instance Variable	`_default`	Undocumented
Instance Variable	`_disks`	Undocumented

def __buildDriver(self, name: str) -> IStorageDriver: (source) ¶

Instantiate the driver for the disk named name.

Parameters
name:`str`	Disk name as declared in the filesystems configuration.

Returns
`IStorageDriver`	Configured driver instance.

Raises
`DiskNotFoundException`	If the disk is not declared in the configuration.
`DriverNotSupportedException`	If the disk references a driver with no implementation.

def __buildLocalDriver(self, config: object) -> IStorageDriver: (source) ¶

Build a local driver from a disk configuration entity.

Parameters
config:`object`	Disk configuration entity exposing `path` and, optionally, `url`.

Returns
`IStorageDriver`	Local driver rooted inside the application base path.

def __diskConfig(self, name: str) -> object: (source) ¶

Return the configuration entity for the disk named name.

Parameters
name:`str`	Disk name as declared in the filesystems configuration.

Returns
`object`	Disk configuration entity.

Raises
`DiskNotFoundException`	If the disk is not declared in the configuration.

def __init__(self, app: IApplication): (source) ¶

Initialize the manager and resolve the active configuration.

Parameters
app:`IApplication`	Application container used to read the configuration and the base path.

Returns
`None`	Undocumented

def default(self) -> IDisk: (source) ¶

overrides orionis.storage.contracts.IStorageManager.default

Resolve the default disk from the configuration.

Returns
`IDisk`	The disk configured as default.

Raises
`DiskNotFoundException`	If the default disk is not declared in the configuration.

def disk(self, name: str | None = None) -> IDisk: (source) ¶

overrides orionis.storage.contracts.IStorageManager.disk

Resolve the disk registered under name.

The disk is built on first access and cached for reuse.

Parameters
name:`str \| None`	Disk name as declared in the filesystems configuration, or `None` for the default disk.

Returns
`IDisk`	Disk bound to its configured driver.

Raises
`DiskNotFoundException`	If the disk is not declared in the configuration.
`DriverNotSupportedException`	If the disk references a driver with no implementation.

def extend(self, driver: str, factory: Callable[[object], IStorageDriver]): (source) ¶

overrides orionis.storage.contracts.IStorageManager.extend

The factory receives the disk configuration entity and must return a ready-to-use driver instance. Registering a factory clears the disk cache so new resolutions pick it up.

Parameters
driver:`str`	Driver name as referenced by disk configurations.
factory:`Callable[[object], IStorageDriver]`	Callable building the driver from a disk configuration.