pigeon.middleware.components.staticfiles

Module Contents

pigeon.middleware.components.staticfiles.handle_static_request(request: pigeon.http.HTTPRequest)

class pigeon.middleware.components.staticfiles.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.components.staticfiles.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

class pigeon.middleware.components.staticfiles.Manager

Used to manage settings and load specified middleware which is only loaded at runtime.

To override settings either the method Manager.override or the Manager.__get_attr__ method is used:

# override settings using a module or similar behaving object
my_settings: types.ModuleType = ...
Manager.override(my_settings)

# override settings one at a time by accessing the attributes (__getattr__)
Manager.my_setting = my_value

classmethod override(new_settings: types.ModuleType | Any)

Overrides current settings with new settings provided.

Parameters:

new_settings – New settings to override old ones with

class pigeon.middleware.components.staticfiles.StaticFilesComponent

classmethod process(request: pigeon.http.HTTPRequest, func: Callable)

If request is to a static url change func to return static file, otherwise leave as is.