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 password hashing configuration for the application.

Method __post_init__ Validate and normalize the hashing configuration after initialization.
Instance Variable argon2 Cost parameters applied by the Argon2id driver.
Instance Variable bcrypt Cost parameters applied by the bcrypt driver.
Instance Variable driver Default hashing driver. Accepts a Drivers enum member or a plain string ('argon2' or 'bcrypt'). Resolved from the HASH_DRIVER environment variable or Drivers.ARGON2.value.

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 normalize the hashing configuration after initialization.

Returns
NoneModifies instance attributes in place via object.__setattr__.
Raises
TypeErrorIf driver is not a Drivers enum or str, or if the driver options are neither entities nor dictionaries.
ValueErrorIf driver is a string that does not match any valid driver.
argon2: orionis.foundation.config.hashing.Argon2 | dict = (source)

Cost parameters applied by the Argon2id driver.

bcrypt: orionis.foundation.config.hashing.Bcrypt | dict = (source)

Cost parameters applied by the bcrypt driver.

driver: orionis.foundation.config.hashing.Drivers | str = (source)

Default hashing driver. Accepts a Drivers enum member or a plain string ('argon2' or 'bcrypt'). Resolved from the HASH_DRIVER environment variable or Drivers.ARGON2.value.