Base

Base interface for implementations of all authoriser flows.

Classes:

Authoriser([service_name])

Base interface for authenticating and authorising access to a service over HTTP.

class aiorequestful.auth.base.Authoriser(service_name='unknown_service')

Bases: ABC

Base interface for authenticating and authorising access to a service over HTTP.

Parameters:

service_name (str (default: 'unknown_service')) – The service name for which to authorise.

Attributes:

logger	The logging.Logger for this object
service_name	The service name for which to authorise.

Methods:

authorise()

Authenticate and authorise, testing/refreshing/re-authorising as needed.

logger: Logger

The logging.Logger for this object

service_name

The service name for which to authorise. Currently only used for logging purposes.

abstractmethod async authorise()

Authenticate and authorise, testing/refreshing/re-authorising as needed.

Raises:

AuthoriserError – If the authorisation failed to generate valid a token if needed, or if the tests continue to fail despite authorising/re-authorising.

Return type:

dict[str, str]