orionis.storage.contracts.IStorageManager

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 IStorageManager(ABC): (source)

Known subclasses: orionis.storage.StorageManager

View In Hierarchy

Define the contract for the storage manager.

The manager resolves the filesystems configuration, builds ~orionis.storage.contracts.disk.IDisk objects on demand, caches them, and exposes extension points for custom drivers. It never performs file operations itself.

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

@abstractmethod

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

overridden in orionis.storage.StorageManager

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.

@abstractmethod

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

overridden in orionis.storage.StorageManager

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.

@abstractmethod

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

overridden in orionis.storage.StorageManager

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.

Returns
`None`	Undocumented

@abstractmethod

def uploaded(self, source: IHttpUploadedFile) -> IUploadedFile: (source) ¶

overridden in orionis.storage.StorageManager

Wrap an HTTP multipart payload as a storable uploaded file.

Parameters
source:`IHttpUploadedFile`	Buffered multipart payload produced by the HTTP layer.

Returns
`IUploadedFile`	Uploaded file bound to this manager for disk resolution.

__slots__: tuple = (source) ¶

overridden in orionis.storage.StorageManager

Undocumented