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.

Explore modules View classes

orionis.foundation.config.http.HTTP

class documentation

class HTTP(BaseEntity): (source)

View In Hierarchy

Configure HTTP request handling and security.

Parameters
monitor_disconnectsCancel 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().
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 Undocumented
Class Variable cors Undocumented
Class Variable csrf Undocumented
Class Variable monitor_disconnects Undocumented
Class Variable proxies Undocumented
Class Variable rate_limit Undocumented
Class Variable security Undocumented
Class Variable websocket Undocumented

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
def __post_init__(self): (source)
overrides orionis.support.entities.BaseEntity.__post_init__

Validate and coerce all composite fields.

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

Returns
NoneUndocumented
Raises
TypeErrorIf any field has an unexpected type.
def __validateCors(self): (source)

Validate the cors field.

Coerce a dict to Cors if needed.

Returns
NoneUndocumented
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
NoneUndocumented
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
NoneUndocumented
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
NoneUndocumented
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
NoneUndocumented
Raises
TypeErrorIf the value is not an HTTPSecurity or dict.
body_limits: HTTPBodyLimits | dict = (source)

Undocumented

cors: Cors | dict = (source)

Undocumented

csrf: HTTPCsrf | dict = (source)

Undocumented

monitor_disconnects: bool, optional = (source)

Undocumented

proxies: HTTPProxies | dict = (source)

Undocumented

rate_limit: HTTPRateLimit | dict = (source)

Undocumented

security: HTTPSecurity | dict = (source)

Undocumented

websocket: HTTPWebSocket | dict = (source)

Undocumented