orionis.auth.concerns.Authenticatable

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

class documentation

class Authenticatable: (source)

View In Hierarchy

Turn any Orionis model into an authenticatable identity.

Mix it into the model backing your users:

class User(Model, Authenticatable, Authorizable):
    id = Integer().primary().autoIncrement()
    email = String(255).unique()
    password = String(255)

The mixin is a plain class registered as a virtual implementation of IAuthenticatable. Inheriting from the ABC directly would clash with ModelMeta, the metaclass of every Orionis model.

Method	`getAuthIdentifier`	Return the value uniquely identifying this identity.
Method	`getAuthIdentifierName`	Return the attribute holding the unique identifier.
Method	`getAuthPassword`	Return the stored password hash of this identity.
Constant	`AUTH_PASSWORD`	Undocumented
Class Variable	`__slots__`	Undocumented

def getAuthIdentifier(self) -> object: (source) ¶

Return the value uniquely identifying this identity.

Returns
`object`	Primary key value, or `None` when the model was never persisted.

def getAuthIdentifierName(self) -> str: (source) ¶

Return the attribute holding the unique identifier.

Returns
`str`	Primary key declared by the model metadata.

def getAuthPassword(self) -> str: (source) ¶

Return the stored password hash of this identity.

Returns
`str`	Encoded hash, or an empty string when the attribute is unset.

AUTH_PASSWORD: ClassVar[str] = (source) ¶

Undocumented

Value

'password'

__slots__: tuple = (source) ¶

Undocumented