werkzeug.local.LocalProxy

A proxy to the object bound to a context-local object. All operations on the proxy are forwarded to the bound object. If no object is bound, a ``RuntimeError`` is raised. :param local: The context-local object that provides the proxied object. :param name: Proxy this attribute from the proxied object. :param unbound_message: The error message to show if the context-local object is unbound. Proxy a :class:`~contextvars.ContextVar` to make it easier to access. Pass a name to proxy that attribute. .. code-block:: python _request_var = ContextVar("request") request = LocalProxy(_request_var) session = LocalProxy(_request_var, "session") Proxy an attribute on a :class:`Local` namespace by calling the local with the attribute name: .. code-block:: python data = Local() user = data("user") Proxy the top item on a :class:`LocalStack` by calling the local. Pass a name to proxy that attribute. .. code-block:: app_stack = LocalStack() current_app = app_stack() g = app_stack("g") Pass a function to proxy the return value from that function. This was previously used to access attributes of local objects before that was supported directly. .. code-block:: python session = LocalProxy(lambda: request.session) ``__repr__`` and ``__class__`` are proxied, so ``repr(x)`` and ``isinstance(x, cls)`` will look like the proxied object. Use ``issubclass(type(x), LocalProxy)`` to check if an object is a proxy. .. code-block:: python repr(user) # <User admin> isinstance(user, User) # True issubclass(type(user), LocalProxy) # True .. versionchanged:: 2.2.2 ``__wrapped__`` is set when wrapping an object, not only when wrapping a function, to prevent doctest from failing. .. versionchanged:: 2.2 Can proxy a ``ContextVar`` or ``LocalStack`` directly. .. versionchanged:: 2.2 The ``name`` parameter can be used with any proxied object, not only ``Local``. .. versionchanged:: 2.2 Added the ``unbound_message`` parameter. .. versionchanged:: 2.0 Updated proxied attributes and methods to reflect the current data model. .. versionchanged:: 0.6.1 The class can be instantiated with a callable.