orionis.foundation.config.http.HTTPRateLimit

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 HTTPRateLimit(BaseEntity): (source)

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_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_redis_url`	Redis connection URL, used only by the Redis store.
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	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

overrides orionis.support.entities.BaseEntity.__post_init__

Validate rate-limiting fields.

Returns
`None`	Undocumented

Raises
`TypeError`	If any field has an unexpected type.
`ValueError`	If 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
`None`	Undocumented

Raises
`TypeError`	If any field has an unexpected type.
`ValueError`	If numeric fields are not positive.

Validate backend selection, bounded capacity and Redis transport.

Returns
`None`	Reject invalid backend settings during configuration loading.

Whether global rate limiting is enabled.

Maximum retained accepted timestamps in the memory store.

Maximum retained clients in the memory store.

Application namespace for Redis quota keys.

rate_limit_redis_timeout_seconds: int = (source) ¶

Bound Redis connect and socket operations in seconds.

Redis connection URL, used only by the Redis store.

Maximum number of requests allowed per window.

memory for one process or redis for shared worker quotas.

rate_limit_window_seconds: int = (source) ¶

Time window in seconds for rate limit counting.