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.auth

package documentation
(source)

Undocumented

Package authorization No package docstring; 0/1 constant, 3/3 classes, 0/6 module documented
Package concerns No package docstring; 1/1 function, 3/3 classes, 0/4 module documented
Package context No package docstring; 0/1 constant, 2/2 functions, 1/1 class, 0/2 module documented
Package contracts No package docstring; 12/12 classes, 0/12 module documented
Package entities No package docstring; 3/3 classes, 0/3 module documented
Module exceptions Undocumented
Package guards No package docstring; 2/2 classes, 0/2 module documented
Package identity No package docstring; 1/1 class, 0/1 module documented
Module manager No module docstring; 1/1 class documented
Package middleware No package docstring; 10/10 classes, 0/5 module documented
Package passwords Undocumented
Module provider No module docstring; 1/1 class documented
Module remember No module docstring; 0/3 constant, 1/1 function, 1/1 class documented
Package tokens No package docstring; 2/2 functions, 1/1 class, 0/2 module documented

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 _EXPORTS Undocumented
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.
_EXPORTS: dict = (source)

Undocumented

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