redditwarp.core.authorizer_ASYNC

class redditwarp.core.authorizer_ASYNC.Authorizer(token_client: TokenObtainmentClient | None = None, token: Token | None = None)

Bases: object

An object for managing the token.

The Authorizer keeps token information and knows how to renew the token when it expires and how to prepare a requisition.

token_client: TokenObtainmentClient | None

A token obtainment client used to make the token obtainment requests.

token: Token | None

Holds the current token information.

renewal_time: float | None

Time at which the token is expected to expire. See time().

renewal_skew: float

Number of seconds before the token expiration when the token should be renewed.

expires_in_fallback: int | None

A fallback value for the token expiration time when not specified by the server.

time_func: Callable[[], float]

A function that returns the current time. The time() method calls this this function.

authorization_header_name: str

Name of the Authorization header. Use this attribute to change its capitalization.

has_token_client() → bool

fetch_token_client() → TokenObtainmentClient

Return .token_client. Raise RuntimeError if not set.

set_token_client(value: TokenObtainmentClient | None) → None

Set .token_client.

has_token() → bool

fetch_token() → Token

Return .token. Raise RuntimeError if not set.

set_token(value: Token | None) → None

Set .token.

async renew_token() → None

Renew the token.

Raises:

RuntimeError – No token client (token_client) is set.

time() → float

Return the current internal time. This is used for renewal_time.

should_renew_token() → bool

Return true if the token is expired, about to expire, or is unset.

can_renew_token() → bool

The token can be renewed if a token client (token_client) is available.

async attain_token() → Token

get_header_entry() → tuple[str, str]

Return an authorization header entry tuple.

prepare_requisition(requisition: Requisition) → None

Prepare a requisition for authorization using the token.

prepare_headers(headers: MutableMapping[str, str]) → None

Update headers with an authorization entry.

class redditwarp.core.authorizer_ASYNC.Authorized(handler: Handler, authorizer: Authorizer)

Bases: DelegatingHandler

Used to make requests to endpoints that require authorization.

authorizer: Authorizer