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 rate-limiting configuration for HTTP.

Method __post_init__ Validate rate-limiting fields.
Method __validateRateLimiting Validate rate-limiting constraints.
Method __validateStore Validate backend selection, bounded capacity and Redis transport.
Instance Variable rate_limit_enabled Whether global rate limiting is enabled.
Instance Variable rate_limit_max_events Maximum retained accepted timestamps in the memory store.
Instance Variable rate_limit_max_keys Maximum retained clients in the memory store.
Instance Variable rate_limit_redis Redis connection settings, used only by the Redis store.
Instance Variable rate_limit_redis_prefix Application namespace for Redis quota keys.
Instance Variable rate_limit_redis_timeout_seconds Bound Redis connect and socket operations in seconds.
Instance Variable rate_limit_requests Maximum number of requests allowed per window.
Instance Variable rate_limit_store memory for one process or redis for shared worker quotas.
Instance Variable rate_limit_window_seconds Time window in seconds for rate limit counting.

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 rate-limiting fields.

Returns
NoneValidate rate-limiting fields.
Raises
TypeErrorIf any field has an unexpected type.
ValueErrorIf numeric fields are not positive.
def __validateRateLimiting(self): (source)

Validate rate-limiting constraints.

Check rate_limit_enabled, rate_limit_requests, and rate_limit_window_seconds.

Returns
NoneValidate rate-limiting constraints.
Raises
TypeErrorIf any field has an unexpected type.
ValueErrorIf numeric fields are not positive.
def __validateStore(self): (source)

Validate backend selection, bounded capacity and Redis transport.

Returns
NoneReject invalid backend settings during configuration loading.
rate_limit_enabled: bool = (source)

Whether global rate limiting is enabled.

rate_limit_max_events: int = (source)

Maximum retained accepted timestamps in the memory store.

rate_limit_max_keys: int = (source)

Maximum retained clients in the memory store.

rate_limit_redis: orionis.foundation.config.http.Redis | dict = (source)

Redis connection settings, used only by the Redis store.

rate_limit_redis_prefix: str = (source)

Application namespace for Redis quota keys.

rate_limit_redis_timeout_seconds: int = (source)

Bound Redis connect and socket operations in seconds.

rate_limit_requests: int = (source)

Maximum number of requests allowed per window.

rate_limit_store: str = (source)

memory for one process or redis for shared worker quotas.

rate_limit_window_seconds: int = (source)

Time window in seconds for rate limit counting.