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

Represent the configuration for trusted HTTP proxies.

Method __post_init__ Validate proxy fields.
Method __validateTrustedProxies Validate the trusted_proxies field.
Instance Variable trusted_proxies List of trusted proxy IP addresses or CIDR ranges.

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 proxy fields.

Returns
NoneValidate proxy fields.
Raises
TypeErrorIf any field has an unexpected type.
def __validateTrustedProxies(self): (source)

Validate the trusted_proxies field.

Coerce the list to ensure all elements are strings.

Returns
NoneValidate the trusted_proxies field.
Raises
TypeErrorIf the value is not a list of strings.
trusted_proxies: list[str] = (source)

List of trusted proxy IP addresses or CIDR ranges.