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.

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.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__ Declare that this class introduces no additional instance slots.
@abstractmethod
def default(self) -> IDisk: (source)

Resolve the default disk from the configuration.

Returns
orionis.storage.contracts.IDiskThe disk configured as default.
Raises
orionis.storage.exceptions.DiskNotFoundExceptionIf the default disk is not declared in the configuration.
@abstractmethod
def disk(self, name: str | None = None) -> IDisk: (source)

Resolve the disk registered under name.

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

Parameters
name:str | NoneDisk name as declared in the filesystems configuration, or None for the default disk.
Returns
orionis.storage.contracts.IDiskDisk bound to its configured driver.
Raises
orionis.storage.exceptions.DiskNotFoundExceptionIf the disk is not declared in the configuration.
orionis.storage.exceptions.DriverNotSupportedExceptionIf the disk references a driver with no implementation.
@abstractmethod
def extend(self, driver: str, factory: Callable[[object], IStorageDriver]): (source)

Register a custom driver factory under driver.

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:strDriver name as referenced by disk configurations.
factory:typing.Callable[[object], IStorageDriver]Callable building the driver from a disk configuration.
Returns
NoneNo return value.
@abstractmethod
def uploaded(self, source: IHttpUploadedFile) -> IUploadedFile: (source)

Wrap an HTTP multipart payload as a storable uploaded file.

Parameters
source:orionis.http.payload.contracts.uploaded_file.IUploadedFileBuffered multipart payload produced by the HTTP layer.
Returns
orionis.storage.contracts.IUploadedFileUploaded file bound to this manager for disk resolution.
__slots__: tuple = (source)

Declare that this class introduces no additional instance slots.