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

Configure the Redis connection used by HTTP rate limiting.

Method __post_init__ Validate connection fields without creating a Redis client.
Instance Variable db Redis database index, read from REDIS_DB.
Instance Variable endpoint Redis host address, read from REDIS_HOST.
Instance Variable password Optional Redis password, read from REDIS_PASSWORD.
Instance Variable port Redis TCP port, read from REDIS_PORT.

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 connection fields without creating a Redis client.

Returns
NoneReject invalid connection settings during configuration loading.
Raises
TypeErrorIf a field has an unexpected type.
ValueErrorIf the endpoint is empty, the port is invalid or the db is negative.

Redis database index, read from REDIS_DB.

endpoint: str = (source)

Redis host address, read from REDIS_HOST.

password: str | None = (source)

Optional Redis password, read from REDIS_PASSWORD.

Redis TCP port, read from REDIS_PORT.