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 the configuration entity for a Memcached cache store.

Method __post_init__ Validate the Memcached configuration after initialization.
Method __validateDriver Validate the driver property.
Method __validateEndpoint Validate the endpoint property.
Method __validatePort Validate the port property.
Instance Variable driver The driver type. Defaults to 'memcached'.
Instance Variable endpoint Memcached host address. Resolved from the MEMCACHED_HOST environment variable or defaults to '127.0.0.1'.
Instance Variable port Memcached port number. Resolved from the MEMCACHED_PORT environment variable or defaults to 11211.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
def __post_init__(self): (source)

Validate the Memcached configuration after initialization.

Returns
NoneValidates every field against its declared type hint.
Raises
TypeErrorIf any property does not match its expected type.
ValueErrorIf any property fails its value validation.
def __validateDriver(self): (source)

Validate the driver property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf driver is not a string.
ValueErrorIf driver is an empty string.
def __validateEndpoint(self): (source)

Validate the endpoint property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf endpoint is neither a string nor None.
def __validatePort(self): (source)

Validate the port property.

Returns
NoneThis method performs validation and returns None.
Raises
TypeErrorIf port is not an integer.
ValueErrorIf port is not between 1 and 65535.

The driver type. Defaults to 'memcached'.

endpoint: str | None = (source)

Memcached host address. Resolved from the MEMCACHED_HOST environment variable or defaults to '127.0.0.1'.

Memcached port number. Resolved from the MEMCACHED_PORT environment variable or defaults to 11211.