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.

package documentation

Group the auth components and public imports.

Package authorization Group the auth authorization components and public imports.
Package concerns Group the auth concerns components and public imports.
Package context Group the auth context components and public imports.
Package contracts Resolve authentication contracts without creating entity import cycles.
Package entities Group the auth entities components and public imports.
Module exceptions Provide auth operations.
Package guards Group the auth guards components and public imports.
Package identity Group the auth identity components and public imports.
Module manager Expose authentication and authorization to application code.
Package middleware Group the auth middleware components and public imports.
Package passwords Group the auth passwords components and public imports.
Module provider Service provider wiring the authentication module.
Module remember Store expiring token digests and rotate them on persistent login.
Package tokens Group the auth tokens components and public imports.

From __init__.py:

Exception AuthConfigurationException Raise when the authentication configuration is missing or invalid.
Exception AuthenticationException Raise when the current request carries no valid authenticated identity.
Exception AuthException Base exception for every failure raised by the authentication module.
Exception AuthorizationException Raise when an authenticated identity lacks the required authorization.
Exception GuardNotFoundException Raise when the requested authentication guard is not registered.
Exception IdentityProviderException Raise when the identity provider cannot resolve the application identity.
Exception PolicyNotFoundException Raise when no policy is registered for the requested resource type.
Exception TokenException Raise when a personal access token cannot be issued or verified.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXCEPTIONS_MODULE Locate the shared module defining authentication failures.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXCEPTIONS_MODULE: str = (source)

Locate the shared module defining authentication failures.

Value
'orionis.auth.exceptions'
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'AccessToken': ('orionis.auth.entities.access_token', 'AccessToken'),
 'AuthConfigurationException': (_EXCEPTIONS_MODULE,
                                'AuthConfigurationException'),
 'AuthException': (_EXCEPTIONS_MODULE, 'AuthException'),
 'Authenticatable': ('orionis.auth.concerns.authenticatable', 'Authenticatable')↵
,
 'AuthenticationContext': ('orionis.auth.context.context', 'AuthenticationContex↵
...