httpx.BasicAuth

class documentation

class BasicAuth(Auth): (source)

View In Hierarchy

Allows the 'auth' argument to be passed as a (username, password) pair, and uses HTTP Basic authentication.

Method __init__ Undocumented
Method auth_flow Execute the authentication flow.
Method _build_auth_header Undocumented
Instance Variable _auth_header Undocumented

Inherited from Auth:

Async Method async_auth_flow Execute the authentication flow asynchronously.
Method sync_auth_flow Execute the authentication flow synchronously.
Class Variable requires_request_body Undocumented
Class Variable requires_response_body Undocumented
def __init__(self, username, password): (source)

Undocumented

Parameters
username:typing.Union[str, bytes]Undocumented
password:typing.Union[str, bytes]Undocumented
def auth_flow(self, request): (source)
overrides httpx.Auth.auth_flow

Execute the authentication flow. To dispatch a request, `yield` it: ``` yield request ``` The client will `.send()` the response back into the flow generator. You can access it like so: ``` response = yield request ``` A `return` (or reaching the end of the generator) will result in the client returning the last response obtained from the server. You can dispatch as many requests as is necessary.

Parameters
request:RequestUndocumented
Returns
typing.Generator[Request, Response, None]Undocumented
def _build_auth_header(self, username, password): (source)

Undocumented

Parameters
username:typing.Union[str, bytes]Undocumented
password:typing.Union[str, bytes]Undocumented
Returns
strUndocumented
_auth_header = (source)

Undocumented