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 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_init__ Validate limits and copy the configured origin collection.
Instance Variable allow_origins 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_connections Maximum active connections per kernel. Defaults to 128 from WEBSOCKET_MAX_CONNECTIONS.
Instance Variable max_message_size Maximum complete inbound message bytes. Defaults to 1 MiB from WEBSOCKET_MAX_MESSAGE_SIZE.

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 limits and copy the configured origin collection.

Returns
NoneFreeze the validated configuration.
Raises
TypeErrorIf limits or origin entries have invalid types.
ValueErrorIf a limit is nonpositive or an origin is empty.
allow_origins: tuple[str, ...] = (source)

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.

max_connections: int = (source)

Maximum active connections per kernel. Defaults to 128 from WEBSOCKET_MAX_CONNECTIONS.

max_message_size: int = (source)

Maximum complete inbound message bytes. Defaults to 1 MiB from WEBSOCKET_MAX_MESSAGE_SIZE.