From 6d7ba58f880be618ade07f8ea080fe8c4bf8a896 Mon Sep 17 00:00:00 2001
From: cyfraeviolae <cyfraeviolae>
Date: Wed, 3 Apr 2024 03:10:44 -0400
Subject: venv

---
 .../site-packages/litestar/middleware/base.py      | 151 +++++++++++++++++++++
 1 file changed, 151 insertions(+)
 create mode 100644 venv/lib/python3.11/site-packages/litestar/middleware/base.py

(limited to 'venv/lib/python3.11/site-packages/litestar/middleware/base.py')

diff --git a/venv/lib/python3.11/site-packages/litestar/middleware/base.py b/venv/lib/python3.11/site-packages/litestar/middleware/base.py
new file mode 100644
index 0000000..43106c9
--- /dev/null
+++ b/venv/lib/python3.11/site-packages/litestar/middleware/base.py
@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+from typing import TYPE_CHECKING, Any, Callable, Protocol, runtime_checkable
+
+from litestar.enums import ScopeType
+from litestar.middleware._utils import (
+    build_exclude_path_pattern,
+    should_bypass_middleware,
+)
+
+__all__ = ("AbstractMiddleware", "DefineMiddleware", "MiddlewareProtocol")
+
+
+if TYPE_CHECKING:
+    from litestar.types import Scopes
+    from litestar.types.asgi_types import ASGIApp, Receive, Scope, Send
+
+
+@runtime_checkable
+class MiddlewareProtocol(Protocol):
+    """Abstract middleware protocol."""
+
+    __slots__ = ("app",)
+
+    app: ASGIApp
+
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        """Execute the ASGI middleware.
+
+        Called by the previous middleware in the stack if a response is not awaited prior.
+
+        Upon completion, middleware should call the next ASGI handler and await it - or await a response created in its
+        closure.
+
+        Args:
+            scope: The ASGI connection scope.
+            receive: The ASGI receive function.
+            send: The ASGI send function.
+
+        Returns:
+            None
+        """
+
+
+class DefineMiddleware:
+    """Container enabling passing ``*args`` and ``**kwargs`` to Middleware class constructors and factory functions."""
+
+    __slots__ = ("middleware", "args", "kwargs")
+
+    def __init__(self, middleware: Callable[..., ASGIApp], *args: Any, **kwargs: Any) -> None:
+        """Initialize ``DefineMiddleware``.
+
+        Args:
+            middleware: A callable that returns an ASGIApp.
+            *args: Positional arguments to pass to the callable.
+            **kwargs: Key word arguments to pass to the callable.
+
+        Notes:
+            The callable will be passed a kwarg ``app``, which is the next ASGI app to call in the middleware stack.
+            It therefore must define such a kwarg.
+        """
+        self.middleware = middleware
+        self.args = args
+        self.kwargs = kwargs
+
+    def __call__(self, app: ASGIApp) -> ASGIApp:
+        """Call the middleware constructor or factory.
+
+        Args:
+            app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack.
+
+        Returns:
+            Calls :class:`DefineMiddleware.middleware <.DefineMiddleware>` and returns the ASGIApp created.
+        """
+
+        return self.middleware(*self.args, app=app, **self.kwargs)
+
+
+class AbstractMiddleware:
+    """Abstract middleware providing base functionality common to all middlewares, for dynamically engaging/bypassing
+    the middleware based on paths, ``opt``-keys and scope types.
+
+    When implementing new middleware, this class should be used as a base.
+    """
+
+    scopes: Scopes = {ScopeType.HTTP, ScopeType.WEBSOCKET}
+    exclude: str | list[str] | None = None
+    exclude_opt_key: str | None = None
+
+    def __init__(
+        self,
+        app: ASGIApp,
+        exclude: str | list[str] | None = None,
+        exclude_opt_key: str | None = None,
+        scopes: Scopes | None = None,
+    ) -> None:
+        """Initialize the middleware.
+
+        Args:
+            app: The ``next`` ASGI app to call.
+            exclude: A pattern or list of patterns to match against a request's path.
+                If a match is found, the middleware will be skipped.
+            exclude_opt_key: An identifier that is set in the route handler
+                ``opt`` key which allows skipping the middleware.
+            scopes: ASGI scope types, should be a set including
+                either or both 'ScopeType.HTTP' and 'ScopeType.WEBSOCKET'.
+        """
+        self.app = app
+        self.scopes = scopes or self.scopes
+        self.exclude_opt_key = exclude_opt_key or self.exclude_opt_key
+        self.exclude_pattern = build_exclude_path_pattern(exclude=(exclude or self.exclude))
+
+    @classmethod
+    def __init_subclass__(cls, **kwargs: Any) -> None:
+        super().__init_subclass__(**kwargs)
+
+        original__call__ = cls.__call__
+
+        async def wrapped_call(self: AbstractMiddleware, scope: Scope, receive: Receive, send: Send) -> None:
+            if should_bypass_middleware(
+                scope=scope,
+                scopes=self.scopes,
+                exclude_path_pattern=self.exclude_pattern,
+                exclude_opt_key=self.exclude_opt_key,
+            ):
+                await self.app(scope, receive, send)
+            else:
+                await original__call__(self, scope, receive, send)  # pyright: ignore
+
+        # https://github.com/python/mypy/issues/2427#issuecomment-384229898
+        setattr(cls, "__call__", wrapped_call)
+
+    @abstractmethod
+    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        """Execute the ASGI middleware.
+
+        Called by the previous middleware in the stack if a response is not awaited prior.
+
+        Upon completion, middleware should call the next ASGI handler and await it - or await a response created in its
+        closure.
+
+        Args:
+            scope: The ASGI connection scope.
+            receive: The ASGI receive function.
+            send: The ASGI send function.
+
+        Returns:
+            None
+        """
+        raise NotImplementedError("abstract method must be implemented")
-- 
cgit v1.2.3