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 HTTP request handling and security.

Method __post_init__ Validate and coerce all composite fields.
Method __validateCors Validate the cors field.
Method __validateCsrf Validate the csrf field.
Method __validateProxies Validate the proxies field.
Method __validateRateLimit Validate the rate_limit field.
Method __validateSecurity Validate the security field.
Class Variable body_limits Body limits produced by field.
Class Variable cors Cors produced by field.
Class Variable csrf Csrf produced by field.
Class Variable proxies Proxies produced by field.
Class Variable rate_limit Rate limit produced by field.
Class Variable security Security produced by field.
Class Variable websocket Websocket produced by field.
Instance Variable monitor_disconnects Cancel handlers proactively when a client disconnects. Defaults to False, executing handlers in the server task with direct body reads. External server cancellation still propagates in both modes. The application snapshots this setting during create().

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 and coerce all composite fields.

Convert dict values to their corresponding entity instances when provided as plain dicts.

Returns
NoneValidate and coerce all composite fields.
Raises
TypeErrorIf any field has an unexpected type.
def __validateCors(self): (source)

Validate the cors field.

Coerce a dict to Cors if needed.

Returns
NoneValidate the cors field.
Raises
TypeErrorIf the value is not a Cors or dict.
def __validateCsrf(self): (source)

Validate the csrf field.

Coerce a dict to HTTPCsrf if needed.

Returns
NoneValidate the csrf field.
Raises
TypeErrorIf the value is not an HTTPCsrf or dict.
def __validateProxies(self): (source)

Validate the proxies field.

Coerce a dict to HTTPProxies if needed.

Returns
NoneValidate the proxies field.
Raises
TypeErrorIf the value is not an HTTPProxies or dict.
def __validateRateLimit(self): (source)

Validate the rate_limit field.

Coerce a dict to HTTPRateLimit if needed.

Returns
NoneValidate the rate_limit field.
Raises
TypeErrorIf the value is not an HTTPRateLimit or dict.
def __validateSecurity(self): (source)

Validate the security field.

Coerce a dict to HTTPSecurity if needed.

Returns
NoneValidate the security field.
Raises
TypeErrorIf the value is not an HTTPSecurity or dict.

Body limits produced by field.

Cors produced by field.

Csrf produced by field.

Proxies produced by field.

Rate limit produced by field.

Security produced by field.

Websocket produced by field.

monitor_disconnects: bool, optional = (source)

Cancel handlers proactively when a client disconnects. Defaults to False, executing handlers in the server task with direct body reads. External server cancellation still propagates in both modes. The application snapshots this setting during create().