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.
Configure connection admission, inbound messages and browser origins.
Read environment defaults when each instance is created. Explicit constructor values take precedence. Copy list inputs to a tuple, lowercase each origin and remove trailing slashes before retaining the immutable configuration.
| Method | __post |
Validate limits and copy the configured origin collection. |
| Instance Variable | allow |
Additional allowed browser origins. Empty allows the same origin only. The wildcard "*" explicitly allows every origin. Defaults to an empty tuple from the shared CORS_ALLOW_ORIGINS environment variable. |
| Instance Variable | max |
Maximum active connections per kernel. Defaults to 128 from WEBSOCKET_MAX_CONNECTIONS. |
| Instance Variable | max |
Maximum complete inbound message bytes. Defaults to 1 MiB from WEBSOCKET_MAX_MESSAGE_SIZE. |
Inherited from BaseEntity:
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | __init__ |
Initialize declared fields and public extra attributes. |
| Method | _dynamic |
Return public instance attributes that are not declared fields. |
| Method | _validate |
Validate names and storage for public extra attributes. |
| Method | get |
Describe declared fields and, optionally, dynamic attributes. |
| Method | to |
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 |
Cache declared fields and normalized type names for each concrete class. |
Validate limits and copy the configured origin collection.
| Returns | |
None | Freeze the validated configuration. |
| Raises | |
TypeError | If limits or origin entries have invalid types. |
ValueError | If a limit is nonpositive or an origin is empty. |
Additional allowed browser origins. Empty allows the same origin only. The wildcard "*" explicitly allows every origin. Defaults to an empty tuple from the shared CORS_ALLOW_ORIGINS environment variable.