pigeon.middleware.auth

Module Contents

pigeon.middleware.auth.error(code: int, request: pigeon.http.request.HTTPRequest | None = None) → pigeon.http.response.HTTPResponse | str

Returns the HTTPResponse for the error code provided, request parameter optional

class pigeon.middleware.auth.HTTPRequest(method: str, path: str, headers: dict = None, get: dict = None, data=None, files=None, protocol: str = '1.1', content_type=None, **kwargs)

Bases: pigeon.http.message.HTTPMessage

An HTTP message (obv either response or request)

property is_error

class pigeon.middleware.auth.HTTPResponse(headers: dict = None, data: str = None, status: int = 200, cookies=None, protocol: str = '1.1', content_type=None, **kwargs)

Bases: pigeon.http.message.HTTPMessage

An HTTP message (obv either response or request)

property is_error

pigeon.middleware.auth.log

class pigeon.middleware.auth.Credentials(username=None, password=None, type=None)

class pigeon.middleware.auth.AuthHandler

wrap(view)

Wraps a view in a wrapper for the specific auth

wrap_basic(view)

Wraps the view function (view.func) for basic authentication