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

Resolve authentication contracts without creating entity import cycles.

Module authenticatable Define the minimum surface an application identity must expose.
Module authorizable Define how an identity is addressed by the authorization tables.
Module authorizer Define the component answering authorization questions.
Module context Define the authenticated state bound to a single request.
Module guard Define how an authenticated identity is extracted from a request.
Module identity_provider Define how a persisted identity becomes an application object.
Module manager Define the public entry point of the authentication module.
Module permission_repository Define how the effective permissions of an identity are loaded.
Module policy Define the contract shared by every resource policy.
Module session_guard Define the stateful operations supported by session authentication.
Module snapshot Define the immutable authorization picture of a single request.
Module token_repository Define the persistence operations of personal access tokens.

From __init__.py:

Class IAccessTokenRepository Define the persistence operations of personal access tokens.
Class IAuthenticatable Define the minimum surface an application identity must expose.
Class IAuthenticationContext Define the authenticated state bound to a single request.
Class IAuthManager Define the public entry point of the authentication module.
Class IAuthorizable Define how an identity is addressed by the authorization tables.
Class IAuthorizationSnapshot Define the immutable authorization picture of a single request.
Class IAuthorizer Define the component answering authorization questions.
Class IGuard Define how an authenticated identity is extracted from a request.
Class IIdentityProvider Define how a persisted identity becomes an application object.
Class IPermissionRepository Define how the effective permissions of an identity are loaded.
Class IPolicy Define the contract shared by every resource policy.
Class ISessionGuard Define the stateful operations supported by session authentication.
Function __dir__ Include unloaded contracts in package introspection.
Function __getattr__ Resolve a public contract on first access.
Constant _EXPORTS Public contract names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

Include unloaded contracts in package introspection.

Returns
list[str]Sorted package attributes and public contract names.
def __getattr__(name: str) -> object: (source)

Resolve a public contract on first access.

Parameters
name:strPublic export to resolve.
Returns
objectExported contract retaining its original module identity.
Raises
AttributeErrorIf the name is not a public export.
_EXPORTS: dict = (source)

Public contract names mapped to their defining modules and attributes.

Value
{'IAccessTokenRepository': ('orionis.auth.contracts.token_repository',
                            'IAccessTokenRepository'),
 'IAuthManager': ('orionis.auth.contracts.manager', 'IAuthManager'),
 'IAuthenticatable': ('orionis.auth.contracts.authenticatable',
                      'IAuthenticatable'),
 'IAuthenticationContext': ('orionis.auth.contracts.context',
                            'IAuthenticationContext'),
...