quart.wrappers.base module

class quart.wrappers.base.BaseRequestWebsocket(method: str, scheme: str, path: str, query_string: bytes, headers: Headers, root_path: str, http_version: str, scope: Union[HTTPScope, WebsocketScope])

Bases: Request

This class is the basis for Requests and websockets..

json_module

A custom json decoding/encoding module, it should have dump, dumps, load, and loads methods

Type:

json.provider.JSONProvider

routing_exception

If an exception is raised during the route matching it will be stored here.

Type:

Optional[Exception]

url_rule

The rule that this request has been matched too.

Type:

Optional[‘QuartRule’]

view_args

The keyword arguments for the view from the route matching.

Type:

Optional[Dict[str, Any]]

property blueprint: Optional[str]

Returns the blueprint the matched endpoint belongs to.

This can be None if the request has not been matched or the endpoint is not in a blueprint.

property blueprints: List[str]

Return the names of the current blueprints. The returned list is ordered from the current blueprint, upwards through parent blueprints.

property endpoint: Optional[str]

Returns the corresponding endpoint matched for this request.

This can be None if the request has not been matched with a rule.

json_module: json.provider.JSONProvider = <module 'quart.json' from '/home/docs/checkouts/readthedocs.org/user_builds/quart-latest-doc-gen/envs/latest/lib/python3.10/site-packages/quart/json/__init__.py'>

property max_content_length: Optional[int]

Read-only view of the MAX_CONTENT_LENGTH config key.

routing_exception: Optional[Exception] = None

property script_root: str

property url_root: str

url_rule: Optional['QuartRule'] = None

view_args: Optional[Dict[str, Any]] = None