module: integrations.wsgi

Module Attributes

current_environ

Environment variables for the current HTTP request.

Classes

ContextVarsMiddleware(wrapped_app)

Middleware for WSGI apps that puts each request to its own isolated context.

current_environ: ContextVar[Dict[str, str]] = <ContextVar name='contextvars_registry.integrations.wsgi.current_environ'>

Environment variables for the current HTTP request.

This context variable contains a dictionary of CGI environment variables, so-called environ, that contains metadata about the HTTP request currently being handled.

See PEP 333 for the list of possible variables: https://www.python.org/dev/peps/pep-0333/#environ-variables

Note

This context variable is set by ContextVarsMiddleware.

So you can use it only when you use that special middleware class, and only inside HTTP request handler code.

An attempt to use it ouside of HTTP request context will raise LookupError.

class ContextVarsMiddleware(wrapped_app)[source]

Middleware for WSGI apps that puts each request to its own isolated context.

Actually, this middleware does 2 things:

Puts each request into its own sandbox context. That allows you to set any context variables freely, and your changes will remain local to the current HTTP request.

Sets current_environ context variable. That allows you to reach the environ dict from any function in your code, without passing it through arguments.

Example:

>>> from contextvars_registry.integrations.wsgi import ContextVarsMiddleware, current_environ
>>> import werkzeug.test

>>> def get_current_url():
...     return current_environ.get().get('REQUEST_URI')

>>> def my_wsgi_app(environ, start_response):
...     start_response('200 OK', [('Content-type', 'text/plain; charset=utf-8')])
...     return get_current_url()

>>> wrapped_wsgi_app = ContextVarsMiddleware(my_wsgi_app)

>>> test_client = werkzeug.test.Client(wrapped_wsgi_app)

>>> response = test_client.post("http://localhost/test_api")
>>> response.text
'http://localhost/test_api'

Parameters:: wrapped_app (Callable[[Dict[str, str], Callable[[str, List[Tuple[str, str]]], None]], Iterable[str | bytes]]) –

__init__(wrapped_app)[source]

Parameters:: wrapped_app (Callable[[Dict[str, str], Callable[[str, List[Tuple[str, str]]], None]], Iterable[str | bytes]]) –

__call__(environ, start_response)[source]

Call self as a function.

Parameters:

environ (Dict[str, str]) –
start_response (Callable[[str, List[Tuple[str, str]]], None]) –

Return type:

Iterable[str | bytes]