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

Represent a local filesystem configuration.

Returns
NoneThis class does not return a value.
Method __post_init__ Validate and initialize the Public entity.
Instance Variable driver The filesystem driver name resolved by StorageManager.
Instance Variable path The absolute or relative path where public files are stored.
Instance Variable url The URL where the public files can be accessed.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate and initialize the Public entity.

Ensures that 'path' and 'url' are non-empty strings of type str.

Parameters
self:orionis.foundation.config.filesystems.PublicThe instance of the Public class.
Returns
NoneThis method does not return a value.
Raises
TypeErrorIf 'path' or 'url' is not of type str.
ValueErrorIf 'path' or 'url' is an empty string.
driver: str, default "local" = (source)

The filesystem driver name resolved by StorageManager.

The absolute or relative path where public files are stored.

The URL where the public files can be accessed.