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 middleware components and public imports.

Module authenticate Provide auth middleware operations.
Module authorize Provide auth middleware operations.
Module guest Keep web login and registration routes restricted to guests.
Module policy Gate a route behind a policy ability declared on a resource class.
Module resolve_identity Provide auth middleware operations.

From __init__.py:

Class AuthenticateMiddleware Require an authenticated identity before reaching the controller.
Class AuthenticateSessionMiddleware Require an identity authenticated through the HTTP session.
Class AuthenticateTokenMiddleware Require an identity authenticated through a personal access token.
Class GuestMiddleware Keep web login and registration routes restricted to guests.
Class RequirePermissionMiddleware Require one or more permissions before reaching the controller.
Class RequirePolicyMiddleware Gate a route behind a policy ability declared on a resource class.
Class RequireRoleMiddleware Require one or more roles before reaching the controller.
Class ResolveIdentityMiddleware Establish authentication while allowing anonymous requests to continue.
Class ResolveSessionIdentityMiddleware Resolve a web identity from the session without requiring a login.
Class ResolveTokenIdentityMiddleware Resolve an API identity from a Bearer token while allowing guests.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _AUTHENTICATE_MODULE Module defining authentication-required middleware variants.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
Constant _RESOLVE_MODULE Module defining optional identity-resolution middleware variants.
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.
_AUTHENTICATE_MODULE: str = (source)

Module defining authentication-required middleware variants.

Value
'orionis.auth.middleware.authenticate'
_EXPORTS = (source)

Public export names mapped to their defining modules and attributes.

Value
{'AuthenticateMiddleware': (_AUTHENTICATE_MODULE, 'AuthenticateMiddleware'),
 'AuthenticateSessionMiddleware': (_AUTHENTICATE_MODULE,
                                   'AuthenticateSessionMiddleware'),
 'AuthenticateTokenMiddleware': (_AUTHENTICATE_MODULE,
                                 'AuthenticateTokenMiddleware'),
 'GuestMiddleware': ('orionis.auth.middleware.guest', 'GuestMiddleware'),
 'RequirePermissionMiddleware': ('orionis.auth.middleware.authorize', 'RequirePe↵
...
_RESOLVE_MODULE: str = (source)

Module defining optional identity-resolution middleware variants.

Value
'orionis.auth.middleware.resolve_identity'