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 Redis(BaseEntity): (source)
Configure a durable Redis queue connection.
| Parameters | |
| driver | Redis driver identifier. |
| endpoint | Redis host read from REDIS_HOST. |
| port | TCP port read from REDIS_PORT, between 1 and 65535. |
| db | Nonnegative database index read from REDIS_DB. |
| password | Optional authentication password read from REDIS_PASSWORD. |
| prefix | Namespace read from QUEUE_REDIS_PREFIX to isolate persisted jobs. |
| queue | Default logical queue name read from QUEUE_REDIS_QUEUE. |
| retry | Reservation duration read from QUEUE_REDIS_RETRY_AFTER in seconds. |
| Method | __post |
Validate Redis connection fields, namespace, and reservation duration. |
| Class Variable | db |
Undocumented |
| Class Variable | driver |
Undocumented |
| Class Variable | endpoint |
Undocumented |
| Class Variable | password |
Undocumented |
| Class Variable | port |
Undocumented |
| Class Variable | prefix |
Undocumented |
| Class Variable | queue |
Undocumented |
| Class Variable | retry |
Undocumented |
Inherited from BaseEntity:
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | get |
Describe field names, normalized types, defaults, and metadata. |
| Method | to |
Convert the dataclass instance to a recursively copied dictionary. |
| Class Variable | __slots__ |
Undocumented |
Validate Redis connection fields, namespace, and reservation duration.
| Returns | |
None | Keep validated connection settings unchanged. |
| Raises | |
TypeError | If a setting has an invalid type. |
ValueError | If a driver, identifier, numeric range, or duration is invalid. |