- - - """ - - return f""" - - - {head} - {body} - - """.encode() - - def render_stoplight_elements(self, request: Request[Any, Any, Any]) -> bytes: - """Render an HTML page for StopLight Elements. - - Notes: - - override this method to customize the template. - - Args: - request: - A :class:`Request <.connection.Request>` instance. - - Returns: - A rendered html string. - """ - schema = self.get_schema_from_request(request) - head = f""" - - {schema.info.title} - {self.favicon} - - - - - - - """ - - body = f""" - - - - """ - - return f""" - - - {head} - {body} - - """.encode() - - def render_rapidoc(self, request: Request[Any, Any, Any]) -> bytes: # pragma: no cover - schema = self.get_schema_from_request(request) - - head = f""" - - {schema.info.title} - {self.favicon} - - - - - - """ - - body = f""" - - - - """ - - return f""" - - - {head} - {body} - - """.encode() - - def render_redoc(self, request: Request[Any, Any, Any]) -> bytes: # pragma: no cover - """Render an HTML page for Redoc. - - Notes: - - override this method to customize the template. - - Args: - request: - A :class:`Request <.connection.Request>` instance. - - Returns: - A rendered html string. - """ - schema = self.get_schema_from_request(request) - - head = f""" - - {schema.info.title} - {self.favicon} - - - """ - - if self.redoc_google_fonts: - head += """ - - """ - - head += f""" - - - - """ - - body = f""" - -

- - - """ - - return f""" - - - {head} - {body} - - """.encode() - - def render_404_page(self) -> bytes: - """Render an HTML 404 page. - - Returns: - A rendered html string. - """ - - return f""" - - - - 404 Not found - {self.favicon} - - - - - -

Error 404

- - - """.encode() - - def _get_schema_as_json(self, request: Request) -> str: - """Get the schema encoded as a JSON string.""" - - if not self._dumped_json_schema: - schema = self.get_schema_from_request(request).to_schema() - json_encoded_schema = encode_json(schema, request.route_handler.default_serializer) - self._dumped_json_schema = json_encoded_schema.decode("utf-8") - - return self._dumped_json_schema diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/datastructures.py b/venv/lib/python3.11/site-packages/litestar/openapi/datastructures.py deleted file mode 100644 index 5796a48..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/datastructures.py +++ /dev/null @@ -1,29 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from typing import TYPE_CHECKING - -from litestar.enums import MediaType - -if TYPE_CHECKING: - from litestar.openapi.spec import Example - from litestar.types import DataContainerType - - -__all__ = ("ResponseSpec",) - - -@dataclass -class ResponseSpec: - """Container type of additional responses.""" - - data_container: DataContainerType | None - """A model that describes the content of the response.""" - generate_examples: bool = field(default=True) - """Generate examples for the response content.""" - description: str = field(default="Additional response") - """A description of the response.""" - media_type: MediaType = field(default=MediaType.JSON) - """Response media type.""" - examples: list[Example] | None = field(default=None) - """A list of Example models.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__init__.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__init__.py deleted file mode 100644 index 438c351..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -from .base import BaseSchemaObject -from .callback import Callback -from .components import Components -from .contact import Contact -from .discriminator import Discriminator -from .encoding import Encoding -from .enums import OpenAPIFormat, OpenAPIType -from .example import Example -from .external_documentation import ExternalDocumentation -from .header import OpenAPIHeader -from .info import Info -from .license import License -from .link import Link -from .media_type import OpenAPIMediaType -from .oauth_flow import OAuthFlow -from .oauth_flows import OAuthFlows -from .open_api import OpenAPI -from .operation import Operation -from .parameter import Parameter -from .path_item import PathItem -from .paths import Paths -from .reference import Reference -from .request_body import RequestBody -from .response import OpenAPIResponse -from .responses import Responses -from .schema import Schema -from .security_requirement import SecurityRequirement -from .security_scheme import SecurityScheme -from .server import Server -from .server_variable import ServerVariable -from .tag import Tag -from .xml import XML - -__all__ = ( - "BaseSchemaObject", - "Callback", - "Components", - "Contact", - "Discriminator", - "Encoding", - "Example", - "ExternalDocumentation", - "Info", - "License", - "Link", - "OAuthFlow", - "OAuthFlows", - "OpenAPI", - "OpenAPIFormat", - "OpenAPIHeader", - "OpenAPIMediaType", - "OpenAPIResponse", - "OpenAPIType", - "Operation", - "Parameter", - "PathItem", - "Paths", - "Reference", - "RequestBody", - "Responses", - "Schema", - "SecurityRequirement", - "SecurityScheme", - "Server", - "ServerVariable", - "Tag", - "XML", -) diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 682acac..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 7f9658f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/callback.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/callback.cpython-311.pyc deleted file mode 100644 index 8fb170e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/callback.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/components.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/components.cpython-311.pyc deleted file mode 100644 index 98c83be..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/components.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/contact.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/contact.cpython-311.pyc deleted file mode 100644 index 53b94c2..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/contact.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/discriminator.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/discriminator.cpython-311.pyc deleted file mode 100644 index 5a4b1bc..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/discriminator.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/encoding.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/encoding.cpython-311.pyc deleted file mode 100644 index 58ab620..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/encoding.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/enums.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/enums.cpython-311.pyc deleted file mode 100644 index 9e328e3..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/enums.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/example.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/example.cpython-311.pyc deleted file mode 100644 index 4f031b1..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/example.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/external_documentation.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/external_documentation.cpython-311.pyc deleted file mode 100644 index a0f445b..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/external_documentation.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/header.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/header.cpython-311.pyc deleted file mode 100644 index 1596fd8..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/header.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/info.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/info.cpython-311.pyc deleted file mode 100644 index 45c4fdd..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/info.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/license.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/license.cpython-311.pyc deleted file mode 100644 index 98c60d4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/license.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/link.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/link.cpython-311.pyc deleted file mode 100644 index b30775a..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/link.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/media_type.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/media_type.cpython-311.pyc deleted file mode 100644 index 47c85af..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/media_type.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flow.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flow.cpython-311.pyc deleted file mode 100644 index a6a8564..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flow.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flows.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flows.cpython-311.pyc deleted file mode 100644 index 04555f8..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/oauth_flows.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/open_api.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/open_api.cpython-311.pyc deleted file mode 100644 index 1926726..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/open_api.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/operation.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/operation.cpython-311.pyc deleted file mode 100644 index 1c3ddc2..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/operation.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/parameter.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/parameter.cpython-311.pyc deleted file mode 100644 index e860dc9..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/parameter.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/path_item.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/path_item.cpython-311.pyc deleted file mode 100644 index cf33d1c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/path_item.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/paths.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/paths.cpython-311.pyc deleted file mode 100644 index 4dc2e6e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/paths.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/reference.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/reference.cpython-311.pyc deleted file mode 100644 index 66b4e2c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/reference.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/request_body.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/request_body.cpython-311.pyc deleted file mode 100644 index 5788ebc..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/request_body.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/response.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/response.cpython-311.pyc deleted file mode 100644 index 364f342..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/response.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/responses.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/responses.cpython-311.pyc deleted file mode 100644 index db08130..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/responses.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/schema.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/schema.cpython-311.pyc deleted file mode 100644 index 6af9ca3..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/schema.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_requirement.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_requirement.cpython-311.pyc deleted file mode 100644 index 5aa7c2f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_requirement.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_scheme.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_scheme.cpython-311.pyc deleted file mode 100644 index a2b1045..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/security_scheme.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server.cpython-311.pyc deleted file mode 100644 index 26b70b3..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server_variable.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server_variable.cpython-311.pyc deleted file mode 100644 index 46ab0cd..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/server_variable.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/tag.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/tag.cpython-311.pyc deleted file mode 100644 index 7597e16..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/tag.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/xml.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/xml.cpython-311.pyc deleted file mode 100644 index 97cacd9..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/openapi/spec/__pycache__/xml.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/base.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/base.py deleted file mode 100644 index 69cd3f3..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/base.py +++ /dev/null @@ -1,56 +0,0 @@ -from __future__ import annotations - -from dataclasses import asdict, dataclass, fields, is_dataclass -from enum import Enum -from typing import Any - -__all__ = ("BaseSchemaObject",) - - -def _normalize_key(key: str) -> str: - if key.endswith("_in"): - return "in" - if key.startswith("schema_"): - return key.split("_")[1] - if "_" in key: - components = key.split("_") - return components[0] + "".join(component.title() for component in components[1:]) - return "$ref" if key == "ref" else key - - -def _normalize_value(value: Any) -> Any: - if isinstance(value, BaseSchemaObject): - return value.to_schema() - if is_dataclass(value): - return {_normalize_value(k): _normalize_value(v) for k, v in asdict(value).items() if v is not None} - if isinstance(value, dict): - return {_normalize_value(k): _normalize_value(v) for k, v in value.items() if v is not None} - if isinstance(value, list): - return [_normalize_value(v) for v in value] - return value.value if isinstance(value, Enum) else value - - -@dataclass -class BaseSchemaObject: - """Base class for schema spec objects""" - - def to_schema(self) -> dict[str, Any]: - """Transform the spec dataclass object into a string keyed dictionary. This method traverses all nested values - recursively. - """ - result: dict[str, Any] = {} - - for field in fields(self): - value = _normalize_value(getattr(self, field.name, None)) - - if value is not None: - if "alias" in field.metadata: - if not isinstance(field.metadata["alias"], str): - raise TypeError('metadata["alias"] must be a str') - key = field.metadata["alias"] - else: - key = _normalize_key(field.name) - - result[key] = value - - return result diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/callback.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/callback.py deleted file mode 100644 index c4bb129..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/callback.py +++ /dev/null @@ -1,24 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Dict, Union - -if TYPE_CHECKING: - from litestar.openapi.spec.path_item import PathItem - from litestar.openapi.spec.reference import Reference - - -Callback = Dict[str, Union["PathItem", "Reference"]] -"""A map of possible out-of band callbacks related to the parent operation. Each value in the map is a -`Path Item Object `_ that describes a set of requests that may be -initiated by the API provider and the expected responses. The key value used to identify the path item object is an -expression, evaluated at runtime, that identifies a URL to use for the callback operation. - -Patterned Fields - -{expression}: 'PathItem' = ... - -A Path Item Object used to define a callback request and expected responses. - -A `complete example `_ is -available. -""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/components.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/components.py deleted file mode 100644 index b11da78..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/components.py +++ /dev/null @@ -1,72 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("Components",) - - -if TYPE_CHECKING: - from litestar.openapi.spec.callback import Callback - from litestar.openapi.spec.example import Example - from litestar.openapi.spec.header import OpenAPIHeader - from litestar.openapi.spec.link import Link - from litestar.openapi.spec.parameter import Parameter - from litestar.openapi.spec.path_item import PathItem - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.request_body import RequestBody - from litestar.openapi.spec.response import OpenAPIResponse - from litestar.openapi.spec.schema import Schema - from litestar.openapi.spec.security_scheme import SecurityScheme - - -@dataclass -class Components(BaseSchemaObject): - """Holds a set of reusable objects for different aspects of the OAS. - - All objects defined within the components object will have no effect - on the API unless they are explicitly referenced from properties - outside the components object. - """ - - schemas: dict[str, Schema] = field(default_factory=dict) - """An object to hold reusable - `Schema Objects `_""" - - responses: dict[str, OpenAPIResponse | Reference] | None = None - """An object to hold reusable - `Response Objects `_""" - - parameters: dict[str, Parameter | Reference] | None = None - """An object to hold reusable - `Parameter Objects `_""" - - examples: dict[str, Example | Reference] | None = None - """An object to hold reusable - `Example Objects `_""" - - request_bodies: dict[str, RequestBody | Reference] | None = None - """An object to hold reusable - `Request Body Objects `_""" - - headers: dict[str, OpenAPIHeader | Reference] | None = None - """An object to hold reusable - `Header Objects `_""" - - security_schemes: dict[str, SecurityScheme | Reference] | None = None - """An object to hold reusable - `Security Scheme Objects `_""" - - links: dict[str, Link | Reference] | None = None - """An object to hold reusable - `Link Objects `_""" - - callbacks: dict[str, Callback | Reference] | None = None - """An object to hold reusable - `Callback Objects `_""" - - path_items: dict[str, PathItem | Reference] | None = None - """An object to hold reusable - `Path Item Object `_""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/contact.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/contact.py deleted file mode 100644 index b816288..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/contact.py +++ /dev/null @@ -1,21 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("Contact",) - - -@dataclass -class Contact(BaseSchemaObject): - """Contact information for the exposed API.""" - - name: str | None = None - """The identifying name of the contact person/organization.""" - - url: str | None = None - """The URL pointing to the contact information. MUST be in the form of a URL.""" - - email: str | None = None - """The email address of the contact person/organization. MUST be in the form of an email address.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/discriminator.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/discriminator.py deleted file mode 100644 index 3c292ce..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/discriminator.py +++ /dev/null @@ -1,25 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("Discriminator",) - - -@dataclass(unsafe_hash=True) -class Discriminator(BaseSchemaObject): - """When request bodies or response payloads may be one of a number of different schemas, a ``discriminator`` - object can be used to aid in serialization, deserialization, and validation. - - The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an - alternative schema based on the value associated with it. - - When using the discriminator, _inline_ schemas will not be considered. - """ - - property_name: str - """**REQUIRED**. The name of the property in the payload that will hold the discriminator value.""" - - mapping: dict[str, str] | None = None - """An object to hold mappings between payload values and schema names or references.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py deleted file mode 100644 index 2a469c8..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py +++ /dev/null @@ -1,67 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.header import OpenAPIHeader - from litestar.openapi.spec.reference import Reference - -__all__ = ("Encoding",) - - -@dataclass -class Encoding(BaseSchemaObject): - """A single encoding definition applied to a single schema property.""" - - content_type: str | None = None - """The Content-Type for encoding a specific property. Default value depends n the property type: - - - for ``object``: ``application/json`` - - for ``array``: the default is defined based on the inner type - - for all other cases the default is ``application/octet-stream``. - - The value can be a specific media type (e.g. ``application/json``), a wildcard media type (e.g. ``image/*``), or a - comma-separated list of the two types. - """ - - headers: dict[str, OpenAPIHeader | Reference] | None = None - """A map allowing additional information to be provided as headers, for example ``Content-Disposition``. - - ``Content-Type`` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the - request body media type is not a ``multipart``. - """ - - style: str | None = None - """Describes how a specific property value will be serialized depending on its type. - - See `Parameter Object `_ for details on the - `style `__ property. The behavior follows the same values as - ``query`` parameters, including default values. This property SHALL be ignored if the request body media type is not - ``application/x-www-form-urlencoded`` or ``multipart/form-data``. If a value is explicitly defined, then the value - of `contentType `_ (implicit or explicit) SHALL be - ignored. - """ - - explode: bool = False - """When this is true, property values of type ``array`` or ``object`` generate separate parameters for each value of - the array, or key-value-pair of the map. - - For other types of properties this property has no effect. When - `style `_ is ``form``, the default value is ``True``. For all - other styles, the default value is ``False``. This property SHALL be ignored if the request body media type is not - ``application/x-www-form-urlencoded`` or ``multipart/form-data``. If a value is explicitly defined, then the value - of `contentType `_ (implicit or explicit) SHALL be - ignored. - """ - - allow_reserved: bool = False - """Determines whether the parameter value SHOULD allow reserved characters, as defined by :rfc:`3986` - (``:/?#[]@!$&'()*+,;=``) to be included without percent-encoding. - - This property SHALL be ignored if the request body media type s not ``application/x-www-form-urlencoded`` or - ``multipart/form-data``. If a value is explicitly defined, then the value of - `contentType `_ (implicit or explicit) SHALL be ignored. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/enums.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/enums.py deleted file mode 100644 index da9adea..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/enums.py +++ /dev/null @@ -1,41 +0,0 @@ -from enum import Enum - -__all__ = ("OpenAPIFormat", "OpenAPIType") - - -class OpenAPIFormat(str, Enum): - """Formats extracted from: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#page-13""" - - DATE = "date" - DATE_TIME = "date-time" - TIME = "time" - DURATION = "duration" - URL = "url" - EMAIL = "email" - IDN_EMAIL = "idn-email" - HOST_NAME = "hostname" - IDN_HOST_NAME = "idn-hostname" - IPV4 = "ipv4" - IPV6 = "ipv6" - URI = "uri" - URI_REFERENCE = "uri-reference" - URI_TEMPLATE = "uri-template" - JSON_POINTER = "json-pointer" - RELATIVE_JSON_POINTER = "relative-json-pointer" - IRI = "iri-reference" - IRI_REFERENCE = "iri-reference" # noqa: PIE796 - UUID = "uuid" - REGEX = "regex" - BINARY = "binary" - - -class OpenAPIType(str, Enum): - """An OopenAPI type.""" - - ARRAY = "array" - BOOLEAN = "boolean" - INTEGER = "integer" - NULL = "null" - NUMBER = "number" - OBJECT = "object" - STRING = "string" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/example.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/example.py deleted file mode 100644 index 414452e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/example.py +++ /dev/null @@ -1,33 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import Any - -from litestar.openapi.spec.base import BaseSchemaObject - - -@dataclass -class Example(BaseSchemaObject): - summary: str | None = None - """Short description for the example.""" - - description: str | None = None - """Long description for the example. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - value: Any | None = None - """Embedded literal example. - - The ``value`` field and ``externalValue`` field are mutually exclusive. To represent examples of media types that - cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. - """ - - external_value: str | None = None - """A URL that points to the literal example. This provides the capability to reference examples that cannot easily - be included in JSON or YAML documents. - - The ``value`` field and ``externalValue`` field are mutually exclusive. See the rules for resolving - `Relative References `_. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/external_documentation.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/external_documentation.py deleted file mode 100644 index f11b90d..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/external_documentation.py +++ /dev/null @@ -1,21 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("ExternalDocumentation",) - - -@dataclass -class ExternalDocumentation(BaseSchemaObject): - """Allows referencing an external resource for extended documentation.""" - - url: str - """**REQUIRED**. The URL for the target documentation. Value MUST be in the form of a URL.""" - - description: str | None = None - """A short description of the target documentation. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/header.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/header.py deleted file mode 100644 index 006ff22..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/header.py +++ /dev/null @@ -1,121 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any, Literal - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.example import Example - from litestar.openapi.spec.media_type import OpenAPIMediaType - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.schema import Schema - -__all__ = ("OpenAPIHeader",) - - -@dataclass -class OpenAPIHeader(BaseSchemaObject): - """The Header Object follows the structure of the [Parameter - Object](https://spec.openapis.org/oas/v3.1.0#parameterObject) with the - following changes: - - 1. ``name`` MUST NOT be specified, it is given in the corresponding ``headers`` map. - 2. ``in`` MUST NOT be specified, it is implicitly in ``header``. - 3. All traits that are affected by the location MUST be applicable to a location of ``header`` - (for example, `style `__). - """ - - schema: Schema | Reference | None = None - """The schema defining the type used for the parameter.""" - - name: Literal[""] = "" - """MUST NOT be specified, it is given in the corresponding ``headers`` map.""" - - param_in: Literal["header"] = "header" - """MUST NOT be specified, it is implicitly in ``header``.""" - - description: str | None = None - """A brief description of the parameter. This could contain examples of - use. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - required: bool = False - """Determines whether this parameter is mandatory. - - If the `parameter location `_ is ``"path"``, this property is - **REQUIRED** and its value MUST be ``True``. Otherwise, the property MAY be included and its default value is - ``False``. - """ - - deprecated: bool = False - """Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is ``False``.""" - - allow_empty_value: bool = False - """Sets the ability to pass empty-valued parameters. This is valid only for ``query`` parameters and allows sending - a parameter with an empty value. Default value is ``False``. If - `style `__ is used, and if behavior is ``n/a`` (cannot be - serialized), the value of ``allowEmptyValue`` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is - likely to be removed in a later revision. - - The rules for serialization of the parameter are specified in one of two ways.For simpler scenarios, a - `schema `_ and - `style `__ can describe the structure and syntax of the - parameter. - """ - - style: str | None = None - """Describes how the parameter value will be serialized depending on the - type of the parameter value. Default values (based on value of ``in``): - - - for ``query`` - ``form``; - - for ``path`` - ``simple``; - - for ``header`` - ``simple``; - - for ``cookie`` - ``form``. - """ - - explode: bool | None = None - """When this is true, parameter values of type ``array`` or ``object`` generate separate parameters for each value - of the array or key-value pair of the map. - - For other types of parameters this property has no effect.When - `style `__ is ``form``, the default value is ``True``. For all - other styles, the default value is ``False``. - """ - - allow_reserved: bool = False - """Determines whether the parameter value SHOULD allow reserved characters, as defined by. :rfc:`3986` - (``:/?#[]@!$&'()*+,;=``) to be included without percent-encoding. - - This property only applies to parameters with an ``in`` value of ``query``. The default value is ``False``. - """ - - example: Any | None = None - """Example of the parameter's potential value. - - The example SHOULD match the specified schema and encoding properties if present. The ``example`` field is mutually - exclusive of the ``examples`` field. Furthermore, if referencing a ``schema`` that contains an example, the - ``example`` value SHALL _override_ the example provided by the schema. To represent examples of media types that - cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where - necessary. - """ - - examples: dict[str, Example | Reference] | None = None - """Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as - specified in the parameter encoding. The ``examples`` field is mutually exclusive of the ``example`` field. - Furthermore, if referencing a ``schema`` that contains an example, the ``examples`` value SHALL _override_ the - example provided by the schema. - - For more complex scenarios, the `content `_ property can - define the media type and schema of the parameter. A parameter MUST contain either a ``schema`` property, or a - ``content`` property, but not both. When ``example`` or ``examples`` are provided in conjunction with the ``schema`` - object, the example MUST follow the prescribed serialization strategy for the parameter. - """ - - content: dict[str, OpenAPIMediaType] | None = None - """A map containing the representations for the parameter. - - The key is the media type and the value describes it. The map MUST only contain one entry. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/info.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/info.py deleted file mode 100644 index 1d858db..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/info.py +++ /dev/null @@ -1,50 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.contact import Contact - from litestar.openapi.spec.license import License - -__all__ = ("Info",) - - -@dataclass -class Info(BaseSchemaObject): - """The object provides metadata about the API. - - The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools - for convenience. - """ - - title: str - """ - **REQUIRED**. The title of the API. - """ - - version: str - """ - **REQUIRED**. The version of the OpenAPI document which is distinct from the - `OpenAPI Specification version `_ or the API implementation version - """ - - summary: str | None = None - """A short summary of the API.""" - - description: str | None = None - """A description of the API. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - terms_of_service: str | None = None - """A URL to the Terms of Service for the API. MUST be in the form of a URL.""" - - contact: Contact | None = None - """The contact information for the exposed API.""" - - license: License | None = None - """The license information for the exposed API.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/license.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/license.py deleted file mode 100644 index b779bb4..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/license.py +++ /dev/null @@ -1,28 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("License",) - - -@dataclass -class License(BaseSchemaObject): - """License information for the exposed API.""" - - name: str - """**REQUIRED**. The license name used for the API.""" - - identifier: str | None = None - """An - `SPDX `_ license expression for the API. - - The ``identifier`` field is mutually exclusive of the ``url`` field. - """ - - url: str | None = None - """A URL to the license used for the API. - - This MUST be in the form of a URL. The ``url`` field is mutually exclusive of the ``identifier`` field. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/link.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/link.py deleted file mode 100644 index 78c4f85..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/link.py +++ /dev/null @@ -1,66 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.server import Server - -__all__ = ("Link",) - - -@dataclass -class Link(BaseSchemaObject): - """The ``Link object`` represents a possible design-time link for a response. The presence of a link does not - guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal - mechanism between responses and other operations. - - Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require - link information in the runtime response. - - For computing links, and providing instructions to execute them, a - `runtime expression `_ is used for accessing values in an - operation and using them as parameters while invoking the linked operation. - """ - - operation_ref: str | None = None - """A relative or absolute URI reference to an OAS operation. - - This field is mutually exclusive of the ``operationId`` field, and MUST point to an - `Operation Object `_. Relative ``operationRef`` values MAY be - used to locate an existing `Operation Object `_ in the OpenAPI - definition. See the rules for resolving - `Relative References `_ - """ - - operation_id: str | None = None - """The name of an _existing_, resolvable OAS operation, as defined with a unique ``operationId``. - - This field is mutually exclusive of the ``operationRef`` field. - """ - - parameters: dict[str, Any] | None = None - """A map representing parameters to pass to an operation as specified with ``operationId`` or identified via - ``operationRef``. The key is the parameter name to be used, whereas the value can be a constant or an expression to - be evaluated and passed to the linked operation. - - The parameter name can be qualified using the - `parameter location `_ ``[{in}.]{name}`` for operations that use - the same parameter name in different locations (e.g. path.id). - """ - - request_body: Any | None = None - """A literal value or - `{expression} `_ to use as a request body when calling the - target operation.""" - - description: str | None = None - """A description of the link. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - server: Server | None = None - """A server object to be used by the target operation.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/media_type.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/media_type.py deleted file mode 100644 index 3e83fb5..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/media_type.py +++ /dev/null @@ -1,51 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.encoding import Encoding - from litestar.openapi.spec.example import Example - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.schema import Schema - -__all__ = ("OpenAPIMediaType",) - - -@dataclass -class OpenAPIMediaType(BaseSchemaObject): - """Each Media Type Object provides schema and examples for the media type identified by its key.""" - - schema: Reference | Schema | None = None - """The schema defining the content of the request, response, or parameter.""" - - example: Any | None = None - """Example of the media type. - - The example object SHOULD be in the correct format as specified by the media type. - - The ``example`` field is mutually exclusive of the ``examples`` field. - - Furthermore, if referencing a ``schema`` which contains an example, the ``example`` value SHALL _override_ the - example provided by the schema. - """ - - examples: dict[str, Example | Reference] | None = None - """Examples of the media type. - - Each example object SHOULD match the media type and specified schema if present. - - The ``examples`` field is mutually exclusive of the ``example`` field. - - Furthermore, if referencing a ``schema`` which contains an example, the ``examples`` value SHALL _override_ the - example provided by the schema. - """ - - encoding: dict[str, Encoding] | None = None - """A map between a property name and its encoding information. - - The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to - ``requestBody`` objects when the media type is ``multipart`` or ``application/x-www-form-urlencoded``. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flow.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flow.py deleted file mode 100644 index c322efc..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flow.py +++ /dev/null @@ -1,36 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("OAuthFlow",) - - -@dataclass -class OAuthFlow(BaseSchemaObject): - """Configuration details for a supported OAuth Flow.""" - - authorization_url: str | None = None - """ - **REQUIRED** for ``oauth2`` ("implicit", "authorizationCode"). The authorization URL to be used for this flow. This - MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. - """ - - token_url: str | None = None - """ - **REQUIRED** for ``oauth2`` ("password", "clientCredentials", "authorizationCode"). The token URL to be used for - this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. - """ - - refresh_url: str | None = None - """The URL to be used for obtaining refresh tokens. - - This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. - """ - - scopes: dict[str, str] | None = None - """ - **REQUIRED** for ``oauth2``. The available scopes for the OAuth2 security scheme. A map between the scope name and a - short description for it the map MAY be empty. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flows.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flows.py deleted file mode 100644 index 920d095..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/oauth_flows.py +++ /dev/null @@ -1,28 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.oauth_flow import OAuthFlow - -__all__ = ("OAuthFlows",) - - -@dataclass -class OAuthFlows(BaseSchemaObject): - """Allows configuration of the supported OAuth Flows.""" - - implicit: OAuthFlow | None = None - """Configuration for the OAuth Implicit flow.""" - - password: OAuthFlow | None = None - """Configuration for the OAuth Resource Owner Password flow.""" - - client_credentials: OAuthFlow | None = None - """Configuration for the OAuth Client Credentials flow. Previously called ``application`` in OpenAPI 2.0.""" - - authorization_code: OAuthFlow | None = None - """Configuration for the OAuth Authorization Code flow. Previously called ``accessCode`` in OpenAPI 2.0.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/open_api.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/open_api.py deleted file mode 100644 index 55465fa..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/open_api.py +++ /dev/null @@ -1,87 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject -from litestar.openapi.spec.components import Components -from litestar.openapi.spec.server import Server - -if TYPE_CHECKING: - from litestar.openapi.spec.external_documentation import ExternalDocumentation - from litestar.openapi.spec.info import Info - from litestar.openapi.spec.path_item import PathItem - from litestar.openapi.spec.paths import Paths - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.security_requirement import SecurityRequirement - from litestar.openapi.spec.tag import Tag - -__all__ = ("OpenAPI",) - - -@dataclass -class OpenAPI(BaseSchemaObject): - """Root OpenAPI document.""" - - info: Info - """ - **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. - """ - - openapi: str = "3.1.0" - """ - **REQUIRED**. This string MUST be the - `version number `_ of the OpenAPI Specification that the OpenAPI - document uses. The ``openapi`` field SHOULD be used by tooling to interpret the OpenAPI document. This is *not* - related to the API `info.version `_ string. - """ - - json_schema_dialect: str | None = None - """The default value for the ``$schema`` keyword within - `Schema Objects `_ contained within this OAS document. - - This MUST be in the form of a URI. - """ - - servers: list[Server] = field(default_factory=lambda x: [Server(url="/")]) # type: ignore[misc, arg-type] - """An array of Server Objects, which provide connectivity information to a target server. - - If the ``servers`` property is not provided, or is an empty array, the default value would be a - `Server Object `_ with a - `url `_ value of ``/``. - """ - - paths: Paths | None = None - """The available paths and operations for the API.""" - - webhooks: dict[str, PathItem | Reference] | None = None - """The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. - - Closely related to the ``callbacks`` feature, this section describes requests initiated other than by an API call, - for example by an out of band registration. The key name is a unique string to refer to each webhook, while the - (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the - expected responses. An - `example `_ is available. - """ - - components: Components = field(default_factory=Components) - """An element to hold various schemas for the document.""" - - security: list[SecurityRequirement] | None = None - """A declaration of which security mechanisms can be used across the API. - - The list of values includes alternative security requirement objects that can be used. Only one of the security - requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. - To make security optional, an empty security requirement ( ``{}`` ) can be included in the array. - """ - - tags: list[Tag] | None = None - """A list of tags used by the document with additional metadata. - - The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the - `Operation Object `_ must be declared. The tags that are not - declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. - """ - - external_docs: ExternalDocumentation | None = None - """Additional external documentation.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/operation.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/operation.py deleted file mode 100644 index ab80181..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/operation.py +++ /dev/null @@ -1,105 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.callback import Callback - from litestar.openapi.spec.external_documentation import ExternalDocumentation - from litestar.openapi.spec.parameter import Parameter - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.request_body import RequestBody - from litestar.openapi.spec.responses import Responses - from litestar.openapi.spec.security_requirement import SecurityRequirement - from litestar.openapi.spec.server import Server - -__all__ = ("Operation",) - - -@dataclass -class Operation(BaseSchemaObject): - """Describes a single API operation on a path.""" - - tags: list[str] | None = None - """A list of tags for API documentation control. - - Tags can be used for logical grouping of operations by resources or any other qualifier. - """ - - summary: str | None = None - """A short summary of what the operation does.""" - - description: str | None = None - """A verbose explanation of the operation behavior. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - external_docs: ExternalDocumentation | None = None - """Additional external documentation for this operation.""" - - operation_id: str | None = None - """Unique string used to identify the operation. - - The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools - and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow - common programming naming conventions. - """ - - parameters: list[Parameter | Reference] | None = None - """A list of parameters that are applicable for this operation. - - If a parameter is already defined at the `Path Item `_, - the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A - unique parameter is defined by a combination of a `name `_ and - `location `_. The list can use the - `Reference Object `_ to link to parameters that are defined at - the `OpenAPI Object's components/parameters `_. - """ - - request_body: RequestBody | Reference | None = None - """The request body applicable for this operation. - - The ``requestBody`` is fully supported in HTTP methods where the HTTP 1.1 specification - :rfc:`7231` has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such - as `GET `_, - `HEAD `_ and - `DELETE `_, ``requestBody`` is permitted but does not have - well-defined semantics and SHOULD be avoided if possible. - """ - - responses: Responses | None = None - """The list of possible responses as they are returned from executing this operation.""" - - callbacks: dict[str, Callback | Reference] | None = None - """A map of possible out-of band callbacks related to the parent operation. - - The key is a unique identifier for the Callback Object. Each value in the map is a - `Callback Object `_ that describes a request that may be - initiated by the API provider and the expected responses. - """ - - deprecated: bool = False - """Declares this operation to be deprecated. - - Consumers SHOULD refrain from usage of the declared operation. Default value is ``False``. - """ - - security: list[SecurityRequirement] | None = None - """A declaration of which security mechanisms can be used for this operation. - - The list of values includes alternative security requirement objects that can be used. Only one of the security - requirement objects need to be satisfied to authorize a request. To make security optional, an empty security - requirement (``{}``) can be included in the array. This definition overrides any declared top-level - `security `_. To remove a top-level security declaration, an empty - array can be used. - """ - - servers: list[Server] | None = None - """An alternative ``server`` array to service this operation. - - If an alternative ``server`` object is specified at the Path Item Object or Root level, it will be overridden by - this value. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/parameter.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/parameter.py deleted file mode 100644 index 74a100f..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/parameter.py +++ /dev/null @@ -1,136 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any, Mapping - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.example import Example - from litestar.openapi.spec.media_type import OpenAPIMediaType - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.schema import Schema - -__all__ = ("Parameter",) - - -@dataclass -class Parameter(BaseSchemaObject): - """Describes a single operation parameter. - - A unique parameter is defined by a combination of a `name `_ and - `location `_. - """ - - name: str - """ - **REQUIRED**. The name of the parameter. - Parameter names are *case sensitive*. - - - If `in `_ is ``"path"``, the ``name`` field MUST correspond to a - template expression occurring within the `path `_ field in the - `Paths Object `_. See - `Path Templating `_ for further information. - - If `in `_ is ``"header"`` and the ``name`` field is - ``"Accept"``, ``"Content-Type"`` or ``"Authorization"``, the parameter definition SHALL be ignored. - - For all other cases, the ``name`` corresponds to the parameter name used by the - `in `_ property. - """ - - param_in: str - """ - **REQUIRED**. The location of the parameter. Possible values are - ``"query"``, ``"header"``, ``"path"`` or ``"cookie"``. - """ - - schema: Schema | Reference | None = None - """The schema defining the type used for the parameter.""" - - description: str | None = None - """A brief description of the parameter. This could contain examples of - use. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - required: bool = False - """Determines whether this parameter is mandatory. - - If the `parameter location `_ is ``"path"``, this property is - **REQUIRED** and its value MUST be ``True``. Otherwise, the property MAY be included and its default value is - ``False``. - """ - - deprecated: bool = False - """Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - - Default value is ``False``. - """ - - allow_empty_value: bool = False - """Sets the ability to pass empty-valued parameters. This is valid only for ``query`` parameters and allows sending - a parameter with an empty value. Default value is ``False``. If - `style `__ is used, and if behavior is ``n/a`` (cannot be - serialized), the value of ``allowEmptyValue`` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is - likely to be removed in a later revision. - - The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a - `schema `_ and - `style `__ can describe the structure and syntax of the - parameter. - """ - - style: str | None = None - """Describes how the parameter value will be serialized depending on the ype of the parameter value. Default values - (based on value of ``in``): - - - for ``query`` - ``form`` - - for ``path`` - ``simple`` - - for ``header`` - ``simple`` - - for ``cookie`` - ``form`` - """ - - explode: bool | None = None - """When this is true, parameter values of type ``array`` or ``object`` generate separate parameters for each value - of the array or key-value pair of the map. - - For other types of parameters this property has no effect. When - `style `__ is ``form``, the default value is ``True``. For all - other styles, the default value is ``False``. - """ - - allow_reserved: bool = False - """Determines whether the parameter value SHOULD allow reserved characters, as defined by. - - :rfc:`3986` ``:/?#[]@!$&'()*+,;=`` to be included without percent-encoding. - - This property only applies to parameters with an ``in`` value of ``query``. The default value is ``False``. - """ - - example: Any | None = None - """Example of the parameter's potential value. - - The example SHOULD match the specified schema and encoding properties if present. The ``example`` field is mutually - exclusive of the ``examples`` field. Furthermore, if referencing a ``schema`` that contains an example, the - ``example`` value SHALL _override_ the example provided by the schema. To represent examples of media types that - cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where - necessary. - """ - - examples: Mapping[str, Example | Reference] | None = None - """Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as - specified in the parameter encoding. The ``examples`` field is mutually exclusive of the ``example`` field. - Furthermore, if referencing a ``schema`` that contains an example, the ``examples`` value SHALL _override_ the - example provided by the schema. - - For more complex scenarios, the `content `_ property can - define the media type and schema of the parameter. A parameter MUST contain either a ``schema`` property, or a - ``content`` property, but not both. When ``example`` or ``examples`` are provided in conjunction with the - ``schema`` object, the example MUST follow the prescribed serialization strategy for the parameter. - """ - - content: dict[str, OpenAPIMediaType] | None = None - """A map containing the representations for the parameter. - - The key is the media type and the value describes it. The map MUST only contain one entry. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/path_item.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/path_item.py deleted file mode 100644 index 17005c5..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/path_item.py +++ /dev/null @@ -1,78 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.operation import Operation - from litestar.openapi.spec.parameter import Parameter - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.server import Server - -__all__ = ("PathItem",) - - -@dataclass -class PathItem(BaseSchemaObject): - """Describes the operations available on a single path. - - A Path Item MAY be empty, due to `ACL constraints `_. The - path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are - available. - """ - - ref: str | None = None - """Allows for an external definition of this path item. The referenced structure MUST be in the format of a - `Path Item Object `. - - In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is - undefined. See the rules for resolving - `Relative References `_. - """ - - summary: str | None = None - """An optional, string summary, intended to apply to all operations in this path.""" - - description: str | None = None - """An optional, string description, intended to apply to all operations in this path. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - get: Operation | None = None - """A definition of a GET operation on this path.""" - - put: Operation | None = None - """A definition of a PUT operation on this path.""" - - post: Operation | None = None - """A definition of a POST operation on this path.""" - - delete: Operation | None = None - """A definition of a DELETE operation on this path.""" - - options: Operation | None = None - """A definition of a OPTIONS operation on this path.""" - - head: Operation | None = None - """A definition of a HEAD operation on this path.""" - - patch: Operation | None = None - """A definition of a PATCH operation on this path.""" - - trace: Operation | None = None - """A definition of a TRACE operation on this path.""" - - servers: list[Server] | None = None - """An alternative ``server`` array to service all operations in this path.""" - - parameters: list[Parameter | Reference] | None = None - """A list of parameters that are applicable for all the operations described under this path. These parameters can - be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. - A unique parameter is defined by a combination of a `name `_ and - `location `_. The list can use the - `Reference Object `_ to link to parameters that are defined at - the `OpenAPI Object's components/parameters `_. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/paths.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/paths.py deleted file mode 100644 index 682664e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/paths.py +++ /dev/null @@ -1,27 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Dict - -if TYPE_CHECKING: - from litestar.openapi.spec import PathItem - -Paths = Dict[str, "PathItem"] -"""Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the. - -`Server Object `_ in order to construct the full URL. - -The Paths MAY be empty, due to -`Access Control List (ACL) constraints `_. - -Patterned Fields - -/{path}: PathItem - -A relative path to an individual endpoint. The field name MUST begin with a forward slash (``/``). The path is -**appended** (no relative URL resolution) to the expanded URL from the -`Server Object `_ 's ``url`` field in order to construct the full -URL. `Path templating `_ is allowed. When matching URLs, concrete -(non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but -different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to -decide which one to use. -""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py deleted file mode 100644 index 5ee2a95..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py +++ /dev/null @@ -1,38 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("Reference",) - - -@dataclass -class Reference(BaseSchemaObject): - """A simple object to allow referencing other components in the OpenAPI document, internally and externally. - - The ``$ref`` string value contains a URI `RFC3986 `_ , which identifies the - location of the value being referenced. - - See the rules for resolving `Relative References `_. - """ - - ref: str - """**REQUIRED**. The reference identifier. This MUST be in the form of a URI.""" - - summary: str | None = None - """A short summary which by default SHOULD override that of the referenced component. - - If the referenced object-type does not allow a ``summary`` field, then this field has no effect. - """ - - description: str | None = None - """A description which by default SHOULD override that of the referenced component. - - `CommonMark syntax `_ MAY be used for rich text representation. If the referenced - object-type does not allow a ``description`` field, then this field has no effect. - """ - - @property - def value(self) -> str: - return self.ref.split("/")[-1] diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/request_body.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/request_body.py deleted file mode 100644 index 5e4e195..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/request_body.py +++ /dev/null @@ -1,38 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.media_type import OpenAPIMediaType - -__all__ = ("RequestBody",) - - -@dataclass -class RequestBody(BaseSchemaObject): - """Describes a single request body.""" - - content: dict[str, OpenAPIMediaType] - """ - **REQUIRED**. The content of the request body. - The key is a media type or `media type range `_ and the value - describes it. - - For requests that match multiple keys, only the most specific key is applicable. e.g. ``text/plain`` overrides - ``text/*`` - """ - - description: str | None = None - """A brief description of the request body. This could contain examples of use. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - required: bool = False - """Determines if the request body is required in the request. - - Defaults to ``False``. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/response.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/response.py deleted file mode 100644 index 236bc40..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/response.py +++ /dev/null @@ -1,48 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.header import OpenAPIHeader - from litestar.openapi.spec.link import Link - from litestar.openapi.spec.media_type import OpenAPIMediaType - from litestar.openapi.spec.reference import Reference - - -__all__ = ("OpenAPIResponse",) - - -@dataclass -class OpenAPIResponse(BaseSchemaObject): - """Describes a single response from an API Operation, including design-time, static ``links`` to operations based on - the response. - """ - - description: str - """**REQUIRED**. A short description of the response. - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - headers: dict[str, OpenAPIHeader | Reference] | None = None - """Maps a header name to its definition. - `RFC7230 `_ states header names are case insensitive. - If a response header is defined with the name ``Content-Type``, it SHALL be ignored. - """ - - content: dict[str, OpenAPIMediaType] | None = None - """A map containing descriptions of potential response payloads. The key is a media type or - `media type range `_ and the value describes it. - - For responses that match multiple keys, only the most specific key is applicable. e.g. ``text/plain`` overrides - ``text/*`` - """ - - links: dict[str, Link | Reference] | None = None - """A map of operations links that can be followed from the response. - - The key of the map is a short name for the link, following the naming constraints of the names for - `Component Objects `_. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/responses.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/responses.py deleted file mode 100644 index 0cff680..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/responses.py +++ /dev/null @@ -1,44 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Dict, Union - -if TYPE_CHECKING: - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.response import OpenAPIResponse - -Responses = Dict[str, Union["OpenAPIResponse", "Reference"]] -"""A container for the expected responses of an operation. The container maps a -HTTP response code to the expected response. - -The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in -advance. However, documentation is expected to cover a successful operation response and any known errors. - -The ``default`` MAY be used as a default response object for all HTTP codes hat are not covered individually by the -specification. - -The ``Responses Object`` MUST contain at least one response code, and it SHOULD be the response for a successful -operation call. - -Fixed Fields - -default: ``Optional[Union[Response, Reference]]`` - -The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover -undeclared responses. A `Reference Object `_ can link to a -response that the `OpenAPI Object's components/responses `_ -section defines. - -Patterned Fields -{httpStatusCode}: ``Optional[Union[Response, Reference]]`` - -Any `HTTP status code `_ can be used as the property name, but only one -property per code, to describe the expected response for that HTTP status code. - -A `Reference Object `_ can link to a response that is defined in -the `OpenAPI Object's components/responses `_ section. This -field MUST be enclosed in quotation marks (for example, ``200``) for compatibility between JSON and YAML. To define a -range of response codes, this field MAY contain the uppercase wildcard character ``X``. For example, ``2XX`` represents -all response codes between ``[200-299]``. Only the following range definitions are allowed: ``1XX``, ``2XX``, ``3XX``, -``4XX``, and ``5XX``. If a response is defined using an explicit code, the explicit code definition takes precedence -over the range definition for that code. -""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/schema.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/schema.py deleted file mode 100644 index 4be2b7c..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/schema.py +++ /dev/null @@ -1,652 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, fields, is_dataclass -from typing import TYPE_CHECKING, Any, Hashable, Mapping, Sequence - -from litestar.openapi.spec.base import BaseSchemaObject -from litestar.utils.predicates import is_non_string_sequence - -if TYPE_CHECKING: - from litestar.openapi.spec.discriminator import Discriminator - from litestar.openapi.spec.enums import OpenAPIFormat, OpenAPIType - from litestar.openapi.spec.external_documentation import ExternalDocumentation - from litestar.openapi.spec.reference import Reference - from litestar.openapi.spec.xml import XML - from litestar.types import DataclassProtocol - -__all__ = ("Schema", "SchemaDataContainer") - - -def _recursive_hash(value: Hashable | Sequence | Mapping | DataclassProtocol | type[DataclassProtocol]) -> int: - if isinstance(value, Mapping): - hash_value = 0 - for k, v in value.items(): - if k != "examples": - hash_value += hash(k) - hash_value += _recursive_hash(v) - return hash_value - if is_dataclass(value): - hash_value = hash(type(value).__name__) - for field in fields(value): - if field.name != "examples": - hash_value += hash(field.name) - hash_value += _recursive_hash(getattr(value, field.name, None)) - return hash_value - if is_non_string_sequence(value): - return sum(_recursive_hash(v) for v in value) - return hash(value) if isinstance(value, Hashable) else 0 - - -@dataclass -class Schema(BaseSchemaObject): - """The Schema Object allows the definition of input and output data types. These types can be objects, but also - primitives and arrays. This object is a superset of the - `JSON Schema Specification Draft 2020-12 `_. - - For more information about the properties, see - `JSON Schema Core `_ and - `JSON Schema Validation `_. - - Unless stated otherwise, the property definitions follow those of JSON Schema and do not add any additional - semantics. Where JSON Schema indicates that behavior is defined by the application (e.g. for annotations), OAS also - defers the definition of semantics to the application consuming the OpenAPI document. - - The following properties are taken directly from the - `JSON Schema Core `_ and follow the same specifications. - """ - - all_of: Sequence[Reference | Schema] | None = None - """This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. - - An instance validates successfully against this keyword if it validates successfully against all schemas defined by - this keyword's value. - """ - - any_of: Sequence[Reference | Schema] | None = None - """This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. - - An instance validates successfully against this keyword if it validates successfully against at least one schema - defined by this keyword's value. Note that when annotations are being collected, all subschemas MUST be examined so - that annotations are collected from each subschema that validates successfully. - """ - - one_of: Sequence[Reference | Schema] | None = None - """This keyword's value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema. - - An instance validates successfully against this keyword if it validates successfully against exactly one schema - defined by this keyword's value. - """ - - schema_not: Reference | Schema | None = None - """This keyword's value MUST be a valid JSON Schema. - - An instance is valid against this keyword if it fails to validate successfully against the schema defined by this - keyword. - """ - - schema_if: Reference | Schema | None = None - """This keyword's value MUST be a valid JSON Schema. - - This validation outcome of this keyword's subschema has no direct effect on the overall validation result. Rather, - it controls which of the "then" or "else" keywords are evaluated. - - Instances that successfully validate against this keyword's subschema MUST also be valid against the subschema - value of the "then" keyword, if present. - - Instances that fail to validate against this keyword's subschema MUST also be valid against the subschema value of - the "else" keyword, if present. - - If annotations (Section 7.7) are being collected, they are collected rom this keyword's subschema in the usual way, - including when the keyword is present without either "then" or "else". - """ - - then: Reference | Schema | None = None - """This keyword's value MUST be a valid JSON Schema. - - When "if" is present, and the instance successfully validates against its subschema, then validation succeeds - against this keyword if the instance also successfully validates against this keyword's subschema. - - This keyword has no effect when "if" is absent, or when the instance fails to validate against its subschema. - Implementations MUST NOT evaluate the instance against this keyword, for either validation or annotation collection - purposes, in such cases. - """ - - schema_else: Reference | Schema | None = None - """This keyword's value MUST be a valid JSON Schema. - - When "if" is present, and the instance fails to validate against its subschema, then validation succeeds against - this keyword if the instance successfully validates against this keyword's subschema. - - This keyword has no effect when "if" is absent, or when the instance successfully validates against its subschema. - Implementations MUST NOT evaluate the instance against this keyword, for either validation or annotation collection - purposes, in such cases. - """ - - dependent_schemas: dict[str, Reference | Schema] | None = None - """This keyword specifies subschemas that are evaluated if the instance is - an object and contains a certain property. - - This keyword's value MUST be an object. Each value in the object MUST be a valid JSON Schema. - - If the object key is a property in the instance, the entire instance must validate against the subschema. Its use is - dependent on the presence of the property. - - Omitting this keyword has the same behavior as an empty object. - """ - - prefix_items: Sequence[Reference | Schema] | None = None - """The value of "prefixItems" MUST be a non-empty array of valid JSON Schemas. - - Validation succeeds if each element of the instance validates against the schema at the same position, if any. - This keyword does not constrain the length of the array. If the array is longer than this keyword's value, this - keyword validates only the prefix of matching length. - - This keyword produces an annotation value which is the largest index to which this keyword applied a subschema. - he value MAY be a boolean true if a subschema was applied to every index of the instance, such as is produced by the - "items" keyword. This annotation affects the behavior of "items" and "unevaluatedItems". - - Omitting this keyword has the same assertion behavior as an empty array. - """ - - items: Reference | Schema | None = None - """The value of "items" MUST be a valid JSON Schema. - - This keyword applies its subschema to all instance elements at indexes greater than the length of the "prefixItems" - array in the same schema object, as reported by the annotation result of that "prefixItems" keyword. If no such - annotation result exists, "items" applies its subschema to all instance array elements. [[CREF11: Note that the - behavior of "items" without "prefixItems" is identical to that of the schema form of "items" in prior drafts. When - "prefixItems" is present, the behavior of "items" is identical to the former "additionalItems" keyword. ]] - - If the "items" subschema is applied to any positions within the instance array, it produces an annotation result of - boolean true, indicating that all remaining array elements have been evaluated against this keyword's subschema. - - Omitting this keyword has the same assertion behavior as an empty schema. - - Implementations MAY choose to implement or optimize this keyword in another way that produces the same effect, such - as by directly checking for the presence and size of a "prefixItems" array. Implementations that do not support - annotation collection MUST do so. - """ - - contains: Reference | Schema | None = None - """The value of this keyword MUST be a valid JSON Schema. - - An array instance is valid against "contains" if at least one of its elements is valid against the given schema. - The subschema MUST be applied to every array element even after the first match has been found, in order to collect - annotations for use by other keywords. This is to ensure that all possible annotations are collected. - - Logically, the validation result of applying the value subschema to each item in the array MUST be ORed with - "false", resulting in an overall validation result. - - This keyword produces an annotation value which is an array of the indexes to which this keyword validates - successfully when applying its subschema, in ascending order. The value MAY be a boolean "true" if the subschema - validates successfully when applied to every index of the instance. The annotation MUST be present if the instance - array to which this keyword's schema applies is empty. - """ - - properties: dict[str, Reference | Schema] | None = None - """The value of "properties" MUST be an object. Each value of this object MUST be a valid JSON Schema. - - Validation succeeds if, for each name that appears in both the instance and as a name within this keyword's value, - the child instance for that name successfully validates against the corresponding schema. - - The annotation result of this keyword is the set of instance property names matched by this keyword. - - Omitting this keyword has the same assertion behavior as an empty object. - """ - - pattern_properties: dict[str, Reference | Schema] | None = None - """The value of "patternProperties" MUST be an object. Each property name of this object SHOULD be a valid - regular expression, according to the ECMA-262 regular expression dialect. Each property value of this object - MUST be a valid JSON Schema. - - Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name - in this keyword's value, the child instance for that name successfully validates against each schema that - corresponds to a matching regular expression. - - The annotation result of this keyword is the set of instance property names matched by this keyword. - - Omitting this keyword has the same assertion behavior as an empty object. - """ - - additional_properties: Reference | Schema | bool | None = None - """The value of "additionalProperties" MUST be a valid JSON Schema. - - The behavior of this keyword depends on the presence and annotation results of "properties" and "patternProperties" - within the same schema object. Validation with "additionalProperties" applies only to the child values of instance - names that do not appear in the annotation results of either "properties" or "patternProperties". - - For all such properties, validation succeeds if the child instance validates against the "additionalProperties" - schema. - - The annotation result of this keyword is the set of instance property names validated by this keyword's subschema. - - Omitting this keyword has the same assertion behavior as an empty schema. - - Implementations MAY choose to implement or optimize this keyword in another way that produces the same effect, such - as by directly checking the names in "properties" and the patterns in "patternProperties" against the instance - property set. Implementations that do not support annotation collection MUST do so. - """ - - property_names: Reference | Schema | None = None - """The value of "propertyNames" MUST be a valid JSON Schema. - - If the instance is an object, this keyword validates if every property name in the instance validates against the - provided schema. Note the property name that the schema is testing will always be a string. - - Omitting this keyword has the same behavior as an empty schema. - """ - - unevaluated_items: Reference | Schema | None = None - """The value of "unevaluatedItems" MUST be a valid JSON Schema. - - The behavior of this keyword depends on the annotation results of adjacent keywords that apply to the instance - location being validated. Specifically, the annotations from "prefixItems" items", and "contains", which can come - from those keywords when they are adjacent to the "unevaluatedItems" keyword. Those three annotations, as well as - "unevaluatedItems", can also result from any and all adjacent in-place applicator (Section 10.2) keywords. This - includes but is not limited to the in-place applicators defined in this document. - - If no relevant annotations are present, the "unevaluatedItems" subschema MUST be applied to all locations in the - array. If a boolean true value is present from any of the relevant annotations, unevaluatedItems" MUST be ignored. - Otherwise, the subschema MUST be applied to any index greater than the largest annotation value for "prefixItems", - which does not appear in any annotation value for - "contains". - - This means that "prefixItems", "items", "contains", and all in-place applicators MUST be evaluated before this - keyword can be evaluated. Authors of extension keywords MUST NOT define an in-place applicator that would need to be - evaluated after this keyword. - - If the "unevaluatedItems" subschema is applied to any positions within the instance array, it produces an annotation - result of boolean true, analogous to the behavior of "items". - - Omitting this keyword has the same assertion behavior as an empty schema. - """ - - unevaluated_properties: Reference | Schema | None = None - """The value of "unevaluatedProperties" MUST be a valid JSON Schema. - - The behavior of this keyword depends on the annotation results of adjacent keywords that apply to the instance - location being validated. Specifically, the annotations from "properties", "patternProperties", and - "additionalProperties", which can come from those keywords when they are adjacent to the "unevaluatedProperties" - keyword. Those three annotations, as well as "unevaluatedProperties", can also result from any and all adjacent - in-place applicator (Section 10.2) keywords. This includes but is not limited to the in-place applicators defined - in this document. - - Validation with "unevaluatedProperties" applies only to the child values of instance names that do not appear in - the "properties", "patternProperties", "additionalProperties", or "unevaluatedProperties" annotation results that - apply to the instance location being validated. - - For all such properties, validation succeeds if the child instance validates against the "unevaluatedProperties" - schema. - - This means that "properties", "patternProperties", "additionalProperties", and all in-place applicators MUST be - evaluated before this keyword can be evaluated. Authors of extension keywords MUST NOT define an in-place - applicator that would need to be evaluated after this keyword. - - The annotation result of this keyword is the set of instance property names validated by this keyword's subschema. - - Omitting this keyword has the same assertion behavior as an empty schema. - - The following properties are taken directly from the - `JSON Schema Validation `_ and follow the same - specifications: - """ - - type: OpenAPIType | Sequence[OpenAPIType] | None = None - """The value of this keyword MUST be either a string or an array. If it is an array, elements of the array MUST be - strings and MUST be unique. - - String values MUST be one of the six primitive types (``"null"``, ``"boolean"``, ``"object"``, ``"array"``, - ``"number"``, and ``"string"``), or ``"integer"`` which matches any number with a zero fractional part. - - An instance validates if and only if the instance is in any of the sets listed for this keyword. - """ - - enum: Sequence[Any] | None = None - """The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array - SHOULD be unique. - - An instance validates successfully against this keyword if its value is equal to one of the elements in this - keyword's array value. - - Elements in the array might be of any type, including null. - """ - - const: Any | None = None - """The value of this keyword MAY be of any type, including null. - - Use of this keyword is functionally equivalent to an "enum" (Section 6.1.2) with a single value. - - An instance validates successfully against this keyword if its value is equal to the value of the keyword. - """ - - multiple_of: float | None = None - """The value of "multipleOf" MUST be a number, strictly greater than 0. - - A numeric instance is only valid if division by this keyword's value results in an integer. - """ - - maximum: float | None = None - """The value of "maximum" MUST be a number, representing an inclusive upper limit for a numeric instance. - - If the instance is a number, then this keyword validates only if the instance is less than or exactly equal to - "maximum". - """ - - exclusive_maximum: float | None = None - """The value of "exclusiveMaximum" MUST be a number, representing an exclusive upper limit for a numeric instance. - - If the instance is a number, then the instance is valid only if it has a value strictly less than (not equal to) - "exclusiveMaximum". - """ - - minimum: float | None = None - """The value of "minimum" MUST be a number, representing an inclusive lower limit for a numeric instance. - - If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to - "minimum". - """ - - exclusive_minimum: float | None = None - """The value of "exclusiveMinimum" MUST be a number, representing an exclusive lower limit for a numeric instance. - - If the instance is a number, then the instance is valid only if it has a value strictly greater than (not equal to) - "exclusiveMinimum". - """ - - max_length: int | None = None - """The value of this keyword MUST be a non-negative integer. - - A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword. - - The length of a string instance is defined as the number of its characters as defined by :rfc:`8259`. - """ - - min_length: int | None = None - """The value of this keyword MUST be a non-negative integer. - - A string instance is valid against this keyword if its length is greater than, or equal to, the value of this - keyword. - - The length of a string instance is defined as the number of its characters as defined by :rfc:`8259`. - - Omitting this keyword has the same behavior as a value of 0. - """ - - pattern: str | None = None - """The value of this keyword MUST be a string. This string SHOULD be a valid regular expression, according to the - ECMA-262 regular expression dialect. - - A string instance is considered valid if the regular expression matches the instance successfully. Recall: regular - expressions are not implicitly anchored. - """ - - max_items: int | None = None - """The value of this keyword MUST be a non-negative integer. - - An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword. - """ - - min_items: int | None = None - """The value of this keyword MUST be a non-negative integer. - - An array instance is valid against "minItems" if its size is greater than, or equal to, the value of this keyword. - - Omitting this keyword has the same behavior as a value of 0. - """ - - unique_items: bool | None = None - """The value of this keyword MUST be a boolean. - - If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the - instance validates successfully if all of its elements are unique. - - Omitting this keyword has the same behavior as a value of false. - """ - - max_contains: int | None = None - """The value of this keyword MUST be a non-negative integer. - - If "contains" is not present within the same schema object, then this keyword has no effect. - - An instance array is valid against "maxContains" in two ways, depending on the form of the annotation result of an - adjacent "contains" [json-schema] keyword. The first way is if the annotation result is an array and the length of - that array is less than or equal to the "maxContains" value. The second way is if the annotation result is a - boolean "true" and the instance array length is less than r equal to the "maxContains" value. - """ - - min_contains: int | None = None - """The value of this keyword MUST be a non-negative integer. - - If "contains" is not present within the same schema object, then this keyword has no effect. - - An instance array is valid against "minContains" in two ways, depending on the form of the annotation result of an - adjacent "contains" [json-schema] keyword. The first way is if the annotation result is an array and the length of - that array is greater than or equal to the "minContains" value. The second way is if the annotation result is a - boolean "true" and the instance array length is greater than or equal to the "minContains" value. - - A value of 0 is allowed, but is only useful for setting a range of occurrences from 0 to the value of "maxContains". - A value of 0 with no "maxContains" causes "contains" to always pass validation. - - Omitting this keyword has the same behavior as a value of 1. - """ - - max_properties: int | None = None - """The value of this keyword MUST be a non-negative integer. - - An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value - of this keyword. - """ - - min_properties: int | None = None - """The value of this keyword MUST be a non-negative integer. - - An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the - value of this keyword. - - Omitting this keyword has the same behavior as a value of 0. - """ - - required: Sequence[str] | None = None - """The value of this keyword MUST be an array. Elements of this array, if any, MUST be strings, and MUST be unique. - - An object instance is valid against this keyword if every item in the rray is the name of a property in the instance. - - Omitting this keyword has the same behavior as an empty array. - """ - - dependent_required: dict[str, Sequence[str]] | None = None - """The value of this keyword MUST be an object. Properties in this object, f any, MUST be arrays. Elements in each - array, if any, MUST be strings, and MUST be unique. - - This keyword specifies properties that are required if a specific other property is present. Their requirement is - dependent on the presence of the other property. - - Validation succeeds if, for each name that appears in both the instance and as a name within this keyword's value, - every item in the corresponding array is also the name of a property in the instance. - - Omitting this keyword has the same behavior as an empty object. - """ - - format: OpenAPIFormat | None = None - """From OpenAPI: - - See `Data Type Formats `_ for further details. While relying on - JSON Schema's defined formats, the OAS offers a few additional predefined formats. - - From JSON Schema: - - Structural validation alone may be insufficient to allow an application to correctly utilize certain values. - The "format" annotation keyword is defined to allow schema authors to convey semantic information for a fixed subset - of values which are accurately described by authoritative resources, be they RFCs or other external specifications. - - The value of this keyword is called a format attribute. It MUST be a string. A format attribute can generally only - validate a given set of instance types. If the type of the instance to validate is not in this set, validation for - this format attribute and instance SHOULD succeed. All format attributes defined in this section apply to strings, - but a format attribute can be specified to apply to any instance types defined in the data model defined in the core - JSON Schema. [json-schema] [[CREF1: Note that the "type" keyword in this specification defines an "integer" type - which is not part of the data model. Therefore a format attribute can be limited to numbers, but not specifically to - integers. However, a numeric format can be used alongside the "type" keyword with a value of "integer", or could be - explicitly defined to always pass if the number is not an integer, which produces essentially the same behavior as - only applying to integers. ]] - """ - - content_encoding: str | None = None - """If the instance value is a string, this property defines that the string SHOULD be interpreted as binary data and - decoded using the encoding named by this property. - - Possible values indicating base 16, 32, and 64 encodings with several variations are listed in :rfc:`4648`. - Additionally, sections 6.7 and 6.8 of :rfc:`2045` provide encodings used in MIME. As "base64" is defined in both - RFCs, the definition from :rfc:`4648` SHOULD be assumed unless the string is specifically intended for use in a - MIME context. Note that all of these encodings result in strings consisting only of 7-bit ASCII characters. - therefore, this keyword has no meaning for strings containing characters outside of that range. - - If this keyword is absent, but "contentMediaType" is present, this indicates that the encoding is the identity - encoding, meaning that no transformation was needed in order to represent the content in a UTF-8 string. - """ - - content_media_type: str | None = None - """If the instance is a string, this property indicates the media type of the contents of the string. If - "contentEncoding" is present, this property describes the decoded string. - - The value of this property MUST be a string, which MUST be a media type, as defined by :rfc:`2046` - """ - - content_schema: Reference | Schema | None = None - """If the instance is a string, and if "contentMediaType" is present, this property contains a schema which - describes the structure of the string. - - This keyword MAY be used with any media type that can be mapped into JSON Schema's data model. - - The value of this property MUST be a valid JSON schema. It SHOULD be ignored if "contentMediaType" is not present. - """ - - title: str | None = None - """The value of "title" MUST be a string. - - The title can be used to decorate a user interface with information about the data produced by this user interface. - A title will preferably be short. - """ - - description: str | None = None - """From OpenAPI: - - `CommonMark syntax `_ MAY be used for rich text representation. - - From JSON Schema: - The value "description" MUST be a string. - - The description can be used to decorate a user interface with information about the data produced by this user - interface. A description will provide explanation about the purpose of the instance described by this schema. - """ - - default: Any | None = None - """There are no restrictions placed on the value of this keyword. When multiple occurrences of this keyword are - applicable to a single sub-instance, implementations SHOULD remove duplicates. - - This keyword can be used to supply a default JSON value associated with a particular schema. It is RECOMMENDED that - a default value be valid against the associated schema. - """ - - deprecated: bool | None = None - """The value of this keyword MUST be a boolean. When multiple occurrences of this keyword are applicable to a - single sub-instance, applications SHOULD consider the instance location to be deprecated if any occurrence specifies - a true value. - - If "deprecated" has a value of boolean true, it indicates that applications SHOULD refrain from usage of the - declared property. It MAY mean the property is going to be removed in the future. - - A root schema containing "deprecated" with a value of true indicates that the entire resource being described MAY be - removed in the future. - - The "deprecated" keyword applies to each instance location to which the schema object containing the keyword - successfully applies. This can result in scenarios where every array item or object property is deprecated even - though the containing array or object is not. - - Omitting this keyword has the same behavior as a value of false. - """ - - read_only: bool | None = None - """The value of "readOnly" MUST be a boolean. When multiple occurrences of this keyword are applicable to a single - sub-instance, the resulting behavior SHOULD be as for a true value if any occurrence specifies a true value, and - SHOULD be as for a false value otherwise. - - If "readOnly" has a value of boolean true, it indicates that the value of the instance is managed exclusively by - the owning authority, and attempts by an application to modify the value of this property are expected to be ignored - or rejected by that owning authority. - - An instance document that is marked as "readOnly" for the entire document MAY be ignored if sent to the owning - authority, or MAY result in an error, at the authority's discretion. - - For example, "readOnly" would be used to mark a database-generated serial number as read-only, while "writeOnly" - would be used to mark a password input field. - - This keyword can be used to assist in user interface instance generation. In particular, an application MAY choose - to use a widget that hides input values as they are typed for write-only fields. - - Omitting these keywords has the same behavior as values of false. - """ - - write_only: bool | None = None - """The value of "writeOnly" MUST be a boolean. When multiple occurrences of this keyword are applicable to a - single sub-instance, the resulting behavior SHOULD be as for a true value if any occurrence specifies a true value, - and SHOULD be as for a false value otherwise. - - If "writeOnly" has a value of boolean true, it indicates that the value is never present when the instance is - retrieved from the owning authority. It can be present when sent to the owning authority to update or create the - document (or the resource it represents), but it will not be included in any updated or newly created version of the - instance. - - An instance document that is marked as "writeOnly" for the entire document MAY be returned as a blank document of - some sort, or MAY produce an error upon retrieval, or have the retrieval request ignored, at the authority's - discretion. - - For example, "readOnly" would be used to mark a database-generated serial number as read-only, while "writeOnly" - would be used to mark a password input field. - - This keyword can be used to assist in user interface instance generation. In particular, an application MAY choose - to use a widget that hides input values as they are typed for write-only fields. - - Omitting these keywords has the same behavior as values of false. - """ - - examples: list[Any] | None = None - """The value of this must be an array containing the example values.""" - - discriminator: Discriminator | None = None - """Adds support for polymorphism. - - The discriminator is an object name that is used to differentiate between other schemas which may satisfy the - payload description. See `Composition and Inheritance `_ - for more details. - """ - - xml: XML | None = None - """This MAY be used only on properties schemas. - - It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. - """ - - external_docs: ExternalDocumentation | None = None - """Additional external documentation for this schema.""" - - example: Any | None = None - """A free-form property to include an example of an instance for this schema. To represent examples that cannot be - naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where - necessary. - - Deprecated: The example property has been deprecated in favor of the JSON Schema examples keyword. Use of example is - discouraged, and later versions of this specification may remove it. - """ - - def __hash__(self) -> int: - return _recursive_hash(self) - - -@dataclass -class SchemaDataContainer(Schema): - """Special class that allows using python data containers, e.g. dataclasses or pydantic models, to represent a - schema - """ - - data_container: Any = None - """A data container instance that will be used to generate the schema.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_requirement.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_requirement.py deleted file mode 100644 index e3d1394..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_requirement.py +++ /dev/null @@ -1,30 +0,0 @@ -from __future__ import annotations - -from typing import Dict, List - -SecurityRequirement = Dict[str, List[str]] -"""Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a -security scheme declared in the. - -`Security Schemes `_ under the -`Components Object `_. - -Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to -be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey -security information. - -When a list of Security Requirement Objects is defined on the -`OpenAPI Object `_ or -`Operation Object `_, only one of the Security Requirement -Objects in the list needs to be satisfied to authorize the request. - -Patterned Fields - -{name}: ``List[str]`` -Each name MUST correspond to a security scheme which is declared -in the `Security Schemes `_ under the -`Components Object `_. if the security scheme is of type -``"oauth2"`` or ``"openIdConnect"``, then the value is a list of scope names required for the execution, and the list -MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain -a list of role names which are required for the execution,but are not otherwise defined or exchanged in-band. -""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_scheme.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_scheme.py deleted file mode 100644 index badc77e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/security_scheme.py +++ /dev/null @@ -1,69 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Literal - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.oauth_flows import OAuthFlows - -__all__ = ("SecurityScheme",) - - -@dataclass -class SecurityScheme(BaseSchemaObject): - """Defines a security scheme that can be used by the operations. - - Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query - parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials - and authorization code) as defined in :rfc`6749`, and - `OpenID Connect Discovery `_. - - Please note that as of 2020, the implicit flow is about to be deprecated by - `OAuth 2.0 Security Best Current Practice `_. - Recommended for most use case is Authorization Code Grant flow with PKCE. - """ - - type: Literal["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] - """**REQUIRED**. The type of the security scheme.""" - - description: str | None = None - """A description for security scheme. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - name: str | None = None - """ - **REQUIRED** for ``apiKey``. The name of the header, query or cookie parameter to be used. - """ - - security_scheme_in: Literal["query", "header", "cookie"] | None = None - """ - **REQUIRED** for ``apiKey``. The location of the API key. - """ - - scheme: str | None = None - """ - **REQUIRED** for ``http``. The name of the HTTP Authorization scheme to be used in the - authorization header as defined in :rfc:`7235`. - - The values used SHOULD be registered in the - `IANA Authentication Scheme registry `_ - """ - - bearer_format: str | None = None - """A hint to the client to identify how the bearer token is formatted. - - Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation - purposes. - """ - - flows: OAuthFlows | None = None - """**REQUIRED** for ``oauth2``. An object containing configuration information for the flow types supported.""" - - open_id_connect_url: str | None = None - """**REQUIRED** for ``openIdConnect``. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in - the form of a URL. The OpenID Connect standard requires the use of TLS. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/server.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/server.py deleted file mode 100644 index 2c12fcf..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/server.py +++ /dev/null @@ -1,34 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.server_variable import ServerVariable - -__all__ = ("Server",) - - -@dataclass -class Server(BaseSchemaObject): - """An object representing a Server.""" - - url: str - """ - **REQUIRED**. A URL to the target host. - - This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the - location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in - ``{brackets}``. - """ - - description: str | None = None - """An optional string describing the host designated by the URL. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - variables: dict[str, ServerVariable] | None = None - """A map between a variable name and its value. The value is used for substitution in the server's URL template.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/server_variable.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/server_variable.py deleted file mode 100644 index c59c542..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/server_variable.py +++ /dev/null @@ -1,32 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("ServerVariable",) - - -@dataclass -class ServerVariable(BaseSchemaObject): - """An object representing a Server Variable for server URL template substitution.""" - - default: str - """**REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ - supplied. Note this behavior is different than the - `Schema Object's `_ treatment of default values, because in those - cases parameter values are optional. If the `enum `_ is - defined, the value MUST exist in the enum's values. - """ - - enum: list[str] | None = None - """An enumeration of string values to be used if the substitution options are from a limited set. - - The array SHOULD NOT be empty. - """ - - description: str | None = None - """An optional description for the server variable. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/tag.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/tag.py deleted file mode 100644 index c3e6374..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/tag.py +++ /dev/null @@ -1,32 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING - -from litestar.openapi.spec.base import BaseSchemaObject - -if TYPE_CHECKING: - from litestar.openapi.spec.external_documentation import ExternalDocumentation - -__all__ = ("Tag",) - - -@dataclass -class Tag(BaseSchemaObject): - """Adds metadata to a single tag that is used by the - `Operation Object `_. - - It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. - """ - - name: str - """**REQUIRED**. The name of the tag.""" - - description: str | None = None - """A short description for the tag. - - `CommonMark syntax `_ MAY be used for rich text representation. - """ - - external_docs: ExternalDocumentation | None = None - """Additional external documentation for this tag.""" diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py deleted file mode 100644 index 6030998..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py +++ /dev/null @@ -1,44 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("XML",) - - -@dataclass() -class XML(BaseSchemaObject): - """A metadata object that allows for more fine-tuned XML model definitions. - - When using arrays, XML element names are *not* inferred (for singular/plural forms) and the ``name`` property SHOULD - be used to add that information. See examples for expected behavior. - """ - - name: str | None = None - """ - Replaces the name of the element/attribute used for the described schema property. When defined within ``items``, it - will affect the name of the individual XML elements within the list. When defined alongside ``type`` being ``array`` - (outside the ``items``), it will affect the wrapping element and only if ``wrapped`` is ``True``. If ``wrapped`` is - ``False``, it will be ignored. - """ - - namespace: str | None = None - """The URI of the namespace definition. Value MUST be in the form of an absolute URI.""" - - prefix: str | None = None - """The prefix to be used for the - `xmlName `_ - """ - - attribute: bool = False - """Declares whether the property definition translates to an attribute instead of an element. Default value is - ``False``. - """ - - wrapped: bool = False - """ - MAY be used only for an array definition. Signifies whether the array is wrapped (for example, - ````) or unwrapped (````). Default value is ``False``. The definition - takes effect only when defined alongside ``type`` being ``array`` (outside the ``items``). - """ diff --git a/venv/lib/python3.11/site-packages/litestar/pagination.py b/venv/lib/python3.11/site-packages/litestar/pagination.py deleted file mode 100644 index 294a13a..0000000 --- a/venv/lib/python3.11/site-packages/litestar/pagination.py +++ /dev/null @@ -1,342 +0,0 @@ -# ruff: noqa: UP006,UP007 -from __future__ import annotations - -from abc import ABC, abstractmethod -from dataclasses import dataclass -from typing import Generic, List, Optional, TypeVar -from uuid import UUID - -__all__ = ( - "AbstractAsyncClassicPaginator", - "AbstractAsyncCursorPaginator", - "AbstractAsyncOffsetPaginator", - "AbstractSyncClassicPaginator", - "AbstractSyncCursorPaginator", - "AbstractSyncOffsetPaginator", - "ClassicPagination", - "CursorPagination", - "OffsetPagination", -) - - -T = TypeVar("T") -C = TypeVar("C", int, str, UUID) - - -@dataclass -class ClassicPagination(Generic[T]): - """Container for data returned using limit/offset pagination.""" - - __slots__ = ("items", "page_size", "current_page", "total_pages") - - items: List[T] - """List of data being sent as part of the response.""" - page_size: int - """Number of items per page.""" - current_page: int - """Current page number.""" - total_pages: int - """Total number of pages.""" - - -@dataclass -class OffsetPagination(Generic[T]): - """Container for data returned using limit/offset pagination.""" - - __slots__ = ("items", "limit", "offset", "total") - - items: List[T] - """List of data being sent as part of the response.""" - limit: int - """Maximal number of items to send.""" - offset: int - """Offset from the beginning of the query. - - Identical to an index. - """ - total: int - """Total number of items.""" - - -@dataclass -class CursorPagination(Generic[C, T]): - """Container for data returned using cursor pagination.""" - - __slots__ = ("items", "results_per_page", "cursor", "next_cursor") - - items: List[T] - """List of data being sent as part of the response.""" - results_per_page: int - """Maximal number of items to send.""" - cursor: Optional[C] - """Unique ID, designating the last identifier in the given data set. - - This value can be used to request the "next" batch of records. - """ - - -class AbstractSyncClassicPaginator(ABC, Generic[T]): - """Base paginator class for sync classic pagination. - - Implement this class to return paginated result sets using the classic pagination scheme. - """ - - @abstractmethod - def get_total(self, page_size: int) -> int: - """Return the total number of records. - - Args: - page_size: Maximal number of records to return. - - Returns: - An integer. - """ - raise NotImplementedError - - @abstractmethod - def get_items(self, page_size: int, current_page: int) -> list[T]: - """Return a list of items of the given size 'page_size' correlating with 'current_page'. - - Args: - page_size: Maximal number of records to return. - current_page: The current page of results to return. - - Returns: - A list of items. - """ - raise NotImplementedError - - def __call__(self, page_size: int, current_page: int) -> ClassicPagination[T]: - """Return a paginated result set. - - Args: - page_size: Maximal number of records to return. - current_page: The current page of results to return. - - Returns: - A paginated result set. - """ - total_pages = self.get_total(page_size=page_size) - - items = self.get_items(page_size=page_size, current_page=current_page) - - return ClassicPagination[T]( - items=items, total_pages=total_pages, page_size=page_size, current_page=current_page - ) - - -class AbstractAsyncClassicPaginator(ABC, Generic[T]): - """Base paginator class for async classic pagination. - - Implement this class to return paginated result sets using the classic pagination scheme. - """ - - @abstractmethod - async def get_total(self, page_size: int) -> int: - """Return the total number of records. - - Args: - page_size: Maximal number of records to return. - - Returns: - An integer. - """ - raise NotImplementedError - - @abstractmethod - async def get_items(self, page_size: int, current_page: int) -> list[T]: - """Return a list of items of the given size 'page_size' correlating with 'current_page'. - - Args: - page_size: Maximal number of records to return. - current_page: The current page of results to return. - - Returns: - A list of items. - """ - raise NotImplementedError - - async def __call__(self, page_size: int, current_page: int) -> ClassicPagination[T]: - """Return a paginated result set. - - Args: - page_size: Maximal number of records to return. - current_page: The current page of results to return. - - Returns: - A paginated result set. - """ - total_pages = await self.get_total(page_size=page_size) - - items = await self.get_items(page_size=page_size, current_page=current_page) - - return ClassicPagination[T]( - items=items, total_pages=total_pages, page_size=page_size, current_page=current_page - ) - - -class AbstractSyncOffsetPaginator(ABC, Generic[T]): - """Base paginator class for limit / offset pagination. - - Implement this class to return paginated result sets using the limit / offset pagination scheme. - """ - - @abstractmethod - def get_total(self) -> int: - """Return the total number of records. - - Returns: - An integer. - """ - raise NotImplementedError - - @abstractmethod - def get_items(self, limit: int, offset: int) -> list[T]: - """Return a list of items of the given size 'limit' starting from position 'offset'. - - Args: - limit: Maximal number of records to return. - offset: Starting position within the result set (assume index 0 as starting position). - - Returns: - A list of items. - """ - raise NotImplementedError - - def __call__(self, limit: int, offset: int) -> OffsetPagination[T]: - """Return a paginated result set. - - Args: - limit: Maximal number of records to return. - offset: Starting position within the result set (assume index 0 as starting position). - - Returns: - A paginated result set. - """ - total = self.get_total() - - items = self.get_items(limit=limit, offset=offset) - - return OffsetPagination[T](items=items, total=total, offset=offset, limit=limit) - - -class AbstractAsyncOffsetPaginator(ABC, Generic[T]): - """Base paginator class for limit / offset pagination. - - Implement this class to return paginated result sets using the limit / offset pagination scheme. - """ - - @abstractmethod - async def get_total(self) -> int: - """Return the total number of records. - - Returns: - An integer. - """ - raise NotImplementedError - - @abstractmethod - async def get_items(self, limit: int, offset: int) -> list[T]: - """Return a list of items of the given size 'limit' starting from position 'offset'. - - Args: - limit: Maximal number of records to return. - offset: Starting position within the result set (assume index 0 as starting position). - - Returns: - A list of items. - """ - raise NotImplementedError - - async def __call__(self, limit: int, offset: int) -> OffsetPagination[T]: - """Return a paginated result set. - - Args: - limit: Maximal number of records to return. - offset: Starting position within the result set (assume index 0 as starting position). - - Returns: - A paginated result set. - """ - total = await self.get_total() - items = await self.get_items(limit=limit, offset=offset) - - return OffsetPagination[T](items=items, total=total, offset=offset, limit=limit) - - -class AbstractSyncCursorPaginator(ABC, Generic[C, T]): - """Base paginator class for sync cursor pagination. - - Implement this class to return paginated result sets using the cursor pagination scheme. - """ - - @abstractmethod - def get_items(self, cursor: C | None, results_per_page: int) -> tuple[list[T], C | None]: - """Return a list of items of the size 'results_per_page' following the given cursor, if any, - - Args: - cursor: A unique identifier that acts as the 'cursor' after which results should be given. - results_per_page: A maximal number of results to return. - - Returns: - A tuple containing the result set and a new cursor that marks the last record retrieved. - The new cursor can be used to ask for the 'next_cursor' batch of results. - """ - raise NotImplementedError - - def __call__(self, cursor: C | None, results_per_page: int) -> CursorPagination[C, T]: - """Return a paginated result set given an optional cursor (unique ID) and a maximal number of results to return. - - Args: - cursor: A unique identifier that acts as the 'cursor' after which results should be given. - results_per_page: A maximal number of results to return. - - Returns: - A paginated result set. - """ - items, new_cursor = self.get_items(cursor=cursor, results_per_page=results_per_page) - - return CursorPagination[C, T]( - items=items, - results_per_page=results_per_page, - cursor=new_cursor, - ) - - -class AbstractAsyncCursorPaginator(ABC, Generic[C, T]): - """Base paginator class for async cursor pagination. - - Implement this class to return paginated result sets using the cursor pagination scheme. - """ - - @abstractmethod - async def get_items(self, cursor: C | None, results_per_page: int) -> tuple[list[T], C | None]: - """Return a list of items of the size 'results_per_page' following the given cursor, if any, - - Args: - cursor: A unique identifier that acts as the 'cursor' after which results should be given. - results_per_page: A maximal number of results to return. - - Returns: - A tuple containing the result set and a new cursor that marks the last record retrieved. - The new cursor can be used to ask for the 'next_cursor' batch of results. - """ - raise NotImplementedError - - async def __call__(self, cursor: C | None, results_per_page: int) -> CursorPagination[C, T]: - """Return a paginated result set given an optional cursor (unique ID) and a maximal number of results to return. - - Args: - cursor: A unique identifier that acts as the 'cursor' after which results should be given. - results_per_page: A maximal number of results to return. - - Returns: - A paginated result set. - """ - items, new_cursor = await self.get_items(cursor=cursor, results_per_page=results_per_page) - - return CursorPagination[C, T]( - items=items, - results_per_page=results_per_page, - cursor=new_cursor, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/params.py b/venv/lib/python3.11/site-packages/litestar/params.py deleted file mode 100644 index bff010b..0000000 --- a/venv/lib/python3.11/site-packages/litestar/params.py +++ /dev/null @@ -1,383 +0,0 @@ -from __future__ import annotations - -from dataclasses import asdict, dataclass, field -from typing import TYPE_CHECKING, Any, Hashable, Sequence - -from litestar.enums import RequestEncodingType -from litestar.types import Empty - -__all__ = ( - "Body", - "BodyKwarg", - "Dependency", - "DependencyKwarg", - "KwargDefinition", - "Parameter", - "ParameterKwarg", -) - - -if TYPE_CHECKING: - from litestar.openapi.spec.example import Example - from litestar.openapi.spec.external_documentation import ( - ExternalDocumentation, - ) - - -@dataclass(frozen=True) -class KwargDefinition: - """Data container representing a constrained kwarg.""" - - examples: list[Example] | None = field(default=None) - """A list of Example models.""" - external_docs: ExternalDocumentation | None = field(default=None) - """A url pointing at external documentation for the given parameter.""" - content_encoding: str | None = field(default=None) - """The content encoding of the value. - - Applicable on to string values. See OpenAPI 3.1 for details. - """ - default: Any = field(default=Empty) - """A default value. - - If const is true, this value is required. - """ - title: str | None = field(default=None) - """String value used in the title section of the OpenAPI schema for the given parameter.""" - description: str | None = field(default=None) - """String value used in the description section of the OpenAPI schema for the given parameter.""" - const: bool | None = field(default=None) - """A boolean flag dictating whether this parameter is a constant. - - If True, the value passed to the parameter must equal its default value. This also causes the OpenAPI const field to - be populated with the default value. - """ - gt: float | None = field(default=None) - """Constrict value to be greater than a given float or int. - - Equivalent to exclusiveMinimum in the OpenAPI specification. - """ - ge: float | None = field(default=None) - """Constrict value to be greater or equal to a given float or int. - - Equivalent to minimum in the OpenAPI specification. - """ - lt: float | None = field(default=None) - """Constrict value to be less than a given float or int. - - Equivalent to exclusiveMaximum in the OpenAPI specification. - """ - le: float | None = field(default=None) - """Constrict value to be less or equal to a given float or int. - - Equivalent to maximum in the OpenAPI specification. - """ - multiple_of: float | None = field(default=None) - """Constrict value to a multiple of a given float or int. - - Equivalent to multipleOf in the OpenAPI specification. - """ - min_items: int | None = field(default=None) - """Constrict a set or a list to have a minimum number of items. - - Equivalent to minItems in the OpenAPI specification. - """ - max_items: int | None = field(default=None) - """Constrict a set or a list to have a maximum number of items. - - Equivalent to maxItems in the OpenAPI specification. - """ - min_length: int | None = field(default=None) - """Constrict a string or bytes value to have a minimum length. - - Equivalent to minLength in the OpenAPI specification. - """ - max_length: int | None = field(default=None) - """Constrict a string or bytes value to have a maximum length. - - Equivalent to maxLength in the OpenAPI specification. - """ - pattern: str | None = field(default=None) - """A string representing a regex against which the given string will be matched. - - Equivalent to pattern in the OpenAPI specification. - """ - lower_case: bool | None = field(default=None) - """Constrict a string value to be lower case.""" - upper_case: bool | None = field(default=None) - """Constrict a string value to be upper case.""" - format: str | None = field(default=None) - """Specify the format to which a string value should be converted.""" - enum: Sequence[Any] | None = field(default=None) - """A sequence of valid values.""" - read_only: bool | None = field(default=None) - """A boolean flag dictating whether this parameter is read only.""" - - @property - def is_constrained(self) -> bool: - """Return True if any of the constraints are set.""" - return any( - attr if attr and attr is not Empty else False # type: ignore[comparison-overlap] - for attr in ( - self.gt, - self.ge, - self.lt, - self.le, - self.multiple_of, - self.min_items, - self.max_items, - self.min_length, - self.max_length, - self.pattern, - self.const, - self.lower_case, - self.upper_case, - ) - ) - - -@dataclass(frozen=True) -class ParameterKwarg(KwargDefinition): - """Data container representing a parameter.""" - - annotation: Any = field(default=Empty) - """The field value - `Empty` by default.""" - header: str | None = field(default=None) - """The header parameter key - required for header parameters.""" - cookie: str | None = field(default=None) - """The cookie parameter key - required for cookie parameters.""" - query: str | None = field(default=None) - """The query parameter key for this parameter.""" - required: bool | None = field(default=None) - """A boolean flag dictating whether this parameter is required. - - If set to False, None values will be allowed. Defaults to True. - """ - - def __hash__(self) -> int: # pragma: no cover - """Hash the dataclass in a safe way. - - Returns: - A hash - """ - return sum(hash(v) for v in asdict(self) if isinstance(v, Hashable)) - - -def Parameter( - annotation: Any = Empty, - *, - const: bool | None = None, - content_encoding: str | None = None, - cookie: str | None = None, - default: Any = Empty, - description: str | None = None, - examples: list[Example] | None = None, - external_docs: ExternalDocumentation | None = None, - ge: float | None = None, - gt: float | None = None, - header: str | None = None, - le: float | None = None, - lt: float | None = None, - max_items: int | None = None, - max_length: int | None = None, - min_items: int | None = None, - min_length: int | None = None, - multiple_of: float | None = None, - pattern: str | None = None, - query: str | None = None, - required: bool | None = None, - title: str | None = None, -) -> Any: - """Create an extended parameter kwarg definition. - - Args: - annotation: `Empty` by default. - const: A boolean flag dictating whether this parameter is a constant. If True, the value passed to the parameter - must equal its default value. This also causes the OpenAPI const field - to be populated with the default value. - content_encoding: The content encoding of the value. - Applicable on to string values. See OpenAPI 3.1 for details. - cookie: The cookie parameter key - required for cookie parameters. - default: A default value. If const is true, this value is required. - description: String value used in the description section of the OpenAPI schema for the given parameter. - examples: A list of Example models. - external_docs: A url pointing at external documentation for the given parameter. - ge: Constrict value to be greater or equal to a given float or int. - Equivalent to minimum in the OpenAPI specification. - gt: Constrict value to be greater than a given float or int. - Equivalent to exclusiveMinimum in the OpenAPI specification. - header: The header parameter key - required for header parameters. - le: Constrict value to be less or equal to a given float or int. - Equivalent to maximum in the OpenAPI specification. - lt: Constrict value to be less than a given float or int. - Equivalent to exclusiveMaximum in the OpenAPI specification. - max_items: Constrict a set or a list to have a maximum number of items. - Equivalent to maxItems in the OpenAPI specification. - max_length: Constrict a string or bytes value to have a maximum length. - Equivalent to maxLength in the OpenAPI specification. - min_items: Constrict a set or a list to have a minimum number of items. ֿ - Equivalent to minItems in the OpenAPI specification. - min_length: Constrict a string or bytes value to have a minimum length. - Equivalent to minLength in the OpenAPI specification. - multiple_of: Constrict value to a multiple of a given float or int. - Equivalent to multipleOf in the OpenAPI specification. - pattern: A string representing a regex against which the given string will be matched. - Equivalent to pattern in the OpenAPI specification. - query: The query parameter key for this parameter. - required: A boolean flag dictating whether this parameter is required. - If set to False, None values will be allowed. Defaults to True. - title: String value used in the title section of the OpenAPI schema for the given parameter. - """ - return ParameterKwarg( - annotation=annotation, - header=header, - cookie=cookie, - query=query, - examples=examples, - external_docs=external_docs, - content_encoding=content_encoding, - required=required, - default=default, - title=title, - description=description, - const=const, - gt=gt, - ge=ge, - lt=lt, - le=le, - multiple_of=multiple_of, - min_items=min_items, - max_items=max_items, - min_length=min_length, - max_length=max_length, - pattern=pattern, - ) - - -@dataclass(frozen=True) -class BodyKwarg(KwargDefinition): - """Data container representing a request body.""" - - media_type: str | RequestEncodingType = field(default=RequestEncodingType.JSON) - """Media-Type of the body.""" - - multipart_form_part_limit: int | None = field(default=None) - """The maximal number of allowed parts in a multipart/formdata request. This limit is intended to protect from DoS attacks.""" - - def __hash__(self) -> int: # pragma: no cover - """Hash the dataclass in a safe way. - - Returns: - A hash - """ - return sum(hash(v) for v in asdict(self) if isinstance(v, Hashable)) - - -def Body( - *, - const: bool | None = None, - content_encoding: str | None = None, - default: Any = Empty, - description: str | None = None, - examples: list[Example] | None = None, - external_docs: ExternalDocumentation | None = None, - ge: float | None = None, - gt: float | None = None, - le: float | None = None, - lt: float | None = None, - max_items: int | None = None, - max_length: int | None = None, - media_type: str | RequestEncodingType = RequestEncodingType.JSON, - min_items: int | None = None, - min_length: int | None = None, - multipart_form_part_limit: int | None = None, - multiple_of: float | None = None, - pattern: str | None = None, - title: str | None = None, -) -> Any: - """Create an extended request body kwarg definition. - - Args: - const: A boolean flag dictating whether this parameter is a constant. If True, the value passed to the parameter - must equal its default value. This also causes the OpenAPI const field to be - populated with the default value. - content_encoding: The content encoding of the value. Applicable on to string values. - See OpenAPI 3.1 for details. - default: A default value. If const is true, this value is required. - description: String value used in the description section of the OpenAPI schema for the given parameter. - examples: A list of Example models. - external_docs: A url pointing at external documentation for the given parameter. - ge: Constrict value to be greater or equal to a given float or int. - Equivalent to minimum in the OpenAPI specification. - gt: Constrict value to be greater than a given float or int. - Equivalent to exclusiveMinimum in the OpenAPI specification. - le: Constrict value to be less or equal to a given float or int. - Equivalent to maximum in the OpenAPI specification. - lt: Constrict value to be less than a given float or int. - Equivalent to exclusiveMaximum in the OpenAPI specification. - max_items: Constrict a set or a list to have a maximum number of items. - Equivalent to maxItems in the OpenAPI specification. - max_length: Constrict a string or bytes value to have a maximum length. - Equivalent to maxLength in the OpenAPI specification. - media_type: Defaults to RequestEncodingType.JSON. - min_items: Constrict a set or a list to have a minimum number of items. - Equivalent to minItems in the OpenAPI specification. - min_length: Constrict a string or bytes value to have a minimum length. - Equivalent to minLength in the OpenAPI specification. - multipart_form_part_limit: The maximal number of allowed parts in a multipart/formdata request. - This limit is intended to protect from DoS attacks. - multiple_of: Constrict value to a multiple of a given float or int. - Equivalent to multipleOf in the OpenAPI specification. - pattern: A string representing a regex against which the given string will be matched. - Equivalent to pattern in the OpenAPI specification. - title: String value used in the title section of the OpenAPI schema for the given parameter. - """ - return BodyKwarg( - media_type=media_type, - examples=examples, - external_docs=external_docs, - content_encoding=content_encoding, - default=default, - title=title, - description=description, - const=const, - gt=gt, - ge=ge, - lt=lt, - le=le, - multiple_of=multiple_of, - min_items=min_items, - max_items=max_items, - min_length=min_length, - max_length=max_length, - pattern=pattern, - multipart_form_part_limit=multipart_form_part_limit, - ) - - -@dataclass(frozen=True) -class DependencyKwarg: - """Data container representing a dependency.""" - - default: Any = field(default=Empty) - """A default value.""" - skip_validation: bool = field(default=False) - """Flag dictating whether to skip validation.""" - - def __hash__(self) -> int: - """Hash the dataclass in a safe way. - - Returns: - A hash - """ - return sum(hash(v) for v in asdict(self) if isinstance(v, Hashable)) - - -def Dependency(*, default: Any = Empty, skip_validation: bool = False) -> Any: - """Create a dependency kwarg definition. - - Args: - default: A default value to use in case a dependency is not provided. - skip_validation: If `True` provided dependency values are not validated by signature model. - """ - return DependencyKwarg(default=default, skip_validation=skip_validation) diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__init__.py b/venv/lib/python3.11/site-packages/litestar/plugins/__init__.py deleted file mode 100644 index f093104..0000000 --- a/venv/lib/python3.11/site-packages/litestar/plugins/__init__.py +++ /dev/null @@ -1,23 +0,0 @@ -from litestar.plugins.base import ( - CLIPlugin, - CLIPluginProtocol, - DIPlugin, - InitPluginProtocol, - OpenAPISchemaPlugin, - OpenAPISchemaPluginProtocol, - PluginProtocol, - PluginRegistry, - SerializationPluginProtocol, -) - -__all__ = ( - "SerializationPluginProtocol", - "DIPlugin", - "CLIPlugin", - "InitPluginProtocol", - "OpenAPISchemaPluginProtocol", - "OpenAPISchemaPlugin", - "PluginProtocol", - "CLIPluginProtocol", - "PluginRegistry", -) diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index e547c6a..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 582d144..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/core.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/core.cpython-311.pyc deleted file mode 100644 index d197b7e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/core.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/sqlalchemy.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/sqlalchemy.cpython-311.pyc deleted file mode 100644 index 2b9ab93..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/sqlalchemy.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/structlog.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/structlog.cpython-311.pyc deleted file mode 100644 index e575d1b..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/plugins/__pycache__/structlog.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/base.py b/venv/lib/python3.11/site-packages/litestar/plugins/base.py deleted file mode 100644 index afc571e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/plugins/base.py +++ /dev/null @@ -1,323 +0,0 @@ -from __future__ import annotations - -import abc -from contextlib import contextmanager -from typing import TYPE_CHECKING, Any, Iterator, Protocol, TypeVar, Union, cast, runtime_checkable - -if TYPE_CHECKING: - from inspect import Signature - - from click import Group - - from litestar._openapi.schema_generation import SchemaCreator - from litestar.app import Litestar - from litestar.config.app import AppConfig - from litestar.dto import AbstractDTO - from litestar.openapi.spec import Schema - from litestar.routes import BaseRoute - from litestar.typing import FieldDefinition - -__all__ = ( - "SerializationPluginProtocol", - "InitPluginProtocol", - "OpenAPISchemaPluginProtocol", - "OpenAPISchemaPlugin", - "PluginProtocol", - "CLIPlugin", - "CLIPluginProtocol", - "PluginRegistry", - "DIPlugin", -) - - -@runtime_checkable -class InitPluginProtocol(Protocol): - """Protocol used to define plugins that affect the application's init process.""" - - __slots__ = () - - def on_app_init(self, app_config: AppConfig) -> AppConfig: - """Receive the :class:`AppConfig<.config.app.AppConfig>` instance after `on_app_init` hooks have been called. - - Examples: - .. code-block:: python - - from litestar import Litestar, get - from litestar.di import Provide - from litestar.plugins import InitPluginProtocol - - - def get_name() -> str: - return "world" - - - @get("/my-path") - def my_route_handler(name: str) -> dict[str, str]: - return {"hello": name} - - - class MyPlugin(InitPluginProtocol): - def on_app_init(self, app_config: AppConfig) -> AppConfig: - app_config.dependencies["name"] = Provide(get_name) - app_config.route_handlers.append(my_route_handler) - return app_config - - - app = Litestar(plugins=[MyPlugin()]) - - Args: - app_config: The :class:`AppConfig ` instance. - - Returns: - The app config object. - """ - return app_config # pragma: no cover - - -class ReceiveRoutePlugin: - """Receive routes as they are added to the application.""" - - __slots__ = () - - def receive_route(self, route: BaseRoute) -> None: - """Receive routes as they are registered on an application.""" - - -@runtime_checkable -class CLIPluginProtocol(Protocol): - """Plugin protocol to extend the CLI.""" - - __slots__ = () - - def on_cli_init(self, cli: Group) -> None: - """Called when the CLI is initialized. - - This can be used to extend or override existing commands. - - Args: - cli: The root :class:`click.Group` of the Litestar CLI - - Examples: - .. code-block:: python - - from litestar import Litestar - from litestar.plugins import CLIPluginProtocol - from click import Group - - - class CLIPlugin(CLIPluginProtocol): - def on_cli_init(self, cli: Group) -> None: - @cli.command() - def is_debug_mode(app: Litestar): - print(app.debug) - - - app = Litestar(plugins=[CLIPlugin()]) - """ - - -class CLIPlugin(CLIPluginProtocol): - """Plugin protocol to extend the CLI Server Lifespan.""" - - __slots__ = () - - def on_cli_init(self, cli: Group) -> None: - return super().on_cli_init(cli) - - @contextmanager - def server_lifespan(self, app: Litestar) -> Iterator[None]: - yield - - -@runtime_checkable -class SerializationPluginProtocol(Protocol): - """Protocol used to define a serialization plugin for DTOs.""" - - __slots__ = () - - def supports_type(self, field_definition: FieldDefinition) -> bool: - """Given a value of indeterminate type, determine if this value is supported by the plugin. - - Args: - field_definition: A parsed type. - - Returns: - Whether the type is supported by the plugin. - """ - raise NotImplementedError() - - def create_dto_for_type(self, field_definition: FieldDefinition) -> type[AbstractDTO]: - """Given a parsed type, create a DTO class. - - Args: - field_definition: A parsed type. - - Returns: - A DTO class. - """ - raise NotImplementedError() - - -class DIPlugin(abc.ABC): - """Extend dependency injection""" - - @abc.abstractmethod - def has_typed_init(self, type_: Any) -> bool: - """Return ``True`` if ``type_`` has type information available for its - :func:`__init__` method that cannot be extracted from this method's type - annotations (e.g. a Pydantic BaseModel subclass), and - :meth:`DIPlugin.get_typed_init` supports extraction of these annotations. - """ - ... - - @abc.abstractmethod - def get_typed_init(self, type_: Any) -> tuple[Signature, dict[str, Any]]: - r"""Return signature and type information about the ``type_``\ s :func:`__init__` - method. - """ - ... - - -@runtime_checkable -class OpenAPISchemaPluginProtocol(Protocol): - """Plugin protocol to extend the support of OpenAPI schema generation for non-library types.""" - - __slots__ = () - - @staticmethod - def is_plugin_supported_type(value: Any) -> bool: - """Given a value of indeterminate type, determine if this value is supported by the plugin. - - Args: - value: An arbitrary value. - - Returns: - A typeguard dictating whether the value is supported by the plugin. - """ - raise NotImplementedError() - - def to_openapi_schema(self, field_definition: FieldDefinition, schema_creator: SchemaCreator) -> Schema: - """Given a type annotation, transform it into an OpenAPI schema class. - - Args: - field_definition: An :class:`OpenAPI ` instance. - schema_creator: An instance of the openapi SchemaCreator. - - Returns: - An :class:`OpenAPI ` instance. - """ - raise NotImplementedError() - - -class OpenAPISchemaPlugin(OpenAPISchemaPluginProtocol): - """Plugin to extend the support of OpenAPI schema generation for non-library types.""" - - @staticmethod - def is_plugin_supported_type(value: Any) -> bool: - """Given a value of indeterminate type, determine if this value is supported by the plugin. - - This is called by the default implementation of :meth:`is_plugin_supported_field` for - backwards compatibility. User's should prefer to override that method instead. - - Args: - value: An arbitrary value. - - Returns: - A bool indicating whether the value is supported by the plugin. - """ - raise NotImplementedError( - "One of either is_plugin_supported_type or is_plugin_supported_field should be defined. " - "The default implementation of is_plugin_supported_field calls is_plugin_supported_type " - "for backwards compatibility. Users should prefer to override is_plugin_supported_field " - "as it receives a 'FieldDefinition' instance which is more useful than a raw type." - ) - - def is_plugin_supported_field(self, field_definition: FieldDefinition) -> bool: - """Given a :class:`FieldDefinition ` that represents an indeterminate type, - determine if this value is supported by the plugin - - Args: - field_definition: A parsed type. - - Returns: - Whether the type is supported by the plugin. - """ - return self.is_plugin_supported_type(field_definition.annotation) - - @staticmethod - def is_undefined_sentinel(value: Any) -> bool: - """Return ``True`` if ``value`` should be treated as an undefined field""" - return False - - @staticmethod - def is_constrained_field(field_definition: FieldDefinition) -> bool: - """Return ``True`` if the field should be treated as constrained. If returning - ``True``, constraints should be defined in the field's extras - """ - return False - - -PluginProtocol = Union[ - CLIPlugin, - CLIPluginProtocol, - InitPluginProtocol, - OpenAPISchemaPlugin, - OpenAPISchemaPluginProtocol, - ReceiveRoutePlugin, - SerializationPluginProtocol, - DIPlugin, -] - -PluginT = TypeVar("PluginT", bound=PluginProtocol) - - -class PluginRegistry: - __slots__ = { - "init": "Plugins that implement the InitPluginProtocol", - "openapi": "Plugins that implement the OpenAPISchemaPluginProtocol", - "receive_route": "ReceiveRoutePlugin instances", - "serialization": "Plugins that implement the SerializationPluginProtocol", - "cli": "Plugins that implement the CLIPluginProtocol", - "di": "DIPlugin instances", - "_plugins_by_type": None, - "_plugins": None, - "_get_plugins_of_type": None, - } - - def __init__(self, plugins: list[PluginProtocol]) -> None: - self._plugins_by_type = {type(p): p for p in plugins} - self._plugins = frozenset(plugins) - self.init = tuple(p for p in plugins if isinstance(p, InitPluginProtocol)) - self.openapi = tuple(p for p in plugins if isinstance(p, OpenAPISchemaPluginProtocol)) - self.receive_route = tuple(p for p in plugins if isinstance(p, ReceiveRoutePlugin)) - self.serialization = tuple(p for p in plugins if isinstance(p, SerializationPluginProtocol)) - self.cli = tuple(p for p in plugins if isinstance(p, CLIPluginProtocol)) - self.di = tuple(p for p in plugins if isinstance(p, DIPlugin)) - - def get(self, type_: type[PluginT] | str) -> PluginT: - """Return the registered plugin of ``type_``. - - This should be used with subclasses of the plugin protocols. - """ - if isinstance(type_, str): - for plugin in self._plugins: - _name = plugin.__class__.__name__ - _module = plugin.__class__.__module__ - _qualname = ( - f"{_module}.{plugin.__class__.__qualname__}" - if _module is not None and _module != "__builtin__" - else plugin.__class__.__qualname__ - ) - if type_ in {_name, _qualname}: - return cast(PluginT, plugin) - raise KeyError(f"No plugin of type {type_!r} registered") - try: - return cast(PluginT, self._plugins_by_type[type_]) # type: ignore[index] - except KeyError as e: - raise KeyError(f"No plugin of type {type_.__name__!r} registered") from e - - def __iter__(self) -> Iterator[PluginProtocol]: - return iter(self._plugins) - - def __contains__(self, item: PluginProtocol) -> bool: - return item in self._plugins diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/core.py b/venv/lib/python3.11/site-packages/litestar/plugins/core.py deleted file mode 100644 index d25d6d6..0000000 --- a/venv/lib/python3.11/site-packages/litestar/plugins/core.py +++ /dev/null @@ -1,31 +0,0 @@ -from __future__ import annotations - -import inspect -from inspect import Signature -from typing import Any - -import msgspec - -from litestar.plugins import DIPlugin - -__all__ = ("MsgspecDIPlugin",) - - -class MsgspecDIPlugin(DIPlugin): - def has_typed_init(self, type_: Any) -> bool: - return type(type_) is type(msgspec.Struct) # noqa: E721 - - def get_typed_init(self, type_: Any) -> tuple[Signature, dict[str, Any]]: - parameters = [] - type_hints = {} - for field_info in msgspec.structs.fields(type_): - type_hints[field_info.name] = field_info.type - parameters.append( - inspect.Parameter( - name=field_info.name, - kind=inspect.Parameter.KEYWORD_ONLY, - annotation=field_info.type, - default=field_info.default, - ) - ) - return inspect.Signature(parameters), type_hints diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/sqlalchemy.py b/venv/lib/python3.11/site-packages/litestar/plugins/sqlalchemy.py deleted file mode 100644 index d65d712..0000000 --- a/venv/lib/python3.11/site-packages/litestar/plugins/sqlalchemy.py +++ /dev/null @@ -1,54 +0,0 @@ -from advanced_alchemy import filters, types -from advanced_alchemy.base import ( - AuditColumns, - BigIntAuditBase, - BigIntBase, - BigIntPrimaryKey, - CommonTableAttributes, - UUIDAuditBase, - UUIDBase, - UUIDPrimaryKey, - orm_registry, -) -from advanced_alchemy.extensions.litestar import ( - AlembicAsyncConfig, - AlembicCommands, - AlembicSyncConfig, - AsyncSessionConfig, - EngineConfig, - SQLAlchemyAsyncConfig, - SQLAlchemyDTO, - SQLAlchemyDTOConfig, - SQLAlchemyInitPlugin, - SQLAlchemyPlugin, - SQLAlchemySerializationPlugin, - SQLAlchemySyncConfig, - SyncSessionConfig, -) - -__all__ = ( - "orm_registry", - "filters", - "types", - "AuditColumns", - "BigIntAuditBase", - "BigIntBase", - "UUIDAuditBase", - "UUIDPrimaryKey", - "CommonTableAttributes", - "UUIDBase", - "BigIntPrimaryKey", - "AlembicCommands", - "AlembicAsyncConfig", - "AlembicSyncConfig", - "AsyncSessionConfig", - "SyncSessionConfig", - "SQLAlchemyDTO", - "SQLAlchemyDTOConfig", - "SQLAlchemyAsyncConfig", - "SQLAlchemyInitPlugin", - "SQLAlchemyPlugin", - "SQLAlchemySerializationPlugin", - "SQLAlchemySyncConfig", - "EngineConfig", -) diff --git a/venv/lib/python3.11/site-packages/litestar/plugins/structlog.py b/venv/lib/python3.11/site-packages/litestar/plugins/structlog.py deleted file mode 100644 index fafa3dd..0000000 --- a/venv/lib/python3.11/site-packages/litestar/plugins/structlog.py +++ /dev/null @@ -1,56 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from typing import TYPE_CHECKING - -from litestar.cli._utils import console -from litestar.logging.config import StructLoggingConfig -from litestar.middleware.logging import LoggingMiddlewareConfig -from litestar.plugins import InitPluginProtocol - -if TYPE_CHECKING: - from litestar.config.app import AppConfig - - -@dataclass -class StructlogConfig: - structlog_logging_config: StructLoggingConfig = field(default_factory=StructLoggingConfig) - """Structlog Logging configuration for Litestar. See ``litestar.logging.config.StructLoggingConfig``` for details.""" - middleware_logging_config: LoggingMiddlewareConfig = field(default_factory=LoggingMiddlewareConfig) - """Middleware logging config.""" - enable_middleware_logging: bool = True - """Enable request logging.""" - - -class StructlogPlugin(InitPluginProtocol): - """Structlog Plugin.""" - - __slots__ = ("_config",) - - def __init__(self, config: StructlogConfig | None = None) -> None: - if config is None: - config = StructlogConfig() - self._config = config - super().__init__() - - def on_app_init(self, app_config: AppConfig) -> AppConfig: - """Structlog Plugin - - Args: - app_config: The :class:`AppConfig ` instance. - - Returns: - The app config object. - """ - if app_config.logging_config is not None and isinstance(app_config.logging_config, StructLoggingConfig): - console.print( - "[red dim]* Found pre-configured `StructLoggingConfig` on the `app` instance. Skipping configuration.[/]", - ) - else: - app_config.logging_config = self._config.structlog_logging_config - app_config.logging_config.configure() - if self._config.structlog_logging_config.standard_lib_logging_config is not None: # pragma: no cover - self._config.structlog_logging_config.standard_lib_logging_config.configure() # pragma: no cover - if self._config.enable_middleware_logging: - app_config.middleware.append(self._config.middleware_logging_config.middleware) - return app_config # pragma: no cover diff --git a/venv/lib/python3.11/site-packages/litestar/py.typed b/venv/lib/python3.11/site-packages/litestar/py.typed deleted file mode 100644 index e69de29..0000000 diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__init__.py b/venv/lib/python3.11/site-packages/litestar/repository/__init__.py deleted file mode 100644 index 62e3f83..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/__init__.py +++ /dev/null @@ -1,14 +0,0 @@ -from __future__ import annotations - -from .abc import AbstractAsyncRepository, AbstractSyncRepository -from .exceptions import ConflictError, NotFoundError, RepositoryError -from .filters import FilterTypes - -__all__ = ( - "AbstractAsyncRepository", - "AbstractSyncRepository", - "ConflictError", - "FilterTypes", - "NotFoundError", - "RepositoryError", -) diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 42bf9be..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_exceptions.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_exceptions.cpython-311.pyc deleted file mode 100644 index 0f48627..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_exceptions.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_filters.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_filters.cpython-311.pyc deleted file mode 100644 index 2f16cb4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/_filters.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/exceptions.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/exceptions.cpython-311.pyc deleted file mode 100644 index 3c9f01e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/exceptions.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/filters.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/filters.cpython-311.pyc deleted file mode 100644 index 87d90db..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/filters.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/handlers.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/handlers.cpython-311.pyc deleted file mode 100644 index abe227b..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/__pycache__/handlers.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/_exceptions.py b/venv/lib/python3.11/site-packages/litestar/repository/_exceptions.py deleted file mode 100644 index 1c2b7be..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/_exceptions.py +++ /dev/null @@ -1,15 +0,0 @@ -from __future__ import annotations # pragma: no cover - -__all__ = ("ConflictError", "NotFoundError", "RepositoryError") # pragma: no cover - - -class RepositoryError(Exception): # pragma: no cover - """Base repository exception type.""" - - -class ConflictError(RepositoryError): # pragma: no cover - """Data integrity error.""" - - -class NotFoundError(RepositoryError): # pragma: no cover - """An identity does not exist.""" diff --git a/venv/lib/python3.11/site-packages/litestar/repository/_filters.py b/venv/lib/python3.11/site-packages/litestar/repository/_filters.py deleted file mode 100644 index f6b787e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/_filters.py +++ /dev/null @@ -1,117 +0,0 @@ -"""Collection filter datastructures.""" - -from __future__ import annotations - -from collections import abc # noqa: TCH003 -from dataclasses import dataclass -from datetime import datetime # noqa: TCH003 -from typing import TYPE_CHECKING, Any, Generic, Literal, TypeVar - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - -T = TypeVar("T") - -__all__ = ( - "BeforeAfter", - "CollectionFilter", - "FilterTypes", - "LimitOffset", - "OrderBy", - "SearchFilter", - "NotInCollectionFilter", - "OnBeforeAfter", - "NotInSearchFilter", -) - - -FilterTypes: TypeAlias = "BeforeAfter | OnBeforeAfter | CollectionFilter[Any] | LimitOffset | OrderBy | SearchFilter | NotInCollectionFilter[Any] | NotInSearchFilter" -"""Aggregate type alias of the types supported for collection filtering.""" - - -@dataclass -class BeforeAfter: - """Data required to filter a query on a ``datetime`` column.""" - - field_name: str - """Name of the model attribute to filter on.""" - before: datetime | None - """Filter results where field earlier than this.""" - after: datetime | None - """Filter results where field later than this.""" - - -@dataclass -class OnBeforeAfter: - """Data required to filter a query on a ``datetime`` column.""" - - field_name: str - """Name of the model attribute to filter on.""" - on_or_before: datetime | None - """Filter results where field is on or earlier than this.""" - on_or_after: datetime | None - """Filter results where field on or later than this.""" - - -@dataclass -class CollectionFilter(Generic[T]): - """Data required to construct a ``WHERE ... IN (...)`` clause.""" - - field_name: str - """Name of the model attribute to filter on.""" - values: abc.Collection[T] - """Values for ``IN`` clause.""" - - -@dataclass -class NotInCollectionFilter(Generic[T]): - """Data required to construct a ``WHERE ... NOT IN (...)`` clause.""" - - field_name: str - """Name of the model attribute to filter on.""" - values: abc.Collection[T] - """Values for ``NOT IN`` clause.""" - - -@dataclass -class LimitOffset: - """Data required to add limit/offset filtering to a query.""" - - limit: int - """Value for ``LIMIT`` clause of query.""" - offset: int - """Value for ``OFFSET`` clause of query.""" - - -@dataclass -class OrderBy: - """Data required to construct a ``ORDER BY ...`` clause.""" - - field_name: str - """Name of the model attribute to sort on.""" - sort_order: Literal["asc", "desc"] = "asc" - """Sort ascending or descending""" - - -@dataclass -class SearchFilter: - """Data required to construct a ``WHERE field_name LIKE '%' || :value || '%'`` clause.""" - - field_name: str - """Name of the model attribute to sort on.""" - value: str - """Values for ``LIKE`` clause.""" - ignore_case: bool | None = False - """Should the search be case insensitive.""" - - -@dataclass -class NotInSearchFilter: - """Data required to construct a ``WHERE field_name NOT LIKE '%' || :value || '%'`` clause.""" - - field_name: str - """Name of the model attribute to search on.""" - value: str - """Values for ``NOT LIKE`` clause.""" - ignore_case: bool | None = False - """Should the search be case insensitive.""" diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/__init__.py b/venv/lib/python3.11/site-packages/litestar/repository/abc/__init__.py deleted file mode 100644 index def6bb4..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/abc/__init__.py +++ /dev/null @@ -1,7 +0,0 @@ -from ._async import AbstractAsyncRepository -from ._sync import AbstractSyncRepository - -__all__ = ( - "AbstractAsyncRepository", - "AbstractSyncRepository", -) diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 710a74b..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_async.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_async.cpython-311.pyc deleted file mode 100644 index 24217cc..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_async.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_sync.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_sync.cpython-311.pyc deleted file mode 100644 index 7a69407..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/abc/__pycache__/_sync.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/_async.py b/venv/lib/python3.11/site-packages/litestar/repository/abc/_async.py deleted file mode 100644 index 85ca139..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/abc/_async.py +++ /dev/null @@ -1,303 +0,0 @@ -from __future__ import annotations - -from abc import ABCMeta, abstractmethod -from typing import TYPE_CHECKING, Any, Generic, TypeVar - -from litestar.repository.exceptions import NotFoundError - -if TYPE_CHECKING: - from litestar.repository.filters import FilterTypes - -T = TypeVar("T") -CollectionT = TypeVar("CollectionT") - - -class AbstractAsyncRepository(Generic[T], metaclass=ABCMeta): - """Interface for persistent data interaction.""" - - model_type: type[T] - """Type of object represented by the repository.""" - id_attribute: Any = "id" - """Name of the primary identifying attribute on :attr:`model_type`.""" - - def __init__(self, **kwargs: Any) -> None: - """Repository constructors accept arbitrary kwargs.""" - super().__init__(**kwargs) - - @abstractmethod - async def add(self, data: T) -> T: - """Add ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - - @abstractmethod - async def add_many(self, data: list[T]) -> list[T]: - """Add multiple ``data`` to the collection. - - Args: - data: Instances to be added to the collection. - - Returns: - The added instances. - """ - - @abstractmethod - async def count(self, *filters: FilterTypes, **kwargs: Any) -> int: - """Get the count of records returned by a query. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - The count of instances - """ - - @abstractmethod - async def delete(self, item_id: Any) -> T: - """Delete instance identified by ``item_id``. - - Args: - item_id: Identifier of instance to be deleted. - - Returns: - The deleted instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - - @abstractmethod - async def delete_many(self, item_ids: list[Any]) -> list[T]: - """Delete multiple instances identified by list of IDs ``item_ids``. - - Args: - item_ids: list of Identifiers to be deleted. - - Returns: - The deleted instances. - """ - - @abstractmethod - async def exists(self, *filters: FilterTypes, **kwargs: Any) -> bool: - """Return true if the object specified by ``kwargs`` exists. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - True if the instance was found. False if not found. - - """ - - @abstractmethod - async def get(self, item_id: Any, **kwargs: Any) -> T: - """Get instance identified by ``item_id``. - - Args: - item_id: Identifier of the instance to be retrieved. - **kwargs: Additional arguments - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - - @abstractmethod - async def get_one(self, **kwargs: Any) -> T: - """Get an instance specified by the ``kwargs`` filters if it exists. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``kwargs``. - """ - - @abstractmethod - async def get_or_create(self, **kwargs: Any) -> tuple[T, bool]: - """Get an instance specified by the ``kwargs`` filters if it exists or create it. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - A tuple that includes the retrieved or created instance, and a boolean on whether the record was created or not - """ - - @abstractmethod - async def get_one_or_none(self, **kwargs: Any) -> T | None: - """Get an instance if it exists or None. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None. - """ - - @abstractmethod - async def update(self, data: T) -> T: - """Update instance with the attribute values present on ``data``. - - Args: - data: An instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - The updated instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - async def update_many(self, data: list[T]) -> list[T]: - """Update multiple instances with the attribute values present on instances in ``data``. - - Args: - data: A list of instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - a list of the updated instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - async def upsert(self, data: T) -> T: - """Update or create instance. - - Updates instance with the attribute values present on ``data``, or creates a new instance if - one doesn't exist. - - Args: - data: Instance to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on ``data`` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - async def upsert_many(self, data: list[T]) -> list[T]: - """Update or create multiple instances. - - Update instances with the attribute values present on ``data``, or create a new instance if - one doesn't exist. - - Args: - data: Instances to update or created. Identifier used to determine if an - existing instance exists is the value of an attribute on ``data`` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - async def list_and_count(self, *filters: FilterTypes, **kwargs: Any) -> tuple[list[T], int]: - """List records with total count. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - a tuple containing The list of instances, after filtering applied, and a count of records returned by query, ignoring pagination. - """ - - @abstractmethod - async def list(self, *filters: FilterTypes, **kwargs: Any) -> list[T]: - """Get a list of instances, optionally filtered. - - Args: - *filters: filters for specific filtering operations - **kwargs: Instance attribute value filters. - - Returns: - The list of instances, after filtering applied - """ - - @abstractmethod - def filter_collection_by_kwargs(self, collection: CollectionT, /, **kwargs: Any) -> CollectionT: - """Filter the collection by kwargs. - - Has ``AND`` semantics where multiple kwargs name/value pairs are provided. - - Args: - collection: the objects to be filtered - **kwargs: key/value pairs such that objects remaining in the collection after filtering - have the property that their attribute named ``key`` has value equal to ``value``. - - - Returns: - The filtered objects - - Raises: - RepositoryError: if a named attribute doesn't exist on :attr:`model_type `. - """ - - @staticmethod - def check_not_found(item_or_none: T | None) -> T: - """Raise :class:`NotFoundError` if ``item_or_none`` is ``None``. - - Args: - item_or_none: Item (:class:`T `) to be tested for existence. - - Returns: - The item, if it exists. - """ - if item_or_none is None: - raise NotFoundError("No item found when one was expected") - return item_or_none - - @classmethod - def get_id_attribute_value(cls, item: T | type[T], id_attribute: str | None = None) -> Any: - """Get value of attribute named as :attr:`id_attribute ` on ``item``. - - Args: - item: Anything that should have an attribute named as :attr:`id_attribute ` value. - id_attribute: Allows customization of the unique identifier to use for model fetching. - Defaults to `None`, but can reference any surrogate or candidate key for the table. - - Returns: - The value of attribute on ``item`` named as :attr:`id_attribute `. - """ - return getattr(item, id_attribute if id_attribute is not None else cls.id_attribute) - - @classmethod - def set_id_attribute_value(cls, item_id: Any, item: T, id_attribute: str | None = None) -> T: - """Return the ``item`` after the ID is set to the appropriate attribute. - - Args: - item_id: Value of ID to be set on instance - item: Anything that should have an attribute named as :attr:`id_attribute ` value. - id_attribute: Allows customization of the unique identifier to use for model fetching. - Defaults to `None`, but can reference any surrogate or candidate key for the table. - - Returns: - Item with ``item_id`` set to :attr:`id_attribute ` - """ - setattr(item, id_attribute if id_attribute is not None else cls.id_attribute, item_id) - return item diff --git a/venv/lib/python3.11/site-packages/litestar/repository/abc/_sync.py b/venv/lib/python3.11/site-packages/litestar/repository/abc/_sync.py deleted file mode 100644 index d667fc2..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/abc/_sync.py +++ /dev/null @@ -1,305 +0,0 @@ -# Do not edit this file directly. It has been autogenerated from -# litestar/repository/abc/_async.py -from __future__ import annotations - -from abc import ABCMeta, abstractmethod -from typing import TYPE_CHECKING, Any, Generic, TypeVar - -from litestar.repository.exceptions import NotFoundError - -if TYPE_CHECKING: - from litestar.repository.filters import FilterTypes - -T = TypeVar("T") -CollectionT = TypeVar("CollectionT") - - -class AbstractSyncRepository(Generic[T], metaclass=ABCMeta): - """Interface for persistent data interaction.""" - - model_type: type[T] - """Type of object represented by the repository.""" - id_attribute: Any = "id" - """Name of the primary identifying attribute on :attr:`model_type`.""" - - def __init__(self, **kwargs: Any) -> None: - """Repository constructors accept arbitrary kwargs.""" - super().__init__(**kwargs) - - @abstractmethod - def add(self, data: T) -> T: - """Add ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - - @abstractmethod - def add_many(self, data: list[T]) -> list[T]: - """Add multiple ``data`` to the collection. - - Args: - data: Instances to be added to the collection. - - Returns: - The added instances. - """ - - @abstractmethod - def count(self, *filters: FilterTypes, **kwargs: Any) -> int: - """Get the count of records returned by a query. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - The count of instances - """ - - @abstractmethod - def delete(self, item_id: Any) -> T: - """Delete instance identified by ``item_id``. - - Args: - item_id: Identifier of instance to be deleted. - - Returns: - The deleted instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - - @abstractmethod - def delete_many(self, item_ids: list[Any]) -> list[T]: - """Delete multiple instances identified by list of IDs ``item_ids``. - - Args: - item_ids: list of Identifiers to be deleted. - - Returns: - The deleted instances. - """ - - @abstractmethod - def exists(self, *filters: FilterTypes, **kwargs: Any) -> bool: - """Return true if the object specified by ``kwargs`` exists. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - True if the instance was found. False if not found. - - """ - - @abstractmethod - def get(self, item_id: Any, **kwargs: Any) -> T: - """Get instance identified by ``item_id``. - - Args: - item_id: Identifier of the instance to be retrieved. - **kwargs: Additional arguments - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - - @abstractmethod - def get_one(self, **kwargs: Any) -> T: - """Get an instance specified by the ``kwargs`` filters if it exists. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``kwargs``. - """ - - @abstractmethod - def get_or_create(self, **kwargs: Any) -> tuple[T, bool]: - """Get an instance specified by the ``kwargs`` filters if it exists or create it. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - A tuple that includes the retrieved or created instance, and a boolean on whether the record was created or not - """ - - @abstractmethod - def get_one_or_none(self, **kwargs: Any) -> T | None: - """Get an instance if it exists or None. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None. - """ - - @abstractmethod - def update(self, data: T) -> T: - """Update instance with the attribute values present on ``data``. - - Args: - data: An instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - The updated instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - def update_many(self, data: list[T]) -> list[T]: - """Update multiple instances with the attribute values present on instances in ``data``. - - Args: - data: A list of instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - a list of the updated instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - def upsert(self, data: T) -> T: - """Update or create instance. - - Updates instance with the attribute values present on ``data``, or creates a new instance if - one doesn't exist. - - Args: - data: Instance to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on ``data`` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - def upsert_many(self, data: list[T]) -> list[T]: - """Update or create multiple instances. - - Update instances with the attribute values present on ``data``, or create a new instance if - one doesn't exist. - - Args: - data: Instances to update or created. Identifier used to determine if an - existing instance exists is the value of an attribute on ``data`` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - - @abstractmethod - def list_and_count(self, *filters: FilterTypes, **kwargs: Any) -> tuple[list[T], int]: - """List records with total count. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - a tuple containing The list of instances, after filtering applied, and a count of records returned by query, ignoring pagination. - """ - - @abstractmethod - def list(self, *filters: FilterTypes, **kwargs: Any) -> list[T]: - """Get a list of instances, optionally filtered. - - Args: - *filters: filters for specific filtering operations - **kwargs: Instance attribute value filters. - - Returns: - The list of instances, after filtering applied - """ - - @abstractmethod - def filter_collection_by_kwargs(self, collection: CollectionT, /, **kwargs: Any) -> CollectionT: - """Filter the collection by kwargs. - - Has ``AND`` semantics where multiple kwargs name/value pairs are provided. - - Args: - collection: the objects to be filtered - **kwargs: key/value pairs such that objects remaining in the collection after filtering - have the property that their attribute named ``key`` has value equal to ``value``. - - - Returns: - The filtered objects - - Raises: - RepositoryError: if a named attribute doesn't exist on :attr:`model_type `. - """ - - @staticmethod - def check_not_found(item_or_none: T | None) -> T: - """Raise :class:`NotFoundError` if ``item_or_none`` is ``None``. - - Args: - item_or_none: Item (:class:`T `) to be tested for existence. - - Returns: - The item, if it exists. - """ - if item_or_none is None: - raise NotFoundError("No item found when one was expected") - return item_or_none - - @classmethod - def get_id_attribute_value(cls, item: T | type[T], id_attribute: str | None = None) -> Any: - """Get value of attribute named as :attr:`id_attribute ` on ``item``. - - Args: - item: Anything that should have an attribute named as :attr:`id_attribute ` value. - id_attribute: Allows customization of the unique identifier to use for model fetching. - Defaults to `None`, but can reference any surrogate or candidate key for the table. - - Returns: - The value of attribute on ``item`` named as :attr:`id_attribute `. - """ - return getattr(item, id_attribute if id_attribute is not None else cls.id_attribute) - - @classmethod - def set_id_attribute_value(cls, item_id: Any, item: T, id_attribute: str | None = None) -> T: - """Return the ``item`` after the ID is set to the appropriate attribute. - - Args: - item_id: Value of ID to be set on instance - item: Anything that should have an attribute named as :attr:`id_attribute ` value. - id_attribute: Allows customization of the unique identifier to use for model fetching. - Defaults to `None`, but can reference any surrogate or candidate key for the table. - - Returns: - Item with ``item_id`` set to :attr:`id_attribute ` - """ - setattr(item, id_attribute if id_attribute is not None else cls.id_attribute, item_id) - return item diff --git a/venv/lib/python3.11/site-packages/litestar/repository/exceptions.py b/venv/lib/python3.11/site-packages/litestar/repository/exceptions.py deleted file mode 100644 index 8dad182..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/exceptions.py +++ /dev/null @@ -1,7 +0,0 @@ -try: - from advanced_alchemy.exceptions import IntegrityError as ConflictError - from advanced_alchemy.exceptions import NotFoundError, RepositoryError -except ImportError: # pragma: no cover - from ._exceptions import ConflictError, NotFoundError, RepositoryError # type: ignore[assignment] - -__all__ = ("ConflictError", "NotFoundError", "RepositoryError") diff --git a/venv/lib/python3.11/site-packages/litestar/repository/filters.py b/venv/lib/python3.11/site-packages/litestar/repository/filters.py deleted file mode 100644 index e0cce48..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/filters.py +++ /dev/null @@ -1,37 +0,0 @@ -try: - from advanced_alchemy.filters import ( - BeforeAfter, - CollectionFilter, - FilterTypes, - LimitOffset, - NotInCollectionFilter, - NotInSearchFilter, - OnBeforeAfter, - OrderBy, - SearchFilter, - ) -except ImportError: - from ._filters import ( # type: ignore[assignment] - BeforeAfter, - CollectionFilter, - FilterTypes, - LimitOffset, - NotInCollectionFilter, - NotInSearchFilter, - OnBeforeAfter, - OrderBy, - SearchFilter, - ) - - -__all__ = ( - "BeforeAfter", - "CollectionFilter", - "FilterTypes", - "LimitOffset", - "OrderBy", - "SearchFilter", - "NotInCollectionFilter", - "OnBeforeAfter", - "NotInSearchFilter", -) diff --git a/venv/lib/python3.11/site-packages/litestar/repository/handlers.py b/venv/lib/python3.11/site-packages/litestar/repository/handlers.py deleted file mode 100644 index 0bc1434..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/handlers.py +++ /dev/null @@ -1,37 +0,0 @@ -from typing import TYPE_CHECKING - -from litestar.repository.filters import ( - BeforeAfter, - CollectionFilter, - FilterTypes, - LimitOffset, - NotInCollectionFilter, - NotInSearchFilter, - OnBeforeAfter, - OrderBy, - SearchFilter, -) - -if TYPE_CHECKING: - from litestar.config.app import AppConfig - -__all__ = ("signature_namespace_values", "on_app_init") - -signature_namespace_values = { - "BeforeAfter": BeforeAfter, - "OnBeforeAfter": OnBeforeAfter, - "CollectionFilter": CollectionFilter, - "LimitOffset": LimitOffset, - "OrderBy": OrderBy, - "SearchFilter": SearchFilter, - "NotInCollectionFilter": NotInCollectionFilter, - "NotInSearchFilter": NotInSearchFilter, - "FilterTypes": FilterTypes, -} - - -def on_app_init(app_config: "AppConfig") -> "AppConfig": - """Add custom filters for the application during signature modelling.""" - - app_config.signature_namespace.update(signature_namespace_values) - return app_config diff --git a/venv/lib/python3.11/site-packages/litestar/repository/testing/__init__.py b/venv/lib/python3.11/site-packages/litestar/repository/testing/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index a008ff2..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/generic_mock_repository.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/generic_mock_repository.cpython-311.pyc deleted file mode 100644 index c871877..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/repository/testing/__pycache__/generic_mock_repository.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/repository/testing/generic_mock_repository.py b/venv/lib/python3.11/site-packages/litestar/repository/testing/generic_mock_repository.py deleted file mode 100644 index 5aa094c..0000000 --- a/venv/lib/python3.11/site-packages/litestar/repository/testing/generic_mock_repository.py +++ /dev/null @@ -1,784 +0,0 @@ -"""A repository implementation for tests. - -Uses a `dict` for storage. -""" - -from __future__ import annotations - -from datetime import datetime, timezone, tzinfo -from typing import TYPE_CHECKING, Generic, Protocol, TypeVar -from uuid import uuid4 - -from litestar.repository import AbstractAsyncRepository, AbstractSyncRepository, FilterTypes -from litestar.repository.exceptions import ConflictError, RepositoryError - -if TYPE_CHECKING: - from collections.abc import Callable, Hashable, Iterable, MutableMapping - from typing import Any - -__all__ = ("GenericAsyncMockRepository", "GenericSyncMockRepository") - - -class HasID(Protocol): - id: Any - - -ModelT = TypeVar("ModelT", bound="HasID") -AsyncMockRepoT = TypeVar("AsyncMockRepoT", bound="GenericAsyncMockRepository") -SyncMockRepoT = TypeVar("SyncMockRepoT", bound="GenericSyncMockRepository") - - -class GenericAsyncMockRepository(AbstractAsyncRepository[ModelT], Generic[ModelT]): - """A repository implementation for tests. - - Uses a :class:`dict` for storage. - """ - - collection: MutableMapping[Hashable, ModelT] - model_type: type[ModelT] - match_fields: list[str] | str | None = None - - _model_has_created_at: bool - _model_has_updated_at: bool - - def __init__( - self, id_factory: Callable[[], Any] = uuid4, tz: tzinfo = timezone.utc, allow_ids_on_add: bool = False, **_: Any - ) -> None: - super().__init__() - self._id_factory = id_factory - self.tz = tz - self.allow_ids_on_add = allow_ids_on_add - - @classmethod - def __class_getitem__(cls: type[AsyncMockRepoT], item: type[ModelT]) -> type[AsyncMockRepoT]: - """Add collection to ``_collections`` for the type. - - Args: - item: The type that the class has been parametrized with. - """ - return type( # pyright:ignore - f"{cls.__name__}[{item.__name__}]", - (cls,), - { - "collection": {}, - "model_type": item, - "_model_has_created_at": hasattr(item, "created_at"), - "_model_has_updated_at": hasattr(item, "updated_at"), - }, - ) - - def _find_or_raise_not_found(self, item_id: Any) -> ModelT: - return self.check_not_found(self.collection.get(item_id)) - - def _find_or_none(self, item_id: Any) -> ModelT | None: - return self.collection.get(item_id) - - def _now(self) -> datetime: - return datetime.now(tz=self.tz).replace(tzinfo=None) - - def _update_audit_attributes(self, data: ModelT, now: datetime | None = None, do_created: bool = False) -> ModelT: - now = now or self._now() - if self._model_has_updated_at: - data.updated_at = now # type:ignore[attr-defined] - if do_created: - data.created_at = now # type:ignore[attr-defined] - return data - - async def add(self, data: ModelT) -> ModelT: - """Add ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - if self.allow_ids_on_add is False and self.get_id_attribute_value(data) is not None: - raise ConflictError("`add()` received identified item.") - self._update_audit_attributes(data, do_created=True) - if self.allow_ids_on_add is False: - id_ = self._id_factory() - self.set_id_attribute_value(id_, data) - self.collection[data.id] = data - return data - - async def add_many(self, data: Iterable[ModelT]) -> list[ModelT]: - """Add multiple ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - now = self._now() - for data_row in data: - if self.allow_ids_on_add is False and self.get_id_attribute_value(data_row) is not None: - raise ConflictError("`add()` received identified item.") - - self._update_audit_attributes(data_row, do_created=True, now=now) - if self.allow_ids_on_add is False: - id_ = self._id_factory() - self.set_id_attribute_value(id_, data_row) - self.collection[data_row.id] = data_row - return list(data) - - async def delete(self, item_id: Any) -> ModelT: - """Delete instance identified by ``item_id``. - - Args: - item_id: Identifier of instance to be deleted. - - Returns: - The deleted instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - try: - return self._find_or_raise_not_found(item_id) - finally: - del self.collection[item_id] - - async def delete_many(self, item_ids: list[Any]) -> list[ModelT]: - """Delete instances identified by list of identifiers ``item_ids``. - - Args: - item_ids: list of identifiers of instances to be deleted. - - Returns: - The deleted instances. - - """ - instances: list[ModelT] = [] - for item_id in item_ids: - obj = await self.get_one_or_none(**{self.id_attribute: item_id}) - if obj: - obj = await self.delete(obj.id) - instances.append(obj) - return instances - - async def exists(self, *filters: FilterTypes, **kwargs: Any) -> bool: - """Return true if the object specified by ``kwargs`` exists. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - True if the instance was found. False if not found.. - - """ - existing = await self.count(*filters, **kwargs) - return bool(existing) - - async def get(self, item_id: Any, **kwargs: Any) -> ModelT: - """Get instance identified by ``item_id``. - - Args: - item_id: Identifier of the instance to be retrieved. - **kwargs: additional arguments - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - return self._find_or_raise_not_found(item_id) - - async def get_or_create(self, match_fields: list[str] | str | None = None, **kwargs: Any) -> tuple[ModelT, bool]: - """Get instance identified by ``kwargs`` or create if it doesn't exist. - - Args: - match_fields: a list of keys to use to match the existing model. When empty, all fields are matched. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - a tuple that includes the instance and whether it needed to be created. - - """ - match_fields = match_fields or self.match_fields - if isinstance(match_fields, str): - match_fields = [match_fields] - if match_fields: - match_filter = { - field_name: field_value - for field_name in match_fields - if (field_value := kwargs.get(field_name)) is not None - } - else: - match_filter = kwargs - existing = await self.get_one_or_none(**match_filter) - if existing: - for field_name, new_field_value in kwargs.items(): - field = getattr(existing, field_name, None) - if field and field != new_field_value: - setattr(existing, field_name, new_field_value) - - return existing, False - return await self.add(self.model_type(**kwargs)), True # pyright: ignore[reportGeneralTypeIssues] - - async def get_one(self, **kwargs: Any) -> ModelT: - """Get instance identified by query filters. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None - - Raises: - NotFoundError: If no instance found identified by ``kwargs``. - """ - data = await self.list(**kwargs) - return self.check_not_found(data[0] if data else None) - - async def get_one_or_none(self, **kwargs: Any) -> ModelT | None: - """Get instance identified by query filters or None if not found. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None - """ - data = await self.list(**kwargs) - return data[0] if data else None - - async def count(self, *filters: FilterTypes, **kwargs: Any) -> int: - """Count of rows returned by query. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - Count of instances in collection, ignoring pagination. - """ - return len(await self.list(*filters, **kwargs)) - - async def update(self, data: ModelT) -> ModelT: - """Update instance with the attribute values present on ``data``. - - Args: - data: An instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - The updated instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - item = self._find_or_raise_not_found(self.get_id_attribute_value(data)) - self._update_audit_attributes(data, do_created=False) - for key, val in model_items(data): - setattr(item, key, val) - return item - - async def update_many(self, data: list[ModelT]) -> list[ModelT]: - """Update instances with the attribute values present on ``data``. - - Args: - data: A list of instances that should have a value for :attr:`id_attribute ` - that exists in the collection. - - Returns: - The updated instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - items = [self._find_or_raise_not_found(self.get_id_attribute_value(row)) for row in data] - now = self._now() - for item in items: - self._update_audit_attributes(item, do_created=False, now=now) - for key, val in model_items(item): - setattr(item, key, val) - return items - - async def upsert(self, data: ModelT) -> ModelT: - """Update or create instance. - - Updates instance with the attribute values present on ``data``, or creates a new instance if - one doesn't exist. - - Args: - data: Instance to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on `data` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - item_id = self.get_id_attribute_value(data) - if item_id in self.collection: - return await self.update(data) - return await self.add(data) - - async def upsert_many(self, data: list[ModelT]) -> list[ModelT]: - """Update or create multiple instance. - - Update instance with the attribute values present on ``data``, or create a new instance if - one doesn't exist. - - Args: - data: List of instances to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on `data` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instances. - """ - data_to_update = [row for row in data if self._find_or_none(self.get_id_attribute_value(row)) is not None] - data_to_add = [row for row in data if self._find_or_none(self.get_id_attribute_value(row)) is None] - - updated_items = await self.update_many(data_to_update) - added_items = await self.add_many(data_to_add) - return updated_items + added_items - - async def list_and_count( - self, - *filters: FilterTypes, - **kwargs: Any, - ) -> tuple[list[ModelT], int]: - """Get a list of instances, optionally filtered with a total row count. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - List of instances, and count of records returned by query, ignoring pagination. - """ - return await self.list(*filters, **kwargs), await self.count(*filters, **kwargs) - - async def list(self, *filters: FilterTypes, **kwargs: Any) -> list[ModelT]: - """Get a list of instances, optionally filtered. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - The list of instances, after filtering applied. - """ - return list(self.filter_collection_by_kwargs(self.collection, **kwargs).values()) - - def filter_collection_by_kwargs( # type:ignore[override] - self, collection: MutableMapping[Hashable, ModelT], /, **kwargs: Any - ) -> MutableMapping[Hashable, ModelT]: - """Filter the collection by kwargs. - - Args: - collection: set of objects to filter - **kwargs: key/value pairs such that objects remaining in the collection after filtering - have the property that their attribute named ``key`` has value equal to ``value``. - """ - new_collection: dict[Hashable, ModelT] = {} - for item in self.collection.values(): - try: - if all(getattr(item, name) == value for name, value in kwargs.items()): - new_collection[item.id] = item - except AttributeError as orig: - raise RepositoryError from orig - return new_collection - - @classmethod - def seed_collection(cls, instances: Iterable[ModelT]) -> None: - """Seed the collection for repository type. - - Args: - instances: the instances to be added to the collection. - """ - for instance in instances: - cls.collection[cls.get_id_attribute_value(instance)] = instance - - @classmethod - def clear_collection(cls) -> None: - """Empty the collection for repository type.""" - cls.collection = {} - - -class GenericSyncMockRepository(AbstractSyncRepository[ModelT], Generic[ModelT]): - """A repository implementation for tests. - - Uses a :class:`dict` for storage. - """ - - collection: MutableMapping[Hashable, ModelT] - model_type: type[ModelT] - match_fields: list[str] | str | None = None - - _model_has_created_at: bool - _model_has_updated_at: bool - - def __init__( - self, - id_factory: Callable[[], Any] = uuid4, - tz: tzinfo = timezone.utc, - allow_ids_on_add: bool = False, - **_: Any, - ) -> None: - super().__init__() - self._id_factory = id_factory - self.tz = tz - self.allow_ids_on_add = allow_ids_on_add - - @classmethod - def __class_getitem__(cls: type[SyncMockRepoT], item: type[ModelT]) -> type[SyncMockRepoT]: - """Add collection to ``_collections`` for the type. - - Args: - item: The type that the class has been parametrized with. - """ - return type( # pyright:ignore - f"{cls.__name__}[{item.__name__}]", - (cls,), - { - "collection": {}, - "model_type": item, - "_model_has_created_at": hasattr(item, "created_at"), - "_model_has_updated_at": hasattr(item, "updated_at"), - }, - ) - - def _find_or_raise_not_found(self, item_id: Any) -> ModelT: - return self.check_not_found(self.collection.get(item_id)) - - def _find_or_none(self, item_id: Any) -> ModelT | None: - return self.collection.get(item_id) - - def _now(self) -> datetime: - return datetime.now(tz=self.tz).replace(tzinfo=None) - - def _update_audit_attributes(self, data: ModelT, now: datetime | None = None, do_created: bool = False) -> ModelT: - now = now or self._now() - if self._model_has_updated_at: - data.updated_at = now # type:ignore[attr-defined] - if do_created: - data.created_at = now # type:ignore[attr-defined] - return data - - def add(self, data: ModelT) -> ModelT: - """Add ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - if self.allow_ids_on_add is False and self.get_id_attribute_value(data) is not None: - raise ConflictError("`add()` received identified item.") - self._update_audit_attributes(data, do_created=True) - if self.allow_ids_on_add is False: - id_ = self._id_factory() - self.set_id_attribute_value(id_, data) - self.collection[data.id] = data - return data - - def add_many(self, data: Iterable[ModelT]) -> list[ModelT]: - """Add multiple ``data`` to the collection. - - Args: - data: Instance to be added to the collection. - - Returns: - The added instance. - """ - now = self._now() - for data_row in data: - if self.allow_ids_on_add is False and self.get_id_attribute_value(data_row) is not None: - raise ConflictError("`add()` received identified item.") - - self._update_audit_attributes(data_row, do_created=True, now=now) - if self.allow_ids_on_add is False: - id_ = self._id_factory() - self.set_id_attribute_value(id_, data_row) - self.collection[data_row.id] = data_row - return list(data) - - def delete(self, item_id: Any) -> ModelT: - """Delete instance identified by ``item_id``. - - Args: - item_id: Identifier of instance to be deleted. - - Returns: - The deleted instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - try: - return self._find_or_raise_not_found(item_id) - finally: - del self.collection[item_id] - - def delete_many(self, item_ids: list[Any]) -> list[ModelT]: - """Delete instances identified by list of identifiers ``item_ids``. - - Args: - item_ids: list of identifiers of instances to be deleted. - - Returns: - The deleted instances. - - """ - instances: list[ModelT] = [] - for item_id in item_ids: - if obj := self.get_one_or_none(**{self.id_attribute: item_id}): - obj = self.delete(obj.id) - instances.append(obj) - return instances - - def exists(self, *filters: FilterTypes, **kwargs: Any) -> bool: - """Return true if the object specified by ``kwargs`` exists. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - True if the instance was found. False if not found.. - - """ - existing = self.count(*filters, **kwargs) - return bool(existing) - - def get(self, item_id: Any, **kwargs: Any) -> ModelT: - """Get instance identified by ``item_id``. - - Args: - item_id: Identifier of the instance to be retrieved. - **kwargs: additional arguments - - Returns: - The retrieved instance. - - Raises: - NotFoundError: If no instance found identified by ``item_id``. - """ - return self._find_or_raise_not_found(item_id) - - def get_or_create(self, match_fields: list[str] | str | None = None, **kwargs: Any) -> tuple[ModelT, bool]: - """Get instance identified by ``kwargs`` or create if it doesn't exist. - - Args: - match_fields: a list of keys to use to match the existing model. When empty, all fields are matched. - **kwargs: Identifier of the instance to be retrieved. - - Returns: - a tuple that includes the instance and whether it needed to be created. - - """ - match_fields = match_fields or self.match_fields - if isinstance(match_fields, str): - match_fields = [match_fields] - if match_fields: - match_filter = { - field_name: field_value - for field_name in match_fields - if (field_value := kwargs.get(field_name)) is not None - } - else: - match_filter = kwargs - if existing := self.get_one_or_none(**match_filter): - for field_name, new_field_value in kwargs.items(): - field = getattr(existing, field_name, None) - if field and field != new_field_value: - setattr(existing, field_name, new_field_value) - - return existing, False - return self.add(self.model_type(**kwargs)), True # pyright: ignore[reportGeneralTypeIssues] - - def get_one(self, **kwargs: Any) -> ModelT: - """Get instance identified by query filters. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None - - Raises: - NotFoundError: If no instance found identified by ``kwargs``. - """ - data = self.list(**kwargs) - return self.check_not_found(data[0] if data else None) - - def get_one_or_none(self, **kwargs: Any) -> ModelT | None: - """Get instance identified by query filters or None if not found. - - Args: - **kwargs: Instance attribute value filters. - - Returns: - The retrieved instance or None - """ - data = self.list(**kwargs) - return data[0] if data else None - - def count(self, *filters: FilterTypes, **kwargs: Any) -> int: - """Count of rows returned by query. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - Count of instances in collection, ignoring pagination. - """ - return len(self.list(*filters, **kwargs)) - - def update(self, data: ModelT) -> ModelT: - """Update instance with the attribute values present on ``data``. - - Args: - data: An instance that should have a value for :attr:`id_attribute ` that exists in the - collection. - - Returns: - The updated instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - item = self._find_or_raise_not_found(self.get_id_attribute_value(data)) - self._update_audit_attributes(data, do_created=False) - for key, val in model_items(data): - setattr(item, key, val) - return item - - def update_many(self, data: list[ModelT]) -> list[ModelT]: - """Update instances with the attribute values present on ``data``. - - Args: - data: A list of instances that should have a value for :attr:`id_attribute ` - that exists in the collection. - - Returns: - The updated instances. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - items = [self._find_or_raise_not_found(self.get_id_attribute_value(row)) for row in data] - now = self._now() - for item in items: - self._update_audit_attributes(item, do_created=False, now=now) - for key, val in model_items(item): - setattr(item, key, val) - return items - - def upsert(self, data: ModelT) -> ModelT: - """Update or create instance. - - Updates instance with the attribute values present on ``data``, or creates a new instance if - one doesn't exist. - - Args: - data: Instance to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on `data` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instance. - - Raises: - NotFoundError: If no instance found with same identifier as ``data``. - """ - item_id = self.get_id_attribute_value(data) - return self.update(data) if item_id in self.collection else self.add(data) - - def upsert_many(self, data: list[ModelT]) -> list[ModelT]: - """Update or create multiple instance. - - Update instance with the attribute values present on ``data``, or create a new instance if - one doesn't exist. - - Args: - data: List of instances to update existing, or be created. Identifier used to determine if an - existing instance exists is the value of an attribute on `data` named as value of - :attr:`id_attribute `. - - Returns: - The updated or created instances. - """ - data_to_update = [row for row in data if self._find_or_none(self.get_id_attribute_value(row)) is not None] - data_to_add = [row for row in data if self._find_or_none(self.get_id_attribute_value(row)) is None] - - updated_items = self.update_many(data_to_update) - added_items = self.add_many(data_to_add) - return updated_items + added_items - - def list_and_count( - self, - *filters: FilterTypes, - **kwargs: Any, - ) -> tuple[list[ModelT], int]: - """Get a list of instances, optionally filtered with a total row count. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - List of instances, and count of records returned by query, ignoring pagination. - """ - return self.list(*filters, **kwargs), self.count(*filters, **kwargs) - - def list(self, *filters: FilterTypes, **kwargs: Any) -> list[ModelT]: - """Get a list of instances, optionally filtered. - - Args: - *filters: Types for specific filtering operations. - **kwargs: Instance attribute value filters. - - Returns: - The list of instances, after filtering applied. - """ - return list(self.filter_collection_by_kwargs(self.collection, **kwargs).values()) - - def filter_collection_by_kwargs( # type:ignore[override] - self, collection: MutableMapping[Hashable, ModelT], /, **kwargs: Any - ) -> MutableMapping[Hashable, ModelT]: - """Filter the collection by kwargs. - - Args: - collection: set of objects to filter - **kwargs: key/value pairs such that objects remaining in the collection after filtering - have the property that their attribute named ``key`` has value equal to ``value``. - """ - new_collection: dict[Hashable, ModelT] = {} - for item in self.collection.values(): - try: - if all(getattr(item, name) == value for name, value in kwargs.items()): - new_collection[item.id] = item - except AttributeError as orig: - raise RepositoryError from orig - return new_collection - - @classmethod - def seed_collection(cls, instances: Iterable[ModelT]) -> None: - """Seed the collection for repository type. - - Args: - instances: the instances to be added to the collection. - """ - for instance in instances: - cls.collection[cls.get_id_attribute_value(instance)] = instance - - @classmethod - def clear_collection(cls) -> None: - """Empty the collection for repository type.""" - cls.collection = {} - - -def model_items(model: Any) -> list[tuple[str, Any]]: - return [(k, v) for k, v in model.__dict__.items() if not k.startswith("_")] diff --git a/venv/lib/python3.11/site-packages/litestar/response/__init__.py b/venv/lib/python3.11/site-packages/litestar/response/__init__.py deleted file mode 100644 index c655758..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ -from .base import Response -from .file import File -from .redirect import Redirect -from .sse import ServerSentEvent, ServerSentEventMessage -from .streaming import Stream -from .template import Template - -__all__ = ( - "File", - "Redirect", - "Response", - "ServerSentEvent", - "ServerSentEventMessage", - "Stream", - "Template", -) diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index a806282..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 885cbe8..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/file.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/file.cpython-311.pyc deleted file mode 100644 index 23c09f2..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/file.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/redirect.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/redirect.cpython-311.pyc deleted file mode 100644 index d776095..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/redirect.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/sse.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/sse.cpython-311.pyc deleted file mode 100644 index 2a03883..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/sse.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/streaming.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/streaming.cpython-311.pyc deleted file mode 100644 index 350cf9e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/streaming.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/template.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/response/__pycache__/template.cpython-311.pyc deleted file mode 100644 index 91dde51..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/response/__pycache__/template.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/response/base.py b/venv/lib/python3.11/site-packages/litestar/response/base.py deleted file mode 100644 index 67eec09..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/base.py +++ /dev/null @@ -1,459 +0,0 @@ -from __future__ import annotations - -import itertools -import re -from typing import TYPE_CHECKING, Any, ClassVar, Generic, Iterable, Literal, Mapping, TypeVar, overload - -from litestar.datastructures.cookie import Cookie -from litestar.datastructures.headers import ETag, MutableScopeHeaders -from litestar.enums import MediaType, OpenAPIMediaType -from litestar.exceptions import ImproperlyConfiguredException -from litestar.serialization import default_serializer, encode_json, encode_msgpack, get_serializer -from litestar.status_codes import HTTP_200_OK, HTTP_204_NO_CONTENT, HTTP_304_NOT_MODIFIED -from litestar.types.empty import Empty -from litestar.utils.deprecation import deprecated, warn_deprecation -from litestar.utils.helpers import get_enum_string_value - -if TYPE_CHECKING: - from typing import Optional - - from litestar.app import Litestar - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.connection import Request - from litestar.types import ( - HTTPResponseBodyEvent, - HTTPResponseStartEvent, - Receive, - ResponseCookies, - ResponseHeaders, - Scope, - Send, - Serializer, - TypeEncodersMap, - ) - -__all__ = ("ASGIResponse", "Response") - -T = TypeVar("T") - -MEDIA_TYPE_APPLICATION_JSON_PATTERN = re.compile(r"^application/(?:.+\+)?json") - - -class ASGIResponse: - """A low-level ASGI response class.""" - - __slots__ = ( - "background", - "body", - "content_length", - "encoding", - "is_head_response", - "status_code", - "_encoded_cookies", - "headers", - ) - - _should_set_content_length: ClassVar[bool] = True - """A flag to indicate whether the content-length header should be set by default or not.""" - - def __init__( - self, - *, - background: BackgroundTask | BackgroundTasks | None = None, - body: bytes | str = b"", - content_length: int | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - encoding: str = "utf-8", - headers: dict[str, Any] | Iterable[tuple[str, str]] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - ) -> None: - """A low-level ASGI response class. - - Args: - background: A background task or a list of background tasks to be executed after the response is sent. - body: encoded content to send in the response body. - content_length: The response content length. - cookies: The response cookies. - encoded_headers: The response headers. - encoding: The response encoding. - headers: The response headers. - is_head_response: A boolean indicating if the response is a HEAD response. - media_type: The response media type. - status_code: The response status code. - """ - body = body.encode() if isinstance(body, str) else body - status_code = status_code or HTTP_200_OK - self.headers = MutableScopeHeaders() - - if encoded_headers is not None: - warn_deprecation("3.0", kind="parameter", deprecated_name="encoded_headers", alternative="headers") - for header_name, header_value in encoded_headers: - self.headers.add(header_name.decode("latin-1"), header_value.decode("latin-1")) - - if headers is not None: - for k, v in headers.items() if isinstance(headers, dict) else headers: - self.headers.add(k, v) # pyright: ignore - - media_type = get_enum_string_value(media_type or MediaType.JSON) - - status_allows_body = ( - status_code not in {HTTP_204_NO_CONTENT, HTTP_304_NOT_MODIFIED} and status_code >= HTTP_200_OK - ) - - if content_length is None: - content_length = len(body) - - if not status_allows_body or is_head_response: - if body and body != b"null": - raise ImproperlyConfiguredException( - "response content is not supported for HEAD responses and responses with a status code " - "that does not allow content (304, 204, < 200)" - ) - body = b"" - else: - self.headers.setdefault( - "content-type", (f"{media_type}; charset={encoding}" if media_type.startswith("text/") else media_type) - ) - - if self._should_set_content_length: - self.headers.setdefault("content-length", str(content_length)) - - self.background = background - self.body = body - self.content_length = content_length - self._encoded_cookies = tuple( - cookie.to_encoded_header() for cookie in (cookies or ()) if not cookie.documentation_only - ) - self.encoding = encoding - self.is_head_response = is_head_response - self.status_code = status_code - - @property - @deprecated("3.0", kind="property", alternative="encode_headers()") - def encoded_headers(self) -> list[tuple[bytes, bytes]]: - return self.encode_headers() - - def encode_headers(self) -> list[tuple[bytes, bytes]]: - return [*self.headers.headers, *self._encoded_cookies] - - async def after_response(self) -> None: - """Execute after the response is sent. - - Returns: - None - """ - if self.background is not None: - await self.background() - - async def start_response(self, send: Send) -> None: - """Emit the start event of the response. This event includes the headers and status codes. - - Args: - send: The ASGI send function. - - Returns: - None - """ - event: HTTPResponseStartEvent = { - "type": "http.response.start", - "status": self.status_code, - "headers": self.encode_headers(), - } - await send(event) - - async def send_body(self, send: Send, receive: Receive) -> None: - """Emit the response body. - - Args: - send: The ASGI send function. - receive: The ASGI receive function. - - Notes: - - Response subclasses should customize this method if there is a need to customize sending data. - - Returns: - None - """ - event: HTTPResponseBodyEvent = {"type": "http.response.body", "body": self.body, "more_body": False} - await send(event) - - async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: - """ASGI callable of the ``Response``. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - await self.start_response(send=send) - - if self.is_head_response: - event: HTTPResponseBodyEvent = {"type": "http.response.body", "body": b"", "more_body": False} - await send(event) - else: - await self.send_body(send=send, receive=receive) - - await self.after_response() - - -class Response(Generic[T]): - """Base Litestar HTTP response class, used as the basis for all other response classes.""" - - __slots__ = ( - "background", - "content", - "cookies", - "encoding", - "headers", - "media_type", - "status_code", - "response_type_encoders", - ) - - content: T - type_encoders: Optional[TypeEncodersMap] = None # noqa: UP007 - - def __init__( - self, - content: T, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - headers: ResponseHeaders | None = None, - media_type: MediaType | OpenAPIMediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> None: - """Initialize the response. - - Args: - content: A value for the response body that will be rendered into bytes string. - status_code: An HTTP status code. - media_type: A value for the response ``Content-Type`` header. - background: A :class:`BackgroundTask <.background_tasks.BackgroundTask>` instance or - :class:`BackgroundTasks <.background_tasks.BackgroundTasks>` to execute after the response is finished. - Defaults to ``None``. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: The encoding to be used for the response headers. - type_encoders: A mapping of types to callables that transform them into types supported for serialization. - """ - self.content = content - self.background = background - self.cookies: list[Cookie] = ( - [Cookie(key=key, value=value) for key, value in cookies.items()] - if isinstance(cookies, Mapping) - else list(cookies or []) - ) - self.encoding = encoding - self.headers: dict[str, Any] = ( - dict(headers) if isinstance(headers, Mapping) else {h.name: h.value for h in headers or {}} - ) - self.media_type = media_type - self.status_code = status_code - self.response_type_encoders = {**(self.type_encoders or {}), **(type_encoders or {})} - - @overload - def set_cookie(self, /, cookie: Cookie) -> None: ... - - @overload - def set_cookie( - self, - key: str, - value: str | None = None, - max_age: int | None = None, - expires: int | None = None, - path: str = "/", - domain: str | None = None, - secure: bool = False, - httponly: bool = False, - samesite: Literal["lax", "strict", "none"] = "lax", - ) -> None: ... - - def set_cookie( # type: ignore[misc] - self, - key: str | Cookie, - value: str | None = None, - max_age: int | None = None, - expires: int | None = None, - path: str = "/", - domain: str | None = None, - secure: bool = False, - httponly: bool = False, - samesite: Literal["lax", "strict", "none"] = "lax", - ) -> None: - """Set a cookie on the response. If passed a :class:`Cookie <.datastructures.Cookie>` instance, keyword - arguments will be ignored. - - Args: - key: Key for the cookie or a :class:`Cookie <.datastructures.Cookie>` instance. - value: Value for the cookie, if none given defaults to empty string. - max_age: Maximal age of the cookie before its invalidated. - expires: Seconds from now until the cookie expires. - path: Path fragment that must exist in the request url for the cookie to be valid. Defaults to ``/``. - domain: Domain for which the cookie is valid. - secure: Https is required for the cookie. - httponly: Forbids javascript to access the cookie via ``document.cookie``. - samesite: Controls whether a cookie is sent with cross-site requests. Defaults to ``lax``. - - Returns: - None. - """ - if not isinstance(key, Cookie): - key = Cookie( - domain=domain, - expires=expires, - httponly=httponly, - key=key, - max_age=max_age, - path=path, - samesite=samesite, - secure=secure, - value=value, - ) - self.cookies.append(key) - - def set_header(self, key: str, value: Any) -> None: - """Set a header on the response. - - Args: - key: Header key. - value: Header value. - - Returns: - None. - """ - self.headers[key] = value - - def set_etag(self, etag: str | ETag) -> None: - """Set an etag header. - - Args: - etag: An etag value. - - Returns: - None - """ - self.headers["etag"] = etag.to_header() if isinstance(etag, ETag) else etag - - def delete_cookie( - self, - key: str, - path: str = "/", - domain: str | None = None, - ) -> None: - """Delete a cookie. - - Args: - key: Key of the cookie. - path: Path of the cookie. - domain: Domain of the cookie. - - Returns: - None. - """ - cookie = Cookie(key=key, path=path, domain=domain, expires=0, max_age=0) - self.cookies = [c for c in self.cookies if c != cookie] - self.cookies.append(cookie) - - def render(self, content: Any, media_type: str, enc_hook: Serializer = default_serializer) -> bytes: - """Handle the rendering of content into a bytes string. - - Returns: - An encoded bytes string - """ - if isinstance(content, bytes): - return content - - if content is Empty: - raise RuntimeError("The `Empty` sentinel cannot be used as response content") - - try: - if media_type.startswith("text/") and not content: - return b"" - - if isinstance(content, str): - return content.encode(self.encoding) - - if media_type == MediaType.MESSAGEPACK: - return encode_msgpack(content, enc_hook) - - if MEDIA_TYPE_APPLICATION_JSON_PATTERN.match( - media_type, - ): - return encode_json(content, enc_hook) - - raise ImproperlyConfiguredException(f"unsupported media_type {media_type} for content {content!r}") - except (AttributeError, ValueError, TypeError) as e: - raise ImproperlyConfiguredException("Unable to serialize response content") from e - - def to_asgi_response( - self, - app: Litestar | None, - request: Request, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> ASGIResponse: - """Create an ASGIResponse from a Response instance. - - Args: - app: The :class:`Litestar <.app.Litestar>` application instance. - background: Background task(s) to be executed after the response is sent. - cookies: A list of cookies to be set on the response. - encoded_headers: A list of already encoded headers. - headers: Additional headers to be merged with the response headers. Response headers take precedence. - is_head_response: Whether the response is a HEAD response. - media_type: Media type for the response. If ``media_type`` is already set on the response, this is ignored. - request: The :class:`Request <.connection.Request>` instance. - status_code: Status code for the response. If ``status_code`` is already set on the response, this is - type_encoders: A dictionary of type encoders to use for encoding the response content. - - Returns: - An ASGIResponse instance. - """ - - if app is not None: - warn_deprecation( - version="2.1", - deprecated_name="app", - kind="parameter", - removal_in="3.0.0", - alternative="request.app", - ) - - headers = {**headers, **self.headers} if headers is not None else self.headers - cookies = self.cookies if cookies is None else itertools.chain(self.cookies, cookies) - - if type_encoders: - type_encoders = {**type_encoders, **(self.response_type_encoders or {})} - else: - type_encoders = self.response_type_encoders - - media_type = get_enum_string_value(self.media_type or media_type or MediaType.JSON) - - return ASGIResponse( - background=self.background or background, - body=self.render(self.content, media_type, get_serializer(type_encoders)), - cookies=cookies, - encoded_headers=encoded_headers, - encoding=self.encoding, - headers=headers, - is_head_response=is_head_response, - media_type=media_type, - status_code=self.status_code or status_code, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/response/file.py b/venv/lib/python3.11/site-packages/litestar/response/file.py deleted file mode 100644 index 1fc6f86..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/file.py +++ /dev/null @@ -1,386 +0,0 @@ -from __future__ import annotations - -import itertools -from email.utils import formatdate -from inspect import iscoroutine -from mimetypes import encodings_map, guess_type -from typing import TYPE_CHECKING, Any, AsyncGenerator, Coroutine, Iterable, Literal, cast -from urllib.parse import quote -from zlib import adler32 - -from litestar.constants import ONE_MEGABYTE -from litestar.exceptions import ImproperlyConfiguredException -from litestar.file_system import BaseLocalFileSystem, FileSystemAdapter -from litestar.response.base import Response -from litestar.response.streaming import ASGIStreamingResponse -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.helpers import get_enum_string_value - -if TYPE_CHECKING: - from os import PathLike - from os import stat_result as stat_result_type - - from anyio import Path - - from litestar.app import Litestar - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.connection import Request - from litestar.datastructures.cookie import Cookie - from litestar.datastructures.headers import ETag - from litestar.enums import MediaType - from litestar.types import ( - HTTPResponseBodyEvent, - PathType, - Receive, - ResponseCookies, - ResponseHeaders, - Send, - TypeEncodersMap, - ) - from litestar.types.file_types import FileInfo, FileSystemProtocol - -__all__ = ( - "ASGIFileResponse", - "File", - "async_file_iterator", - "create_etag_for_file", -) - -# brotli not supported in 'mimetypes.encodings_map' until py 3.9. -encodings_map[".br"] = "br" - - -async def async_file_iterator( - file_path: PathType, chunk_size: int, adapter: FileSystemAdapter -) -> AsyncGenerator[bytes, None]: - """Return an async that asynchronously reads a file and yields its chunks. - - Args: - file_path: A path to a file. - chunk_size: The chunk file to use. - adapter: File system adapter class. - adapter: File system adapter class. - - Returns: - An async generator. - """ - async with await adapter.open(file_path) as file: - while chunk := await file.read(chunk_size): - yield chunk - - -def create_etag_for_file(path: PathType, modified_time: float, file_size: int) -> str: - """Create an etag. - - Notes: - - Function is derived from flask. - - Returns: - An etag. - """ - check = adler32(str(path).encode("utf-8")) & 0xFFFFFFFF - return f'"{modified_time}-{file_size}-{check}"' - - -class ASGIFileResponse(ASGIStreamingResponse): - """A low-level ASGI response, streaming a file as response body.""" - - def __init__( - self, - *, - background: BackgroundTask | BackgroundTasks | None = None, - body: bytes | str = b"", - chunk_size: int = ONE_MEGABYTE, - content_disposition_type: Literal["attachment", "inline"] = "attachment", - content_length: int | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - encoding: str = "utf-8", - etag: ETag | None = None, - file_info: FileInfo | Coroutine[None, None, FileInfo] | None = None, - file_path: str | PathLike | Path, - file_system: FileSystemProtocol | None = None, - filename: str = "", - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - stat_result: stat_result_type | None = None, - status_code: int | None = None, - ) -> None: - """A low-level ASGI response, streaming a file as response body. - - Args: - background: A background task or a list of background tasks to be executed after the response is sent. - body: encoded content to send in the response body. - chunk_size: The chunk size to use. - content_disposition_type: The type of the ``Content-Disposition``. Either ``inline`` or ``attachment``. - content_length: The response content length. - cookies: The response cookies. - encoded_headers: A list of encoded headers. - encoding: The response encoding. - etag: An etag. - file_info: A file info. - file_path: A path to a file. - file_system: A file system adapter. - filename: The name of the file. - headers: A dictionary of headers. - headers: The response headers. - is_head_response: A boolean indicating if the response is a HEAD response. - media_type: The media type of the file. - stat_result: A stat result. - status_code: The response status code. - """ - headers = headers or {} - if not media_type: - mimetype, content_encoding = guess_type(filename) if filename else (None, None) - media_type = mimetype or "application/octet-stream" - if content_encoding is not None: - headers.update({"content-encoding": content_encoding}) - - self.adapter = FileSystemAdapter(file_system or BaseLocalFileSystem()) - - super().__init__( - iterator=async_file_iterator(file_path=file_path, chunk_size=chunk_size, adapter=self.adapter), - headers=headers, - media_type=media_type, - cookies=cookies, - background=background, - status_code=status_code, - body=body, - content_length=content_length, - encoding=encoding, - is_head_response=is_head_response, - encoded_headers=encoded_headers, - ) - - quoted_filename = quote(filename) - is_utf8 = quoted_filename == filename - if is_utf8: - content_disposition = f'{content_disposition_type}; filename="{filename}"' - else: - content_disposition = f"{content_disposition_type}; filename*=utf-8''{quoted_filename}" - - self.headers.setdefault("content-disposition", content_disposition) - - self.chunk_size = chunk_size - self.etag = etag - self.file_path = file_path - - if file_info: - self.file_info: FileInfo | Coroutine[Any, Any, FileInfo] = file_info - elif stat_result: - self.file_info = self.adapter.parse_stat_result(result=stat_result, path=file_path) - else: - self.file_info = self.adapter.info(self.file_path) - - async def send_body(self, send: Send, receive: Receive) -> None: - """Emit a stream of events correlating with the response body. - - Args: - send: The ASGI send function. - receive: The ASGI receive function. - - Returns: - None - """ - if self.chunk_size < self.content_length: - await super().send_body(send=send, receive=receive) - return - - async with await self.adapter.open(self.file_path) as file: - body_event: HTTPResponseBodyEvent = { - "type": "http.response.body", - "body": await file.read(), - "more_body": False, - } - await send(body_event) - - async def start_response(self, send: Send) -> None: - """Emit the start event of the response. This event includes the headers and status codes. - - Args: - send: The ASGI send function. - - Returns: - None - """ - try: - fs_info = self.file_info = cast( - "FileInfo", (await self.file_info if iscoroutine(self.file_info) else self.file_info) - ) - except FileNotFoundError as e: - raise ImproperlyConfiguredException(f"{self.file_path} does not exist") from e - - if fs_info["type"] != "file": - raise ImproperlyConfiguredException(f"{self.file_path} is not a file") - - self.content_length = fs_info["size"] - - self.headers.setdefault("content-length", str(self.content_length)) - self.headers.setdefault("last-modified", formatdate(fs_info["mtime"], usegmt=True)) - - if self.etag: - self.headers.setdefault("etag", self.etag.to_header()) - else: - self.headers.setdefault( - "etag", - create_etag_for_file(path=self.file_path, modified_time=fs_info["mtime"], file_size=fs_info["size"]), - ) - - await super().start_response(send=send) - - -class File(Response): - """A response, streaming a file as response body.""" - - __slots__ = ( - "chunk_size", - "content_disposition_type", - "etag", - "file_path", - "file_system", - "filename", - "file_info", - "stat_result", - ) - - def __init__( - self, - path: str | PathLike | Path, - *, - background: BackgroundTask | BackgroundTasks | None = None, - chunk_size: int = ONE_MEGABYTE, - content_disposition_type: Literal["attachment", "inline"] = "attachment", - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - etag: ETag | None = None, - file_info: FileInfo | Coroutine[Any, Any, FileInfo] | None = None, - file_system: FileSystemProtocol | None = None, - filename: str | None = None, - headers: ResponseHeaders | None = None, - media_type: Literal[MediaType.TEXT] | str | None = None, - stat_result: stat_result_type | None = None, - status_code: int | None = None, - ) -> None: - """Initialize ``File`` - - Notes: - - This class extends the :class:`Stream <.response.Stream>` class. - - Args: - path: A file path in one of the supported formats. - background: A :class:`BackgroundTask <.background_tasks.BackgroundTask>` instance or - :class:`BackgroundTasks <.background_tasks.BackgroundTasks>` to execute after the response is finished. - Defaults to None. - chunk_size: The chunk sizes to use when streaming the file. Defaults to 1MB. - content_disposition_type: The type of the ``Content-Disposition``. Either ``inline`` or ``attachment``. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: The encoding to be used for the response headers. - etag: An optional :class:`ETag <.datastructures.ETag>` instance. If not provided, an etag will be - generated. - file_info: The output of calling :meth:`file_system.info `, equivalent to - providing an :class:`os.stat_result`. - file_system: An implementation of the :class:`FileSystemProtocol <.types.FileSystemProtocol>`. If provided - it will be used to load the file. - filename: An optional filename to set in the header. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - media_type: A value for the response ``Content-Type`` header. If not provided, the value will be either - derived from the filename if provided and supported by the stdlib, or will default to - ``application/octet-stream``. - stat_result: An optional result of calling :func:os.stat:. If not provided, this will be done by the - response constructor. - status_code: An HTTP status code. - """ - - if file_system is not None and not ( - callable(getattr(file_system, "info", None)) and callable(getattr(file_system, "open", None)) - ): - raise ImproperlyConfiguredException("file_system must adhere to the FileSystemProtocol type") - - self.chunk_size = chunk_size - self.content_disposition_type = content_disposition_type - self.etag = etag - self.file_info = file_info - self.file_path = path - self.file_system = file_system - self.filename = filename or "" - self.stat_result = stat_result - - super().__init__( - content=None, - status_code=status_code, - media_type=media_type, - background=background, - headers=headers, - cookies=cookies, - encoding=encoding, - ) - - def to_asgi_response( - self, - app: Litestar | None, - request: Request, - *, - background: BackgroundTask | BackgroundTasks | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - cookies: Iterable[Cookie] | None = None, - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> ASGIFileResponse: - """Create an :class:`ASGIFileResponse ` instance. - - Args: - app: The :class:`Litestar <.app.Litestar>` application instance. - background: Background task(s) to be executed after the response is sent. - cookies: A list of cookies to be set on the response. - encoded_headers: A list of already encoded headers. - headers: Additional headers to be merged with the response headers. Response headers take precedence. - is_head_response: Whether the response is a HEAD response. - media_type: Media type for the response. If ``media_type`` is already set on the response, this is ignored. - request: The :class:`Request <.connection.Request>` instance. - status_code: Status code for the response. If ``status_code`` is already set on the response, this is - type_encoders: A dictionary of type encoders to use for encoding the response content. - - Returns: - A low-level ASGI file response. - """ - if app is not None: - warn_deprecation( - version="2.1", - deprecated_name="app", - kind="parameter", - removal_in="3.0.0", - alternative="request.app", - ) - - headers = {**headers, **self.headers} if headers is not None else self.headers - cookies = self.cookies if cookies is None else itertools.chain(self.cookies, cookies) - - media_type = self.media_type or media_type - if media_type is not None: - media_type = get_enum_string_value(media_type) - - return ASGIFileResponse( - background=self.background or background, - body=b"", - chunk_size=self.chunk_size, - content_disposition_type=self.content_disposition_type, # pyright: ignore - content_length=0, - cookies=cookies, - encoded_headers=encoded_headers, - encoding=self.encoding, - etag=self.etag, - file_info=self.file_info, - file_path=self.file_path, - file_system=self.file_system, - filename=self.filename, - headers=headers, - is_head_response=is_head_response, - media_type=media_type, - stat_result=self.stat_result, - status_code=self.status_code or status_code, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/response/redirect.py b/venv/lib/python3.11/site-packages/litestar/response/redirect.py deleted file mode 100644 index 6a07076..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/redirect.py +++ /dev/null @@ -1,169 +0,0 @@ -from __future__ import annotations - -import itertools -from typing import TYPE_CHECKING, Any, Iterable, Literal - -from litestar.constants import REDIRECT_ALLOWED_MEDIA_TYPES, REDIRECT_STATUS_CODES -from litestar.enums import MediaType -from litestar.exceptions import ImproperlyConfiguredException -from litestar.response.base import ASGIResponse, Response -from litestar.status_codes import HTTP_302_FOUND -from litestar.utils import url_quote -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.helpers import get_enum_string_value - -if TYPE_CHECKING: - from litestar.app import Litestar - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.connection import Request - from litestar.datastructures import Cookie - from litestar.types import ResponseCookies, ResponseHeaders, TypeEncodersMap - -__all__ = ( - "ASGIRedirectResponse", - "Redirect", -) - - -RedirectStatusType = Literal[301, 302, 303, 307, 308] -"""Acceptable status codes for redirect responses.""" - - -class ASGIRedirectResponse(ASGIResponse): - """A low-level ASGI redirect response class.""" - - def __init__( - self, - path: str | bytes, - media_type: str | None = None, - status_code: RedirectStatusType | None = None, - headers: dict[str, Any] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - background: BackgroundTask | BackgroundTasks | None = None, - body: bytes | str = b"", - content_length: int | None = None, - cookies: Iterable[Cookie] | None = None, - encoding: str = "utf-8", - is_head_response: bool = False, - ) -> None: - headers = {**(headers or {}), "location": url_quote(path)} - media_type = media_type or MediaType.TEXT - status_code = status_code or HTTP_302_FOUND - - if status_code not in REDIRECT_STATUS_CODES: - raise ImproperlyConfiguredException( - f"{status_code} is not a valid for this response. " - f"Redirect responses should have one of " - f"the following status codes: {', '.join([str(s) for s in REDIRECT_STATUS_CODES])}" - ) - - if media_type not in REDIRECT_ALLOWED_MEDIA_TYPES: - raise ImproperlyConfiguredException( - f"{media_type} media type is not supported yet. " - f"Media type should be one of " - f"the following values: {', '.join([str(s) for s in REDIRECT_ALLOWED_MEDIA_TYPES])}" - ) - - super().__init__( - status_code=status_code, - headers=headers, - media_type=media_type, - background=background, - is_head_response=is_head_response, - encoding=encoding, - cookies=cookies, - content_length=content_length, - body=body, - encoded_headers=encoded_headers, - ) - - -class Redirect(Response[Any]): - """A redirect response.""" - - __slots__ = ("url",) - - def __init__( - self, - path: str, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - headers: ResponseHeaders | None = None, - media_type: str | MediaType | None = None, - status_code: RedirectStatusType | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> None: - """Initialize the response. - - Args: - path: A path to redirect to. - background: A background task or tasks to be run after the response is sent. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: The encoding to be used for the response headers. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - media_type: A value for the response ``Content-Type`` header. - status_code: An HTTP status code. The status code should be one of 301, 302, 303, 307 or 308, - otherwise an exception will be raised. - type_encoders: A mapping of types to callables that transform them into types supported for serialization. - - Raises: - ImproperlyConfiguredException: Either if status code is not a redirect status code or media type is not - supported. - """ - self.url = path - if status_code is None: - status_code = HTTP_302_FOUND - super().__init__( - background=background, - content=b"", - cookies=cookies, - encoding=encoding, - headers=headers, - media_type=media_type, - status_code=status_code, - type_encoders=type_encoders, - ) - - def to_asgi_response( - self, - app: Litestar | None, - request: Request, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> ASGIResponse: - headers = {**headers, **self.headers} if headers is not None else self.headers - cookies = self.cookies if cookies is None else itertools.chain(self.cookies, cookies) - media_type = get_enum_string_value(self.media_type or media_type or MediaType.TEXT) - - if app is not None: - warn_deprecation( - version="2.1", - deprecated_name="app", - kind="parameter", - removal_in="3.0.0", - alternative="request.app", - ) - - return ASGIRedirectResponse( - path=self.url, - background=self.background or background, - body=b"", - content_length=None, - cookies=cookies, - encoded_headers=encoded_headers, - encoding=self.encoding, - headers=headers, - is_head_response=is_head_response, - media_type=media_type, - status_code=self.status_code or status_code, # type:ignore[arg-type] - ) diff --git a/venv/lib/python3.11/site-packages/litestar/response/sse.py b/venv/lib/python3.11/site-packages/litestar/response/sse.py deleted file mode 100644 index 48a9192..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/sse.py +++ /dev/null @@ -1,180 +0,0 @@ -from __future__ import annotations - -import io -import re -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any, AsyncGenerator, AsyncIterable, AsyncIterator, Iterable, Iterator - -from litestar.concurrency import sync_to_thread -from litestar.exceptions import ImproperlyConfiguredException -from litestar.response.streaming import Stream -from litestar.utils import AsyncIteratorWrapper - -if TYPE_CHECKING: - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.types import ResponseCookies, ResponseHeaders, SSEData, StreamType - -_LINE_BREAK_RE = re.compile(r"\r\n|\r|\n") -DEFAULT_SEPARATOR = "\r\n" - - -class _ServerSentEventIterator(AsyncIteratorWrapper[bytes]): - __slots__ = ("content_async_iterator", "event_id", "event_type", "retry_duration", "comment_message") - - content_async_iterator: AsyncIterable[SSEData] - - def __init__( - self, - content: str | bytes | StreamType[SSEData], - event_type: str | None = None, - event_id: int | str | None = None, - retry_duration: int | None = None, - comment_message: str | None = None, - ) -> None: - self.comment_message = comment_message - self.event_id = event_id - self.event_type = event_type - self.retry_duration = retry_duration - chunks: list[bytes] = [] - if comment_message is not None: - chunks.extend([f": {chunk}\r\n".encode() for chunk in _LINE_BREAK_RE.split(comment_message)]) - - if event_id is not None: - chunks.append(f"id: {event_id}\r\n".encode()) - - if event_type is not None: - chunks.append(f"event: {event_type}\r\n".encode()) - - if retry_duration is not None: - chunks.append(f"retry: {retry_duration}\r\n".encode()) - - super().__init__(iterator=chunks) - - if not isinstance(content, (Iterator, AsyncIterator, AsyncIteratorWrapper)) and callable(content): - content = content() # type: ignore[unreachable] - - if isinstance(content, (str, bytes)): - self.content_async_iterator = AsyncIteratorWrapper([content]) - elif isinstance(content, (Iterable, Iterator)): - self.content_async_iterator = AsyncIteratorWrapper(content) - elif isinstance(content, (AsyncIterable, AsyncIterator, AsyncIteratorWrapper)): - self.content_async_iterator = content - else: - raise ImproperlyConfiguredException(f"Invalid type {type(content)} for ServerSentEvent") - - def ensure_bytes(self, data: str | int | bytes | dict | ServerSentEventMessage | Any, sep: str) -> bytes: - if isinstance(data, ServerSentEventMessage): - return data.encode() - if isinstance(data, dict): - data["sep"] = sep - return ServerSentEventMessage(**data).encode() - - return ServerSentEventMessage( - data=data, id=self.event_id, event=self.event_type, retry=self.retry_duration, sep=sep - ).encode() - - def _call_next(self) -> bytes: - try: - return next(self.iterator) - except StopIteration as e: - raise ValueError from e - - async def _async_generator(self) -> AsyncGenerator[bytes, None]: - while True: - try: - yield await sync_to_thread(self._call_next) - except ValueError: - async for value in self.content_async_iterator: - yield self.ensure_bytes(value, DEFAULT_SEPARATOR) - break - - -@dataclass -class ServerSentEventMessage: - data: str | int | bytes | None = "" - event: str | None = None - id: int | str | None = None - retry: int | None = None - comment: str | None = None - sep: str = DEFAULT_SEPARATOR - - def encode(self) -> bytes: - buffer = io.StringIO() - if self.comment is not None: - for chunk in _LINE_BREAK_RE.split(str(self.comment)): - buffer.write(f": {chunk}") - buffer.write(self.sep) - - if self.id is not None: - buffer.write(_LINE_BREAK_RE.sub("", f"id: {self.id}")) - buffer.write(self.sep) - - if self.event is not None: - buffer.write(_LINE_BREAK_RE.sub("", f"event: {self.event}")) - buffer.write(self.sep) - - if self.data is not None: - data = self.data - for chunk in _LINE_BREAK_RE.split(data.decode() if isinstance(data, bytes) else str(data)): - buffer.write(f"data: {chunk}") - buffer.write(self.sep) - - if self.retry is not None: - buffer.write(f"retry: {self.retry}") - buffer.write(self.sep) - - buffer.write(self.sep) - return buffer.getvalue().encode("utf-8") - - -class ServerSentEvent(Stream): - def __init__( - self, - content: str | bytes | StreamType[SSEData], - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - headers: ResponseHeaders | None = None, - event_type: str | None = None, - event_id: int | str | None = None, - retry_duration: int | None = None, - comment_message: str | None = None, - status_code: int | None = None, - ) -> None: - """Initialize the response. - - Args: - content: Bytes, string or a sync or async iterator or iterable. - background: A :class:`BackgroundTask <.background_tasks.BackgroundTask>` instance or - :class:`BackgroundTasks <.background_tasks.BackgroundTasks>` to execute after the response is finished. - Defaults to None. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: The encoding to be used for the response headers. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - status_code: The response status code. Defaults to 200. - event_type: The type of the SSE event. If given, the browser will sent the event to any 'event-listener' - declared for it (e.g. via 'addEventListener' in JS). - event_id: The event ID. This sets the event source's 'last event id'. - retry_duration: Retry duration in milliseconds. - comment_message: A comment message. This value is ignored by clients and is used mostly for pinging. - """ - super().__init__( - content=_ServerSentEventIterator( - content=content, - event_type=event_type, - event_id=event_id, - retry_duration=retry_duration, - comment_message=comment_message, - ), - media_type="text/event-stream", - background=background, - cookies=cookies, - encoding=encoding, - headers=headers, - status_code=status_code, - ) - self.headers.setdefault("Cache-Control", "no-cache") - self.headers["Connection"] = "keep-alive" - self.headers["X-Accel-Buffering"] = "no" diff --git a/venv/lib/python3.11/site-packages/litestar/response/streaming.py b/venv/lib/python3.11/site-packages/litestar/response/streaming.py deleted file mode 100644 index fc76522..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/streaming.py +++ /dev/null @@ -1,239 +0,0 @@ -from __future__ import annotations - -import itertools -from functools import partial -from typing import TYPE_CHECKING, Any, AsyncGenerator, AsyncIterable, AsyncIterator, Callable, Iterable, Iterator, Union - -from anyio import CancelScope, create_task_group - -from litestar.enums import MediaType -from litestar.response.base import ASGIResponse, Response -from litestar.types.helper_types import StreamType -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.helpers import get_enum_string_value -from litestar.utils.sync import AsyncIteratorWrapper - -if TYPE_CHECKING: - from litestar.app import Litestar - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.connection import Request - from litestar.datastructures.cookie import Cookie - from litestar.enums import OpenAPIMediaType - from litestar.types import HTTPResponseBodyEvent, Receive, ResponseCookies, ResponseHeaders, Send, TypeEncodersMap - -__all__ = ( - "ASGIStreamingResponse", - "Stream", -) - - -class ASGIStreamingResponse(ASGIResponse): - """A streaming response.""" - - __slots__ = ("iterator",) - - _should_set_content_length = False - - def __init__( - self, - *, - iterator: StreamType, - background: BackgroundTask | BackgroundTasks | None = None, - body: bytes | str = b"", - content_length: int | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - encoding: str = "utf-8", - headers: dict[str, Any] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - ) -> None: - """A low-level ASGI streaming response. - - Args: - background: A background task or a list of background tasks to be executed after the response is sent. - body: encoded content to send in the response body. - content_length: The response content length. - cookies: The response cookies. - encoded_headers: The response headers. - encoding: The response encoding. - headers: The response headers. - is_head_response: A boolean indicating if the response is a HEAD response. - iterator: An async iterator or iterable. - media_type: The response media type. - status_code: The response status code. - """ - super().__init__( - background=background, - body=body, - content_length=content_length, - cookies=cookies, - encoding=encoding, - headers=headers, - is_head_response=is_head_response, - media_type=media_type, - status_code=status_code, - encoded_headers=encoded_headers, - ) - self.iterator: AsyncIterable[str | bytes] | AsyncGenerator[str | bytes, None] = ( - iterator if isinstance(iterator, (AsyncIterable, AsyncIterator)) else AsyncIteratorWrapper(iterator) - ) - - async def _listen_for_disconnect(self, cancel_scope: CancelScope, receive: Receive) -> None: - """Listen for a cancellation message, and if received - call cancel on the cancel scope. - - Args: - cancel_scope: A task group cancel scope instance. - receive: The ASGI receive function. - - Returns: - None - """ - if not cancel_scope.cancel_called: - message = await receive() - if message["type"] == "http.disconnect": - # despite the IDE warning, this is not a coroutine because anyio 3+ changed this. - # therefore make sure not to await this. - cancel_scope.cancel() - else: - await self._listen_for_disconnect(cancel_scope=cancel_scope, receive=receive) - - async def _stream(self, send: Send) -> None: - """Send the chunks from the iterator as a stream of ASGI 'http.response.body' events. - - Args: - send: The ASGI Send function. - - Returns: - None - """ - async for chunk in self.iterator: - stream_event: HTTPResponseBodyEvent = { - "type": "http.response.body", - "body": chunk if isinstance(chunk, bytes) else chunk.encode(self.encoding), - "more_body": True, - } - await send(stream_event) - terminus_event: HTTPResponseBodyEvent = {"type": "http.response.body", "body": b"", "more_body": False} - await send(terminus_event) - - async def send_body(self, send: Send, receive: Receive) -> None: - """Emit a stream of events correlating with the response body. - - Args: - send: The ASGI send function. - receive: The ASGI receive function. - - Returns: - None - """ - - async with create_task_group() as task_group: - task_group.start_soon(partial(self._stream, send)) - await self._listen_for_disconnect(cancel_scope=task_group.cancel_scope, receive=receive) - - -class Stream(Response[StreamType[Union[str, bytes]]]): - """An HTTP response that streams the response data as a series of ASGI ``http.response.body`` events.""" - - __slots__ = ("iterator",) - - def __init__( - self, - content: StreamType[str | bytes] | Callable[[], StreamType[str | bytes]], - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - headers: ResponseHeaders | None = None, - media_type: MediaType | OpenAPIMediaType | str | None = None, - status_code: int | None = None, - ) -> None: - """Initialize the response. - - Args: - content: A sync or async iterator or iterable. - background: A :class:`BackgroundTask <.background_tasks.BackgroundTask>` instance or - :class:`BackgroundTasks <.background_tasks.BackgroundTasks>` to execute after the response is finished. - Defaults to None. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: The encoding to be used for the response headers. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - media_type: A value for the response ``Content-Type`` header. - status_code: An HTTP status code. - """ - super().__init__( - background=background, - content=b"", # type: ignore[arg-type] - cookies=cookies, - encoding=encoding, - headers=headers, - media_type=media_type, - status_code=status_code, - ) - self.iterator = content - - def to_asgi_response( - self, - app: Litestar | None, - request: Request, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> ASGIResponse: - """Create an ASGIStreamingResponse from a StremaingResponse instance. - - Args: - app: The :class:`Litestar <.app.Litestar>` application instance. - background: Background task(s) to be executed after the response is sent. - cookies: A list of cookies to be set on the response. - encoded_headers: A list of already encoded headers. - headers: Additional headers to be merged with the response headers. Response headers take precedence. - is_head_response: Whether the response is a HEAD response. - media_type: Media type for the response. If ``media_type`` is already set on the response, this is ignored. - request: The :class:`Request <.connection.Request>` instance. - status_code: Status code for the response. If ``status_code`` is already set on the response, this is - type_encoders: A dictionary of type encoders to use for encoding the response content. - - Returns: - An ASGIStreamingResponse instance. - """ - if app is not None: - warn_deprecation( - version="2.1", - deprecated_name="app", - kind="parameter", - removal_in="3.0.0", - alternative="request.app", - ) - - headers = {**headers, **self.headers} if headers is not None else self.headers - cookies = self.cookies if cookies is None else itertools.chain(self.cookies, cookies) - - media_type = get_enum_string_value(media_type or self.media_type or MediaType.JSON) - - iterator = self.iterator - if not isinstance(iterator, (Iterable, Iterator, AsyncIterable, AsyncIterator)) and callable(iterator): - iterator = iterator() - - return ASGIStreamingResponse( - background=self.background or background, - body=b"", - content_length=0, - cookies=cookies, - encoded_headers=encoded_headers, - encoding=self.encoding, - headers=headers, - is_head_response=is_head_response, - iterator=iterator, - media_type=media_type, - status_code=self.status_code or status_code, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/response/template.py b/venv/lib/python3.11/site-packages/litestar/response/template.py deleted file mode 100644 index 6499aae..0000000 --- a/venv/lib/python3.11/site-packages/litestar/response/template.py +++ /dev/null @@ -1,162 +0,0 @@ -from __future__ import annotations - -import itertools -from mimetypes import guess_type -from pathlib import PurePath -from typing import TYPE_CHECKING, Any, Iterable, cast - -from litestar.enums import MediaType -from litestar.exceptions import ImproperlyConfiguredException -from litestar.response.base import ASGIResponse, Response -from litestar.status_codes import HTTP_200_OK -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.empty import value_or_default -from litestar.utils.scope.state import ScopeState - -if TYPE_CHECKING: - from litestar.app import Litestar - from litestar.background_tasks import BackgroundTask, BackgroundTasks - from litestar.connection import Request - from litestar.datastructures import Cookie - from litestar.types import ResponseCookies, TypeEncodersMap - -__all__ = ("Template",) - - -class Template(Response[bytes]): - """Template-based response, rendering a given template into a bytes string.""" - - __slots__ = ( - "template_name", - "template_str", - "context", - ) - - def __init__( - self, - template_name: str | None = None, - *, - template_str: str | None = None, - background: BackgroundTask | BackgroundTasks | None = None, - context: dict[str, Any] | None = None, - cookies: ResponseCookies | None = None, - encoding: str = "utf-8", - headers: dict[str, Any] | None = None, - media_type: MediaType | str | None = None, - status_code: int = HTTP_200_OK, - ) -> None: - """Handle the rendering of a given template into a bytes string. - - Args: - template_name: Path-like name for the template to be rendered, e.g. ``index.html``. - template_str: A string representing the template, e.g. ``tmpl = "Hello World"``. - background: A :class:`BackgroundTask <.background_tasks.BackgroundTask>` instance or - :class:`BackgroundTasks <.background_tasks.BackgroundTasks>` to execute after the response is finished. - Defaults to ``None``. - context: A dictionary of key/value pairs to be passed to the temple engine's render method. - cookies: A list of :class:`Cookie <.datastructures.Cookie>` instances to be set under the response - ``Set-Cookie`` header. - encoding: Content encoding - headers: A string keyed dictionary of response headers. Header keys are insensitive. - media_type: A string or member of the :class:`MediaType <.enums.MediaType>` enum. If not set, try to infer - the media type based on the template name. If this fails, fall back to ``text/plain``. - status_code: A value for the response HTTP status code. - """ - if not (template_name or template_str): - raise ValueError("Either template_name or template_str must be provided.") - - if template_name and template_str: - raise ValueError("Either template_name or template_str must be provided, not both.") - - super().__init__( - background=background, - content=b"", - cookies=cookies, - encoding=encoding, - headers=headers, - media_type=media_type, - status_code=status_code, - ) - self.context = context or {} - self.template_name = template_name - self.template_str = template_str - - def create_template_context(self, request: Request) -> dict[str, Any]: - """Create a context object for the template. - - Args: - request: A :class:`Request <.connection.Request>` instance. - - Returns: - A dictionary holding the template context - """ - csrf_token = value_or_default(ScopeState.from_scope(request.scope).csrf_token, "") - return { - **self.context, - "request": request, - "csrf_input": f'', - } - - def to_asgi_response( - self, - app: Litestar | None, - request: Request, - *, - background: BackgroundTask | BackgroundTasks | None = None, - cookies: Iterable[Cookie] | None = None, - encoded_headers: Iterable[tuple[bytes, bytes]] | None = None, - headers: dict[str, str] | None = None, - is_head_response: bool = False, - media_type: MediaType | str | None = None, - status_code: int | None = None, - type_encoders: TypeEncodersMap | None = None, - ) -> ASGIResponse: - if app is not None: - warn_deprecation( - version="2.1", - deprecated_name="app", - kind="parameter", - removal_in="3.0.0", - alternative="request.app", - ) - - if not (template_engine := request.app.template_engine): - raise ImproperlyConfiguredException("Template engine is not configured") - - headers = {**headers, **self.headers} if headers is not None else self.headers - cookies = self.cookies if cookies is None else itertools.chain(self.cookies, cookies) - - media_type = self.media_type or media_type - if not media_type: - if self.template_name: - suffixes = PurePath(self.template_name).suffixes - for suffix in suffixes: - if _type := guess_type(f"name{suffix}")[0]: - media_type = _type - break - else: - media_type = MediaType.TEXT - else: - media_type = MediaType.HTML - - context = self.create_template_context(request) - - if self.template_str is not None: - body = template_engine.render_string(self.template_str, context) - else: - # cast to str b/c we know that either template_name cannot be None if template_str is None - template = template_engine.get_template(cast("str", self.template_name)) - body = template.render(**context).encode(self.encoding) - - return ASGIResponse( - background=self.background or background, - body=body, - content_length=None, - cookies=cookies, - encoded_headers=encoded_headers, - encoding=self.encoding, - headers=headers, - is_head_response=is_head_response, - media_type=media_type, - status_code=self.status_code or status_code, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/router.py b/venv/lib/python3.11/site-packages/litestar/router.py deleted file mode 100644 index 85346d8..0000000 --- a/venv/lib/python3.11/site-packages/litestar/router.py +++ /dev/null @@ -1,338 +0,0 @@ -from __future__ import annotations - -from collections import defaultdict -from copy import copy, deepcopy -from typing import TYPE_CHECKING, Any, Mapping, Sequence, cast - -from litestar._layers.utils import narrow_response_cookies, narrow_response_headers -from litestar.controller import Controller -from litestar.exceptions import ImproperlyConfiguredException -from litestar.handlers.asgi_handlers import ASGIRouteHandler -from litestar.handlers.http_handlers import HTTPRouteHandler -from litestar.handlers.websocket_handlers import WebsocketListener, WebsocketRouteHandler -from litestar.routes import ASGIRoute, HTTPRoute, WebSocketRoute -from litestar.types.empty import Empty -from litestar.utils import find_index, is_class_and_subclass, join_paths, normalize_path, unique -from litestar.utils.signature import add_types_to_signature_namespace -from litestar.utils.sync import ensure_async_callable - -__all__ = ("Router",) - - -if TYPE_CHECKING: - from litestar.connection import Request, WebSocket - from litestar.datastructures import CacheControlHeader, ETag - from litestar.dto import AbstractDTO - from litestar.openapi.spec import SecurityRequirement - from litestar.response import Response - from litestar.routes import BaseRoute - from litestar.types import ( - AfterRequestHookHandler, - AfterResponseHookHandler, - BeforeRequestHookHandler, - ControllerRouterHandler, - ExceptionHandlersMap, - Guard, - Middleware, - ParametersMap, - ResponseCookies, - RouteHandlerMapItem, - RouteHandlerType, - TypeEncodersMap, - ) - from litestar.types.composite_types import Dependencies, ResponseHeaders, TypeDecodersSequence - from litestar.types.empty import EmptyType - - -class Router: - """The Litestar Router class. - - A Router instance is used to group controller, routers and route handler functions under a shared path fragment - """ - - __slots__ = ( - "after_request", - "after_response", - "before_request", - "cache_control", - "dependencies", - "dto", - "etag", - "exception_handlers", - "guards", - "include_in_schema", - "middleware", - "opt", - "owner", - "parameters", - "path", - "registered_route_handler_ids", - "request_class", - "response_class", - "response_cookies", - "response_headers", - "return_dto", - "routes", - "security", - "signature_namespace", - "tags", - "type_decoders", - "type_encoders", - "websocket_class", - ) - - def __init__( - self, - path: str, - *, - after_request: AfterRequestHookHandler | None = None, - after_response: AfterResponseHookHandler | None = None, - before_request: BeforeRequestHookHandler | None = None, - cache_control: CacheControlHeader | None = None, - dependencies: Dependencies | None = None, - dto: type[AbstractDTO] | None | EmptyType = Empty, - etag: ETag | None = None, - exception_handlers: ExceptionHandlersMap | None = None, - guards: Sequence[Guard] | None = None, - include_in_schema: bool | EmptyType = Empty, - middleware: Sequence[Middleware] | None = None, - opt: Mapping[str, Any] | None = None, - parameters: ParametersMap | None = None, - request_class: type[Request] | None = None, - response_class: type[Response] | None = None, - response_cookies: ResponseCookies | None = None, - response_headers: ResponseHeaders | None = None, - return_dto: type[AbstractDTO] | None | EmptyType = Empty, - route_handlers: Sequence[ControllerRouterHandler], - security: Sequence[SecurityRequirement] | None = None, - signature_namespace: Mapping[str, Any] | None = None, - signature_types: Sequence[Any] | None = None, - tags: Sequence[str] | None = None, - type_decoders: TypeDecodersSequence | None = None, - type_encoders: TypeEncodersMap | None = None, - websocket_class: type[WebSocket] | None = None, - ) -> None: - """Initialize a ``Router``. - - Args: - after_request: A sync or async function executed before a :class:`Request <.connection.Request>` is passed - to any route handler. If this function returns a value, the request will not reach the route handler, - and instead this value will be used. - after_response: A sync or async function called after the response has been awaited. It receives the - :class:`Request <.connection.Request>` object and should not return any values. - before_request: A sync or async function called immediately before calling the route handler. Receives - the :class:`litestar.connection.Request` instance and any non-``None`` return value is used for the - response, bypassing the route handler. - cache_control: A ``cache-control`` header of type - :class:`CacheControlHeader <.datastructures.CacheControlHeader>` to add to route handlers of - this router. Can be overridden by route handlers. - dependencies: A string keyed mapping of dependency :class:`Provide <.di.Provide>` instances. - dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for (de)serializing and - validation of request data. - etag: An ``etag`` header of type :class:`ETag <.datastructures.ETag>` to add to route handlers of this app. - exception_handlers: A mapping of status codes and/or exception types to handler functions. - guards: A sequence of :data:`Guard <.types.Guard>` callables. - include_in_schema: A boolean flag dictating whether the route handler should be documented in the OpenAPI schema. - middleware: A sequence of :data:`Middleware <.types.Middleware>`. - opt: A string keyed mapping of arbitrary values that can be accessed in :data:`Guards <.types.Guard>` or - wherever you have access to :class:`Request <.connection.Request>` or - :data:`ASGI Scope <.types.Scope>`. - parameters: A mapping of :func:`Parameter <.params.Parameter>` definitions available to all application - paths. - path: A path fragment that is prefixed to all route handlers, controllers and other routers associated - with the router instance. - request_class: A custom subclass of :class:`Request <.connection.Request>` to be used as the default for - all route handlers, controllers and other routers associated with the router instance. - response_class: A custom subclass of :class:`Response <.response.Response>` to be used as the default for - all route handlers, controllers and other routers associated with the router instance. - response_cookies: A sequence of :class:`Cookie <.datastructures.Cookie>` instances. - response_headers: A string keyed mapping of :class:`ResponseHeader <.datastructures.ResponseHeader>` - instances. - return_dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for serializing - outbound response data. - route_handlers: A required sequence of route handlers, which can include instances of - :class:`Router <.router.Router>`, subclasses of :class:`Controller <.controller.Controller>` or any - function decorated by the route handler decorators. - security: A sequence of dicts that will be added to the schema of all route handlers in the application. - See :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` - for details. - signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling. - signature_types: A sequence of types for use in forward reference resolution during signature modeling. - These types will be added to the signature namespace using their ``__name__`` attribute. - tags: A sequence of string tags that will be appended to the schema of all route handlers under the - application. - type_decoders: A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization. - type_encoders: A mapping of types to callables that transform them into types supported for serialization. - websocket_class: A custom subclass of :class:`WebSocket <.connection.WebSocket>` to be used as the default for - all route handlers, controllers and other routers associated with the router instance. - """ - - self.after_request = ensure_async_callable(after_request) if after_request else None # pyright: ignore - self.after_response = ensure_async_callable(after_response) if after_response else None - self.before_request = ensure_async_callable(before_request) if before_request else None - self.cache_control = cache_control - self.dto = dto - self.etag = etag - self.dependencies = dict(dependencies or {}) - self.exception_handlers = dict(exception_handlers or {}) - self.guards = list(guards or []) - self.include_in_schema = include_in_schema - self.middleware = list(middleware or []) - self.opt = dict(opt or {}) - self.owner: Router | None = None - self.parameters = dict(parameters or {}) - self.path = normalize_path(path) - self.request_class = request_class - self.response_class = response_class - self.response_cookies = narrow_response_cookies(response_cookies) - self.response_headers = narrow_response_headers(response_headers) - self.return_dto = return_dto - self.routes: list[HTTPRoute | ASGIRoute | WebSocketRoute] = [] - self.security = list(security or []) - self.signature_namespace = add_types_to_signature_namespace( - signature_types or [], dict(signature_namespace or {}) - ) - self.tags = list(tags or []) - self.registered_route_handler_ids: set[int] = set() - self.type_encoders = dict(type_encoders) if type_encoders is not None else None - self.type_decoders = list(type_decoders) if type_decoders is not None else None - self.websocket_class = websocket_class - - for route_handler in route_handlers or []: - self.register(value=route_handler) - - def register(self, value: ControllerRouterHandler) -> list[BaseRoute]: - """Register a Controller, Route instance or RouteHandler on the router. - - Args: - value: a subclass or instance of Controller, an instance of :class:`Router` or a function/method that has - been decorated by any of the routing decorators, e.g. :class:`get <.handlers.get>`, - :class:`post <.handlers.post>`. - - Returns: - Collection of handlers added to the router. - """ - validated_value = self._validate_registration_value(value) - - routes: list[BaseRoute] = [] - - for route_path, handlers_map in self.get_route_handler_map(value=validated_value).items(): - path = join_paths([self.path, route_path]) - if http_handlers := unique( - [handler for handler in handlers_map.values() if isinstance(handler, HTTPRouteHandler)] - ): - if existing_handlers := unique( - [ - handler - for handler in self.route_handler_method_map.get(path, {}).values() - if isinstance(handler, HTTPRouteHandler) - ] - ): - http_handlers.extend(existing_handlers) - existing_route_index = find_index(self.routes, lambda x: x.path == path) # noqa: B023 - - if existing_route_index == -1: # pragma: no cover - raise ImproperlyConfiguredException("unable to find_index existing route index") - - route: WebSocketRoute | ASGIRoute | HTTPRoute = HTTPRoute( - path=path, - route_handlers=http_handlers, - ) - self.routes[existing_route_index] = route - else: - route = HTTPRoute(path=path, route_handlers=http_handlers) - self.routes.append(route) - - routes.append(route) - - if websocket_handler := handlers_map.get("websocket"): - route = WebSocketRoute(path=path, route_handler=cast("WebsocketRouteHandler", websocket_handler)) - self.routes.append(route) - routes.append(route) - - if asgi_handler := handlers_map.get("asgi"): - route = ASGIRoute(path=path, route_handler=cast("ASGIRouteHandler", asgi_handler)) - self.routes.append(route) - routes.append(route) - - return routes - - @property - def route_handler_method_map(self) -> dict[str, RouteHandlerMapItem]: - """Map route paths to :class:`RouteHandlerMapItem ` - - Returns: - A dictionary mapping paths to route handlers - """ - route_map: dict[str, RouteHandlerMapItem] = defaultdict(dict) - for route in self.routes: - if isinstance(route, HTTPRoute): - for route_handler in route.route_handlers: - for method in route_handler.http_methods: - route_map[route.path][method] = route_handler - else: - route_map[route.path]["websocket" if isinstance(route, WebSocketRoute) else "asgi"] = ( - route.route_handler - ) - - return route_map - - @classmethod - def get_route_handler_map( - cls, - value: Controller | RouteHandlerType | Router, - ) -> dict[str, RouteHandlerMapItem]: - """Map route handlers to HTTP methods.""" - if isinstance(value, Router): - return value.route_handler_method_map - - if isinstance(value, (HTTPRouteHandler, ASGIRouteHandler, WebsocketRouteHandler)): - copied_value = copy(value) - if isinstance(value, HTTPRouteHandler): - return {path: {http_method: copied_value for http_method in value.http_methods} for path in value.paths} - - return { - path: {"websocket" if isinstance(value, WebsocketRouteHandler) else "asgi": copied_value} - for path in value.paths - } - - handlers_map: defaultdict[str, RouteHandlerMapItem] = defaultdict(dict) - for route_handler in value.get_route_handlers(): - for handler_path in route_handler.paths: - path = join_paths([value.path, handler_path]) if handler_path else value.path - if isinstance(route_handler, HTTPRouteHandler): - for http_method in route_handler.http_methods: - handlers_map[path][http_method] = route_handler - else: - handlers_map[path]["websocket" if isinstance(route_handler, WebsocketRouteHandler) else "asgi"] = ( - cast("WebsocketRouteHandler | ASGIRouteHandler", route_handler) - ) - - return handlers_map - - def _validate_registration_value(self, value: ControllerRouterHandler) -> Controller | RouteHandlerType | Router: - """Ensure values passed to the register method are supported.""" - if is_class_and_subclass(value, Controller): - return value(owner=self) - - # this narrows down to an ABC, but we assume a non-abstract subclass of the ABC superclass - if is_class_and_subclass(value, WebsocketListener): - return value(owner=self).to_handler() # pyright: ignore - - if isinstance(value, Router): - if value is self: - raise ImproperlyConfiguredException("Cannot register a router on itself") - - router_copy = deepcopy(value) - router_copy.owner = self - return router_copy - - if isinstance(value, (ASGIRouteHandler, HTTPRouteHandler, WebsocketRouteHandler)): - value.owner = self - return value - - raise ImproperlyConfiguredException( - "Unsupported value passed to `Router.register`. " - "If you passed in a function or method, " - "make sure to decorate it first with one of the routing decorators" - ) diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__init__.py b/venv/lib/python3.11/site-packages/litestar/routes/__init__.py deleted file mode 100644 index c8b5d3d..0000000 --- a/venv/lib/python3.11/site-packages/litestar/routes/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -from .asgi import ASGIRoute -from .base import BaseRoute -from .http import HTTPRoute -from .websocket import WebSocketRoute - -__all__ = ("BaseRoute", "ASGIRoute", "WebSocketRoute", "HTTPRoute") diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index ae8dee1..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/asgi.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/asgi.cpython-311.pyc deleted file mode 100644 index b3330b1..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/asgi.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 98b66b4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/http.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/http.cpython-311.pyc deleted file mode 100644 index a430b70..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/http.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/websocket.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/websocket.cpython-311.pyc deleted file mode 100644 index 79da4a4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/routes/__pycache__/websocket.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/routes/asgi.py b/venv/lib/python3.11/site-packages/litestar/routes/asgi.py deleted file mode 100644 index a8564d0..0000000 --- a/venv/lib/python3.11/site-packages/litestar/routes/asgi.py +++ /dev/null @@ -1,54 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any - -from litestar.connection import ASGIConnection -from litestar.enums import ScopeType -from litestar.routes.base import BaseRoute - -if TYPE_CHECKING: - from litestar.handlers.asgi_handlers import ASGIRouteHandler - from litestar.types import Receive, Scope, Send - - -class ASGIRoute(BaseRoute): - """An ASGI route, handling a single ``ASGIRouteHandler``""" - - __slots__ = ("route_handler",) - - def __init__( - self, - *, - path: str, - route_handler: ASGIRouteHandler, - ) -> None: - """Initialize the route. - - Args: - path: The path for the route. - route_handler: An instance of :class:`~.handlers.ASGIRouteHandler`. - """ - self.route_handler = route_handler - super().__init__( - path=path, - scope_type=ScopeType.ASGI, - handler_names=[route_handler.handler_name], - ) - - async def handle(self, scope: Scope, receive: Receive, send: Send) -> None: - """ASGI app that authorizes the connection and then awaits the handler function. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - - if self.route_handler.resolve_guards(): - connection = ASGIConnection["ASGIRouteHandler", Any, Any, Any](scope=scope, receive=receive) - await self.route_handler.authorize_connection(connection=connection) - - await self.route_handler.fn(scope=scope, receive=receive, send=send) diff --git a/venv/lib/python3.11/site-packages/litestar/routes/base.py b/venv/lib/python3.11/site-packages/litestar/routes/base.py deleted file mode 100644 index b9baab4..0000000 --- a/venv/lib/python3.11/site-packages/litestar/routes/base.py +++ /dev/null @@ -1,195 +0,0 @@ -from __future__ import annotations - -import re -from abc import ABC, abstractmethod -from datetime import date, datetime, time, timedelta -from decimal import Decimal -from pathlib import Path -from typing import TYPE_CHECKING, Any, Callable -from uuid import UUID - -import msgspec - -from litestar._kwargs import KwargsModel -from litestar.exceptions import ImproperlyConfiguredException -from litestar.types.internal_types import PathParameterDefinition -from litestar.utils import join_paths, normalize_path - -if TYPE_CHECKING: - from litestar.enums import ScopeType - from litestar.handlers.base import BaseRouteHandler - from litestar.types import Method, Receive, Scope, Send - - -def _parse_datetime(value: str) -> datetime: - return msgspec.convert(value, datetime) - - -def _parse_date(value: str) -> date: - return msgspec.convert(value, date) - - -def _parse_time(value: str) -> time: - return msgspec.convert(value, time) - - -def _parse_timedelta(value: str) -> timedelta: - try: - return msgspec.convert(value, timedelta) - except msgspec.ValidationError: - return timedelta(seconds=int(float(value))) - - -param_match_regex = re.compile(r"{(.*?)}") - -param_type_map = { - "str": str, - "int": int, - "float": float, - "uuid": UUID, - "decimal": Decimal, - "date": date, - "datetime": datetime, - "time": time, - "timedelta": timedelta, - "path": Path, -} - - -parsers_map: dict[Any, Callable[[Any], Any]] = { - float: float, - int: int, - Decimal: Decimal, - UUID: UUID, - date: _parse_date, - datetime: _parse_datetime, - time: _parse_time, - timedelta: _parse_timedelta, -} - - -class BaseRoute(ABC): - """Base Route class used by Litestar. - - It's an abstract class meant to be extended. - """ - - __slots__ = ( - "app", - "handler_names", - "methods", - "path", - "path_format", - "path_parameters", - "path_components", - "scope_type", - ) - - def __init__( - self, - *, - handler_names: list[str], - path: str, - scope_type: ScopeType, - methods: list[Method] | None = None, - ) -> None: - """Initialize the route. - - Args: - handler_names: Names of the associated handler functions - path: Base path of the route - scope_type: Type of the ASGI scope - methods: Supported methods - """ - self.path, self.path_format, self.path_components = self._parse_path(path) - self.path_parameters: tuple[PathParameterDefinition, ...] = tuple( - component for component in self.path_components if isinstance(component, PathParameterDefinition) - ) - self.handler_names = handler_names - self.scope_type = scope_type - self.methods = set(methods or []) - - @abstractmethod - async def handle(self, scope: Scope, receive: Receive, send: Send) -> None: - """ASGI App of the route. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - raise NotImplementedError("Route subclasses must implement handle which serves as the ASGI app entry point") - - def create_handler_kwargs_model(self, route_handler: BaseRouteHandler) -> KwargsModel: - """Create a `KwargsModel` for a given route handler.""" - - path_parameters = set() - for param in self.path_parameters: - if param.name in path_parameters: - raise ImproperlyConfiguredException(f"Duplicate parameter '{param.name}' detected in '{self.path}'.") - path_parameters.add(param.name) - - return KwargsModel.create_for_signature_model( - signature_model=route_handler.signature_model, - parsed_signature=route_handler.parsed_fn_signature, - dependencies=route_handler.resolve_dependencies(), - path_parameters=path_parameters, - layered_parameters=route_handler.resolve_layered_parameters(), - ) - - @staticmethod - def _validate_path_parameter(param: str, path: str) -> None: - """Validate that a path parameter adheres to the required format and datatypes. - - Raises: - ImproperlyConfiguredException: If the parameter has an invalid format. - """ - if len(param.split(":")) != 2: - raise ImproperlyConfiguredException( - f"Path parameters should be declared with a type using the following pattern: '{{parameter_name:type}}', e.g. '/my-path/{{my_param:int}}' in path: '{path}'" - ) - param_name, param_type = (p.strip() for p in param.split(":")) - if not param_name: - raise ImproperlyConfiguredException("Path parameter names should be of length greater than zero") - if param_type not in param_type_map: - raise ImproperlyConfiguredException( - f"Path parameters should be declared with an allowed type, i.e. one of {', '.join(param_type_map.keys())} in path: '{path}'" - ) - - @classmethod - def _parse_path(cls, path: str) -> tuple[str, str, list[str | PathParameterDefinition]]: - """Normalize and parse a path. - - Splits the path into a list of components, parsing any that are path parameters. Also builds the OpenAPI - compatible path, which does not include the type of the path parameters. - - Returns: - A 3-tuple of the normalized path, the OpenAPI formatted path, and the list of parsed components. - """ - path = normalize_path(path) - - parsed_components: list[str | PathParameterDefinition] = [] - path_format_components = [] - - components = [component for component in path.split("/") if component] - for component in components: - if param_match := param_match_regex.fullmatch(component): - param = param_match.group(1) - cls._validate_path_parameter(param, path) - param_name, param_type = (p.strip() for p in param.split(":")) - type_class = param_type_map[param_type] - parser = parsers_map[type_class] if type_class not in {str, Path} else None - parsed_components.append( - PathParameterDefinition(name=param_name, type=type_class, full=param, parser=parser) - ) - path_format_components.append("{" + param_name + "}") - else: - parsed_components.append(component) - path_format_components.append(component) - - path_format = join_paths(path_format_components) - - return path, path_format, parsed_components diff --git a/venv/lib/python3.11/site-packages/litestar/routes/http.py b/venv/lib/python3.11/site-packages/litestar/routes/http.py deleted file mode 100644 index b1f70cb..0000000 --- a/venv/lib/python3.11/site-packages/litestar/routes/http.py +++ /dev/null @@ -1,327 +0,0 @@ -from __future__ import annotations - -from itertools import chain -from typing import TYPE_CHECKING, Any, cast - -from msgspec.msgpack import decode as _decode_msgpack_plain - -from litestar.constants import DEFAULT_ALLOWED_CORS_HEADERS -from litestar.datastructures.headers import Headers -from litestar.datastructures.upload_file import UploadFile -from litestar.enums import HttpMethod, MediaType, ScopeType -from litestar.exceptions import ClientException, ImproperlyConfiguredException, SerializationException -from litestar.handlers.http_handlers import HTTPRouteHandler -from litestar.response import Response -from litestar.routes.base import BaseRoute -from litestar.status_codes import HTTP_204_NO_CONTENT, HTTP_400_BAD_REQUEST -from litestar.types.empty import Empty -from litestar.utils.scope.state import ScopeState - -if TYPE_CHECKING: - from litestar._kwargs import KwargsModel - from litestar._kwargs.cleanup import DependencyCleanupGroup - from litestar.connection import Request - from litestar.types import ASGIApp, HTTPScope, Method, Receive, Scope, Send - - -class HTTPRoute(BaseRoute): - """An HTTP route, capable of handling multiple ``HTTPRouteHandler``\\ s.""" # noqa: D301 - - __slots__ = ( - "route_handler_map", - "route_handlers", - ) - - def __init__( - self, - *, - path: str, - route_handlers: list[HTTPRouteHandler], - ) -> None: - """Initialize ``HTTPRoute``. - - Args: - path: The path for the route. - route_handlers: A list of :class:`~.handlers.HTTPRouteHandler`. - """ - methods = list(chain.from_iterable([route_handler.http_methods for route_handler in route_handlers])) - if "OPTIONS" not in methods: - methods.append("OPTIONS") - options_handler = self.create_options_handler(path) - options_handler.owner = route_handlers[0].owner - route_handlers.append(options_handler) - - self.route_handlers = route_handlers - self.route_handler_map: dict[Method, tuple[HTTPRouteHandler, KwargsModel]] = {} - - super().__init__( - methods=methods, - path=path, - scope_type=ScopeType.HTTP, - handler_names=[route_handler.handler_name for route_handler in self.route_handlers], - ) - - async def handle(self, scope: HTTPScope, receive: Receive, send: Send) -> None: # type: ignore[override] - """ASGI app that creates a Request from the passed in args, determines which handler function to call and then - handles the call. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - route_handler, parameter_model = self.route_handler_map[scope["method"]] - request: Request[Any, Any, Any] = route_handler.resolve_request_class()(scope=scope, receive=receive, send=send) - - if route_handler.resolve_guards(): - await route_handler.authorize_connection(connection=request) - - response = await self._get_response_for_request( - scope=scope, request=request, route_handler=route_handler, parameter_model=parameter_model - ) - - await response(scope, receive, send) - - if after_response_handler := route_handler.resolve_after_response(): - await after_response_handler(request) - - if form_data := scope.get("_form", {}): - await self._cleanup_temporary_files(form_data=cast("dict[str, Any]", form_data)) - - def create_handler_map(self) -> None: - """Parse the ``router_handlers`` of this route and return a mapping of - http- methods and route handlers. - """ - for route_handler in self.route_handlers: - kwargs_model = self.create_handler_kwargs_model(route_handler=route_handler) - for http_method in route_handler.http_methods: - if self.route_handler_map.get(http_method): - raise ImproperlyConfiguredException( - f"Handler already registered for path {self.path!r} and http method {http_method}" - ) - self.route_handler_map[http_method] = (route_handler, kwargs_model) - - async def _get_response_for_request( - self, - scope: Scope, - request: Request[Any, Any, Any], - route_handler: HTTPRouteHandler, - parameter_model: KwargsModel, - ) -> ASGIApp: - """Return a response for the request. - - If caching is enabled and a response exist in the cache, the cached response will be returned. - If caching is enabled and a response does not exist in the cache, the newly created - response will be cached. - - Args: - scope: The Request's scope - request: The Request instance - route_handler: The HTTPRouteHandler instance - parameter_model: The Handler's KwargsModel - - Returns: - An instance of Response or a compatible ASGIApp or a subclass of it - """ - if route_handler.cache and ( - response := await self._get_cached_response(request=request, route_handler=route_handler) - ): - return response - - return await self._call_handler_function( - scope=scope, request=request, parameter_model=parameter_model, route_handler=route_handler - ) - - async def _call_handler_function( - self, scope: Scope, request: Request, parameter_model: KwargsModel, route_handler: HTTPRouteHandler - ) -> ASGIApp: - """Call the before request handlers, retrieve any data required for the route handler, and call the route - handler's ``to_response`` method. - - This is wrapped in a try except block - and if an exception is raised, - it tries to pass it to an appropriate exception handler - if defined. - """ - response_data: Any = None - cleanup_group: DependencyCleanupGroup | None = None - - if before_request_handler := route_handler.resolve_before_request(): - response_data = await before_request_handler(request) - - if not response_data: - response_data, cleanup_group = await self._get_response_data( - route_handler=route_handler, parameter_model=parameter_model, request=request - ) - - response: ASGIApp = await route_handler.to_response(app=scope["app"], data=response_data, request=request) - - if cleanup_group: - await cleanup_group.cleanup() - - return response - - @staticmethod - async def _get_response_data( - route_handler: HTTPRouteHandler, parameter_model: KwargsModel, request: Request - ) -> tuple[Any, DependencyCleanupGroup | None]: - """Determine what kwargs are required for the given route handler's ``fn`` and calls it.""" - parsed_kwargs: dict[str, Any] = {} - cleanup_group: DependencyCleanupGroup | None = None - - if parameter_model.has_kwargs and route_handler.signature_model: - kwargs = parameter_model.to_kwargs(connection=request) - - if "data" in kwargs: - try: - data = await kwargs["data"] - except SerializationException as e: - raise ClientException(str(e)) from e - - if data is Empty: - del kwargs["data"] - else: - kwargs["data"] = data - - if "body" in kwargs: - kwargs["body"] = await kwargs["body"] - - if parameter_model.dependency_batches: - cleanup_group = await parameter_model.resolve_dependencies(request, kwargs) - - parsed_kwargs = route_handler.signature_model.parse_values_from_connection_kwargs( - connection=request, **kwargs - ) - - if cleanup_group: - async with cleanup_group: - data = ( - route_handler.fn(**parsed_kwargs) - if route_handler.has_sync_callable - else await route_handler.fn(**parsed_kwargs) - ) - elif route_handler.has_sync_callable: - data = route_handler.fn(**parsed_kwargs) - else: - data = await route_handler.fn(**parsed_kwargs) - - return data, cleanup_group - - @staticmethod - async def _get_cached_response(request: Request, route_handler: HTTPRouteHandler) -> ASGIApp | None: - """Retrieve and un-pickle the cached response, if existing. - - Args: - request: The :class:`Request ` instance - route_handler: The :class:`~.handlers.HTTPRouteHandler` instance - - Returns: - A cached response instance, if existing. - """ - - cache_config = request.app.response_cache_config - cache_key = (route_handler.cache_key_builder or cache_config.key_builder)(request) - store = cache_config.get_store_from_app(request.app) - - if not (cached_response_data := await store.get(key=cache_key)): - return None - - # we use the regular msgspec.msgpack.decode here since we don't need any of - # the added decoders - messages = _decode_msgpack_plain(cached_response_data) - - async def cached_response(scope: Scope, receive: Receive, send: Send) -> None: - ScopeState.from_scope(scope).is_cached = True - for message in messages: - await send(message) - - return cached_response - - def create_options_handler(self, path: str) -> HTTPRouteHandler: - """Args: - path: The route path - - Returns: - An HTTP route handler for OPTIONS requests. - """ - - def options_handler(scope: Scope) -> Response: - """Handler function for OPTIONS requests. - - Args: - scope: The ASGI Scope. - - Returns: - Response - """ - cors_config = scope["app"].cors_config - request_headers = Headers.from_scope(scope=scope) - origin = request_headers.get("origin") - - if cors_config and origin: - pre_flight_method = request_headers.get("Access-Control-Request-Method") - failures = [] - - if not cors_config.is_allow_all_methods and ( - pre_flight_method and pre_flight_method not in cors_config.allow_methods - ): - failures.append("method") - - response_headers = cors_config.preflight_headers.copy() - - if not cors_config.is_origin_allowed(origin): - failures.append("Origin") - elif response_headers.get("Access-Control-Allow-Origin") != "*": - response_headers["Access-Control-Allow-Origin"] = origin - - pre_flight_requested_headers = [ - header.strip() - for header in request_headers.get("Access-Control-Request-Headers", "").split(",") - if header.strip() - ] - - if pre_flight_requested_headers: - if cors_config.is_allow_all_headers: - response_headers["Access-Control-Allow-Headers"] = ", ".join( - sorted(set(pre_flight_requested_headers) | DEFAULT_ALLOWED_CORS_HEADERS) # pyright: ignore - ) - elif any( - header.lower() not in cors_config.allow_headers for header in pre_flight_requested_headers - ): - failures.append("headers") - - return ( - Response( - content=f"Disallowed CORS {', '.join(failures)}", - status_code=HTTP_400_BAD_REQUEST, - media_type=MediaType.TEXT, - ) - if failures - else Response( - content=None, - status_code=HTTP_204_NO_CONTENT, - media_type=MediaType.TEXT, - headers=response_headers, - ) - ) - - return Response( - content=None, - status_code=HTTP_204_NO_CONTENT, - headers={"Allow": ", ".join(sorted(self.methods))}, # pyright: ignore - media_type=MediaType.TEXT, - ) - - return HTTPRouteHandler( - path=path, - http_method=[HttpMethod.OPTIONS], - include_in_schema=False, - sync_to_thread=False, - )(options_handler) - - @staticmethod - async def _cleanup_temporary_files(form_data: dict[str, Any]) -> None: - for v in form_data.values(): - if isinstance(v, UploadFile) and not v.file.closed: - await v.close() diff --git a/venv/lib/python3.11/site-packages/litestar/routes/websocket.py b/venv/lib/python3.11/site-packages/litestar/routes/websocket.py deleted file mode 100644 index ebf4959..0000000 --- a/venv/lib/python3.11/site-packages/litestar/routes/websocket.py +++ /dev/null @@ -1,86 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any - -from litestar.enums import ScopeType -from litestar.exceptions import ImproperlyConfiguredException -from litestar.routes.base import BaseRoute - -if TYPE_CHECKING: - from litestar._kwargs import KwargsModel - from litestar._kwargs.cleanup import DependencyCleanupGroup - from litestar.connection import WebSocket - from litestar.handlers.websocket_handlers import WebsocketRouteHandler - from litestar.types import Receive, Send, WebSocketScope - - -class WebSocketRoute(BaseRoute): - """A websocket route, handling a single ``WebsocketRouteHandler``""" - - __slots__ = ( - "route_handler", - "handler_parameter_model", - ) - - def __init__( - self, - *, - path: str, - route_handler: WebsocketRouteHandler, - ) -> None: - """Initialize the route. - - Args: - path: The path for the route. - route_handler: An instance of :class:`~.handlers.WebsocketRouteHandler`. - """ - self.route_handler = route_handler - self.handler_parameter_model: KwargsModel | None = None - - super().__init__( - path=path, - scope_type=ScopeType.WEBSOCKET, - handler_names=[route_handler.handler_name], - ) - - async def handle(self, scope: WebSocketScope, receive: Receive, send: Send) -> None: # type: ignore[override] - """ASGI app that creates a WebSocket from the passed in args, and then awaits the handler function. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - - if not self.handler_parameter_model: # pragma: no cover - raise ImproperlyConfiguredException("handler parameter model not defined") - - websocket: WebSocket[Any, Any, Any] = self.route_handler.resolve_websocket_class()( - scope=scope, receive=receive, send=send - ) - - if self.route_handler.resolve_guards(): - await self.route_handler.authorize_connection(connection=websocket) - - parsed_kwargs: dict[str, Any] = {} - cleanup_group: DependencyCleanupGroup | None = None - - if self.handler_parameter_model.has_kwargs and self.route_handler.signature_model: - parsed_kwargs = self.handler_parameter_model.to_kwargs(connection=websocket) - - if self.handler_parameter_model.dependency_batches: - cleanup_group = await self.handler_parameter_model.resolve_dependencies(websocket, parsed_kwargs) - - parsed_kwargs = self.route_handler.signature_model.parse_values_from_connection_kwargs( - connection=websocket, **parsed_kwargs - ) - - if cleanup_group: - async with cleanup_group: - await self.route_handler.fn(**parsed_kwargs) - await cleanup_group.cleanup() - else: - await self.route_handler.fn(**parsed_kwargs) diff --git a/venv/lib/python3.11/site-packages/litestar/security/__init__.py b/venv/lib/python3.11/site-packages/litestar/security/__init__.py deleted file mode 100644 index d864d43..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from litestar.security.base import AbstractSecurityConfig - -__all__ = ("AbstractSecurityConfig",) diff --git a/venv/lib/python3.11/site-packages/litestar/security/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 419b39e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 6133974..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/base.py b/venv/lib/python3.11/site-packages/litestar/security/base.py deleted file mode 100644 index fbe7913..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/base.py +++ /dev/null @@ -1,183 +0,0 @@ -from __future__ import annotations - -from abc import ABC, abstractmethod -from copy import copy -from dataclasses import field -from typing import TYPE_CHECKING, Any, Callable, Generic, Iterable, Sequence, TypeVar, cast - -from litestar import Response -from litestar.utils.sync import ensure_async_callable - -if TYPE_CHECKING: - from litestar.config.app import AppConfig - from litestar.connection import ASGIConnection - from litestar.di import Provide - from litestar.enums import MediaType, OpenAPIMediaType - from litestar.middleware.authentication import AbstractAuthenticationMiddleware - from litestar.middleware.base import DefineMiddleware - from litestar.openapi.spec import Components, SecurityRequirement - from litestar.types import ( - ControllerRouterHandler, - Guard, - Method, - ResponseCookies, - Scopes, - SyncOrAsyncUnion, - TypeEncodersMap, - ) - -__all__ = ("AbstractSecurityConfig",) - -UserType = TypeVar("UserType") -AuthType = TypeVar("AuthType") - - -class AbstractSecurityConfig(ABC, Generic[UserType, AuthType]): - """A base class for Security Configs - this class can be used on the application level - or be manually configured on the router / controller level to provide auth. - """ - - authentication_middleware_class: type[AbstractAuthenticationMiddleware] - """The authentication middleware class to use. - - Must inherit from - :class:`AbstractAuthenticationMiddleware ` - """ - guards: Iterable[Guard] | None = None - """An iterable of guards to call for requests, providing authorization functionalities.""" - exclude: str | list[str] | None = None - """A pattern or list of patterns to skip in the authentication middleware.""" - exclude_opt_key: str = "exclude_from_auth" - """An identifier to use on routes to disable authentication and authorization checks for a particular route.""" - exclude_http_methods: Sequence[Method] | None = field( - default_factory=lambda: cast("Sequence[Method]", ["OPTIONS", "HEAD"]) - ) - """A sequence of http methods that do not require authentication. Defaults to ['OPTIONS', 'HEAD']""" - scopes: Scopes | None = None - """ASGI scopes processed by the authentication middleware, if ``None``, both ``http`` and ``websocket`` will be - processed.""" - route_handlers: Iterable[ControllerRouterHandler] | None = None - """An optional iterable of route handlers to register.""" - dependencies: dict[str, Provide] | None = None - """An optional dictionary of dependency providers.""" - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - type_encoders: TypeEncodersMap | None = None - """A mapping of types to callables that transform them into types supported for serialization.""" - - def on_app_init(self, app_config: AppConfig) -> AppConfig: - """Handle app init by injecting middleware, guards etc. into the app. This method can be used only on the app - level. - - Args: - app_config: An instance of :class:`AppConfig <.config.app.AppConfig>` - - Returns: - The :class:`AppConfig <.config.app.AppConfig>`. - """ - app_config.middleware.insert(0, self.middleware) - - if app_config.openapi_config: - app_config.openapi_config = copy(app_config.openapi_config) - if isinstance(app_config.openapi_config.components, list): - app_config.openapi_config.components.append(self.openapi_components) - elif app_config.openapi_config.components: - app_config.openapi_config.components = [self.openapi_components, app_config.openapi_config.components] - else: - app_config.openapi_config.components = [self.openapi_components] - - if isinstance(app_config.openapi_config.security, list): - app_config.openapi_config.security.append(self.security_requirement) - else: - app_config.openapi_config.security = [self.security_requirement] - - if self.guards: - app_config.guards.extend(self.guards) - - if self.dependencies: - app_config.dependencies.update(self.dependencies) - - if self.route_handlers: - app_config.route_handlers.extend(self.route_handlers) - - if self.type_encoders is None: - self.type_encoders = app_config.type_encoders - - return app_config - - def create_response( - self, - content: Any | None, - status_code: int, - media_type: MediaType | OpenAPIMediaType | str, - headers: dict[str, Any] | None = None, - cookies: ResponseCookies | None = None, - ) -> Response[Any]: - """Create a response object. - - Handles setting the type encoders mapping on the response. - - Args: - content: A value for the response body that will be rendered into bytes string. - status_code: An HTTP status code. - media_type: A value for the response 'Content-Type' header. - headers: A string keyed dictionary of response headers. Header keys are insensitive. - cookies: A list of :class:`Cookie ` instances to be set under - the response 'Set-Cookie' header. - - Returns: - A response object. - """ - return Response( - content=content, - status_code=status_code, - media_type=media_type, - headers=headers, - cookies=cookies, - type_encoders=self.type_encoders, - ) - - def __post_init__(self) -> None: - self.retrieve_user_handler = ensure_async_callable(self.retrieve_user_handler) - - @property - @abstractmethod - def openapi_components(self) -> Components: - """Create OpenAPI documentation for the JWT auth schema used. - - Returns: - An :class:`Components ` instance. - """ - raise NotImplementedError - - @property - @abstractmethod - def security_requirement(self) -> SecurityRequirement: - """Return OpenAPI 3.1. - - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for the auth - backend. - - Returns: - An OpenAPI 3.1 :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` dictionary. - """ - raise NotImplementedError - - @property - @abstractmethod - def middleware(self) -> DefineMiddleware: - """Create an instance of the config's ``authentication_middleware_class`` attribute and any required kwargs, - wrapping it in Litestar's ``DefineMiddleware``. - - Returns: - An instance of :class:`DefineMiddleware `. - """ - raise NotImplementedError diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/__init__.py b/venv/lib/python3.11/site-packages/litestar/security/jwt/__init__.py deleted file mode 100644 index 4fd88de..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/jwt/__init__.py +++ /dev/null @@ -1,23 +0,0 @@ -from litestar.security.jwt.auth import ( - BaseJWTAuth, - JWTAuth, - JWTCookieAuth, - OAuth2Login, - OAuth2PasswordBearerAuth, -) -from litestar.security.jwt.middleware import ( - JWTAuthenticationMiddleware, - JWTCookieAuthenticationMiddleware, -) -from litestar.security.jwt.token import Token - -__all__ = ( - "BaseJWTAuth", - "JWTAuth", - "JWTAuthenticationMiddleware", - "JWTCookieAuth", - "JWTCookieAuthenticationMiddleware", - "OAuth2Login", - "OAuth2PasswordBearerAuth", - "Token", -) diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index f04d57f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/auth.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/auth.cpython-311.pyc deleted file mode 100644 index cec42c0..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/auth.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/middleware.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/middleware.cpython-311.pyc deleted file mode 100644 index 8d5603e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/middleware.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/token.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/token.cpython-311.pyc deleted file mode 100644 index b4f8c45..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/jwt/__pycache__/token.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/auth.py b/venv/lib/python3.11/site-packages/litestar/security/jwt/auth.py deleted file mode 100644 index 2a0f094..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/jwt/auth.py +++ /dev/null @@ -1,691 +0,0 @@ -from __future__ import annotations - -from dataclasses import asdict, dataclass, field -from datetime import datetime, timedelta, timezone -from typing import TYPE_CHECKING, Any, Callable, Generic, Iterable, Literal, Sequence, TypeVar, cast - -from litestar.datastructures import Cookie -from litestar.enums import MediaType -from litestar.middleware import DefineMiddleware -from litestar.openapi.spec import Components, OAuthFlow, OAuthFlows, SecurityRequirement, SecurityScheme -from litestar.security.base import AbstractSecurityConfig -from litestar.security.jwt.middleware import JWTAuthenticationMiddleware, JWTCookieAuthenticationMiddleware -from litestar.security.jwt.token import Token -from litestar.status_codes import HTTP_201_CREATED -from litestar.types import ControllerRouterHandler, Empty, Guard, Method, Scopes, SyncOrAsyncUnion, TypeEncodersMap - -__all__ = ("BaseJWTAuth", "JWTAuth", "JWTCookieAuth", "OAuth2Login", "OAuth2PasswordBearerAuth") - - -if TYPE_CHECKING: - from litestar import Response - from litestar.connection import ASGIConnection - from litestar.di import Provide - - -UserType = TypeVar("UserType") - - -class BaseJWTAuth(Generic[UserType], AbstractSecurityConfig[UserType, Token]): - """Base class for JWT Auth backends""" - - token_secret: str - """Key with which to generate the token hash. - - Notes: - - This value should be kept as a secret and the standard practice is to inject it into the environment. - """ - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - algorithm: str - """Algorithm to use for JWT hashing.""" - auth_header: str - """Request header key from which to retrieve the token. - - E.g. ``Authorization`` or ``X-Api-Key``. - """ - default_token_expiration: timedelta - """The default value for token expiration.""" - openapi_security_scheme_name: str - """The value to use for the OpenAPI security scheme and security requirements.""" - description: str - """Description for the OpenAPI security scheme.""" - authentication_middleware_class: type[JWTAuthenticationMiddleware] # pyright: ignore - """The authentication middleware class to use. - - Must inherit from :class:`JWTAuthenticationMiddleware` - """ - - @property - def openapi_components(self) -> Components: - """Create OpenAPI documentation for the JWT auth schema used. - - Returns: - An :class:`Components ` instance. - """ - return Components( - security_schemes={ - self.openapi_security_scheme_name: SecurityScheme( - type="http", - scheme="Bearer", - name=self.auth_header, - bearer_format="JWT", - description=self.description, - ) - } - ) - - @property - def security_requirement(self) -> SecurityRequirement: - """Return OpenAPI 3.1. - - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` - - Returns: - An OpenAPI 3.1 - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` - dictionary. - """ - return {self.openapi_security_scheme_name: []} - - @property - def middleware(self) -> DefineMiddleware: - """Create :class:`JWTAuthenticationMiddleware` wrapped in - :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - - Returns: - An instance of :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - """ - return DefineMiddleware( - self.authentication_middleware_class, - algorithm=self.algorithm, - auth_header=self.auth_header, - exclude=self.exclude, - exclude_opt_key=self.exclude_opt_key, - exclude_http_methods=self.exclude_http_methods, - retrieve_user_handler=self.retrieve_user_handler, - scopes=self.scopes, - token_secret=self.token_secret, - ) - - def login( - self, - identifier: str, - *, - response_body: Any = Empty, - response_media_type: str | MediaType = MediaType.JSON, - response_status_code: int = HTTP_201_CREATED, - token_expiration: timedelta | None = None, - token_issuer: str | None = None, - token_audience: str | None = None, - token_unique_jwt_id: str | None = None, - token_extras: dict[str, Any] | None = None, - send_token_as_response_body: bool = False, - ) -> Response[Any]: - """Create a response with a JWT header. - - Args: - identifier: Unique identifier of the token subject. Usually this is a user ID or equivalent kind of value. - response_body: An optional response body to send. - response_media_type: An optional ``Content-Type``. Defaults to ``application/json``. - response_status_code: An optional status code for the response. Defaults to ``201``. - token_expiration: An optional timedelta for the token expiration. - token_issuer: An optional value of the token ``iss`` field. - token_audience: An optional value for the token ``aud`` field. - token_unique_jwt_id: An optional value for the token ``jti`` field. - token_extras: An optional dictionary to include in the token ``extras`` field. - send_token_as_response_body: If ``True`` the response will be a dict including the token: ``{ "token": }`` - will be returned as the response body. Note: if a response body is passed this setting will be ignored. - - Returns: - A :class:`Response <.response.Response>` instance. - """ - encoded_token = self.create_token( - identifier=identifier, - token_expiration=token_expiration, - token_issuer=token_issuer, - token_audience=token_audience, - token_unique_jwt_id=token_unique_jwt_id, - token_extras=token_extras, - ) - - if response_body is not Empty: - body = response_body - elif send_token_as_response_body: - body = {"token": encoded_token} - else: - body = None - - return self.create_response( - content=body, - headers={self.auth_header: self.format_auth_header(encoded_token)}, - media_type=response_media_type, - status_code=response_status_code, - ) - - def create_token( - self, - identifier: str, - token_expiration: timedelta | None = None, - token_issuer: str | None = None, - token_audience: str | None = None, - token_unique_jwt_id: str | None = None, - token_extras: dict | None = None, - ) -> str: - """Create a Token instance from the passed in parameters, persists and returns it. - - Args: - identifier: Unique identifier of the token subject. Usually this is a user ID or equivalent kind of value. - token_expiration: An optional timedelta for the token expiration. - token_issuer: An optional value of the token ``iss`` field. - token_audience: An optional value for the token ``aud`` field. - token_unique_jwt_id: An optional value for the token ``jti`` field. - token_extras: An optional dictionary to include in the token ``extras`` field. - - Returns: - The created token. - """ - token = Token( - sub=identifier, - exp=(datetime.now(timezone.utc) + (token_expiration or self.default_token_expiration)), - iss=token_issuer, - aud=token_audience, - jti=token_unique_jwt_id, - extras=token_extras or {}, - ) - return token.encode(secret=self.token_secret, algorithm=self.algorithm) - - def format_auth_header(self, encoded_token: str) -> str: - """Format a token according to the specified OpenAPI scheme. - - Args: - encoded_token: An encoded JWT token - - Returns: - The encoded token formatted for the HTTP headers - """ - security = self.openapi_components.security_schemes.get(self.openapi_security_scheme_name, None) # type: ignore[union-attr] - return f"{security.scheme} {encoded_token}" if isinstance(security, SecurityScheme) else encoded_token - - -@dataclass -class JWTAuth(Generic[UserType], BaseJWTAuth[UserType]): - """JWT Authentication Configuration. - - This class is the main entry point to the library, and it includes methods to create the middleware, provide login - functionality, and create OpenAPI documentation. - """ - - token_secret: str - """Key with which to generate the token hash. - - Notes: - - This value should be kept as a secret and the standard practice is to inject it into the environment. - """ - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - guards: Iterable[Guard] | None = field(default=None) - """An iterable of guards to call for requests, providing authorization functionalities.""" - exclude: str | list[str] | None = field(default=None) - """A pattern or list of patterns to skip in the authentication middleware.""" - exclude_opt_key: str = field(default="exclude_from_auth") - """An identifier to use on routes to disable authentication and authorization checks for a particular route.""" - exclude_http_methods: Sequence[Method] | None = field( - default_factory=lambda: cast("Sequence[Method]", ["OPTIONS", "HEAD"]) - ) - """A sequence of http methods that do not require authentication. Defaults to ['OPTIONS', 'HEAD']""" - scopes: Scopes | None = field(default=None) - """ASGI scopes processed by the authentication middleware, if ``None``, both ``http`` and ``websocket`` will be - processed.""" - route_handlers: Iterable[ControllerRouterHandler] | None = field(default=None) - """An optional iterable of route handlers to register.""" - dependencies: dict[str, Provide] | None = field(default=None) - """An optional dictionary of dependency providers.""" - - type_encoders: TypeEncodersMap | None = field(default=None) - """A mapping of types to callables that transform them into types supported for serialization.""" - - algorithm: str = field(default="HS256") - """Algorithm to use for JWT hashing.""" - auth_header: str = field(default="Authorization") - """Request header key from which to retrieve the token. - - E.g. ``Authorization`` or ``X-Api-Key``. - """ - default_token_expiration: timedelta = field(default_factory=lambda: timedelta(days=1)) - """The default value for token expiration.""" - openapi_security_scheme_name: str = field(default="BearerToken") - """The value to use for the OpenAPI security scheme and security requirements.""" - description: str = field(default="JWT api-key authentication and authorization.") - """Description for the OpenAPI security scheme.""" - authentication_middleware_class: type[JWTAuthenticationMiddleware] = field(default=JWTAuthenticationMiddleware) - """The authentication middleware class to use. - - Must inherit from :class:`JWTAuthenticationMiddleware` - """ - - -@dataclass -class JWTCookieAuth(Generic[UserType], BaseJWTAuth[UserType]): - """JWT Cookie Authentication Configuration. - - This class is an alternate entry point to the library, and it includes all the functionality of the :class:`JWTAuth` - class and adds support for passing JWT tokens ``HttpOnly`` cookies. - """ - - token_secret: str - """Key with which to generate the token hash. - - Notes: - - This value should be kept as a secret and the standard practice is to inject it into the environment. - """ - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - guards: Iterable[Guard] | None = field(default=None) - """An iterable of guards to call for requests, providing authorization functionalities.""" - exclude: str | list[str] | None = field(default=None) - """A pattern or list of patterns to skip in the authentication middleware.""" - exclude_opt_key: str = field(default="exclude_from_auth") - """An identifier to use on routes to disable authentication and authorization checks for a particular route.""" - scopes: Scopes | None = field(default=None) - """ASGI scopes processed by the authentication middleware, if ``None``, both ``http`` and ``websocket`` will be - processed.""" - exclude_http_methods: Sequence[Method] | None = field( - default_factory=lambda: cast("Sequence[Method]", ["OPTIONS", "HEAD"]) - ) - """A sequence of http methods that do not require authentication. Defaults to ['OPTIONS', 'HEAD']""" - route_handlers: Iterable[ControllerRouterHandler] | None = field(default=None) - """An optional iterable of route handlers to register.""" - dependencies: dict[str, Provide] | None = field(default=None) - """An optional dictionary of dependency providers.""" - - type_encoders: TypeEncodersMap | None = field(default=None) - """A mapping of types to callables that transform them into types supported for serialization.""" - - algorithm: str = field(default="HS256") - """Algorithm to use for JWT hashing.""" - auth_header: str = field(default="Authorization") - """Request header key from which to retrieve the token. - - E.g. ``Authorization`` or ``X-Api-Key``. - """ - default_token_expiration: timedelta = field(default_factory=lambda: timedelta(days=1)) - """The default value for token expiration.""" - openapi_security_scheme_name: str = field(default="BearerToken") - """The value to use for the OpenAPI security scheme and security requirements.""" - key: str = field(default="token") - """Key for the cookie.""" - path: str = field(default="/") - """Path fragment that must exist in the request url for the cookie to be valid. - - Defaults to ``/``. - """ - domain: str | None = field(default=None) - """Domain for which the cookie is valid.""" - secure: bool | None = field(default=None) - """Https is required for the cookie.""" - samesite: Literal["lax", "strict", "none"] = field(default="lax") - """Controls whether or not a cookie is sent with cross-site requests. Defaults to ``lax``. """ - description: str = field(default="JWT cookie-based authentication and authorization.") - """Description for the OpenAPI security scheme.""" - authentication_middleware_class: type[JWTCookieAuthenticationMiddleware] = field( # pyright: ignore - default=JWTCookieAuthenticationMiddleware - ) - """The authentication middleware class to use. Must inherit from :class:`JWTCookieAuthenticationMiddleware` - """ - - @property - def openapi_components(self) -> Components: - """Create OpenAPI documentation for the JWT Cookie auth scheme. - - Returns: - A :class:`Components ` instance. - """ - return Components( - security_schemes={ - self.openapi_security_scheme_name: SecurityScheme( - type="http", - scheme="Bearer", - name=self.key, - security_scheme_in="cookie", - bearer_format="JWT", - description=self.description, - ) - } - ) - - @property - def middleware(self) -> DefineMiddleware: - """Create :class:`JWTCookieAuthenticationMiddleware` wrapped in - :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - - Returns: - An instance of :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - """ - return DefineMiddleware( - self.authentication_middleware_class, - algorithm=self.algorithm, - auth_cookie_key=self.key, - auth_header=self.auth_header, - exclude=self.exclude, - exclude_opt_key=self.exclude_opt_key, - exclude_http_methods=self.exclude_http_methods, - retrieve_user_handler=self.retrieve_user_handler, - scopes=self.scopes, - token_secret=self.token_secret, - ) - - def login( - self, - identifier: str, - *, - response_body: Any = Empty, - response_media_type: str | MediaType = MediaType.JSON, - response_status_code: int = HTTP_201_CREATED, - token_expiration: timedelta | None = None, - token_issuer: str | None = None, - token_audience: str | None = None, - token_unique_jwt_id: str | None = None, - token_extras: dict[str, Any] | None = None, - send_token_as_response_body: bool = False, - ) -> Response[Any]: - """Create a response with a JWT header. - - Args: - identifier: Unique identifier of the token subject. Usually this is a user ID or equivalent kind of value. - response_body: An optional response body to send. - response_media_type: An optional 'Content-Type'. Defaults to 'application/json'. - response_status_code: An optional status code for the response. Defaults to '201 Created'. - token_expiration: An optional timedelta for the token expiration. - token_issuer: An optional value of the token ``iss`` field. - token_audience: An optional value for the token ``aud`` field. - token_unique_jwt_id: An optional value for the token ``jti`` field. - token_extras: An optional dictionary to include in the token ``extras`` field. - send_token_as_response_body: If ``True`` the response will be a dict including the token: ``{ "token": }`` - will be returned as the response body. Note: if a response body is passed this setting will be ignored. - - Returns: - A :class:`Response <.response.Response>` instance. - """ - - encoded_token = self.create_token( - identifier=identifier, - token_expiration=token_expiration, - token_issuer=token_issuer, - token_audience=token_audience, - token_unique_jwt_id=token_unique_jwt_id, - token_extras=token_extras, - ) - cookie = Cookie( - key=self.key, - path=self.path, - httponly=True, - value=self.format_auth_header(encoded_token), - max_age=int((token_expiration or self.default_token_expiration).total_seconds()), - secure=self.secure, - samesite=self.samesite, - domain=self.domain, - ) - - if response_body is not Empty: - body = response_body - elif send_token_as_response_body: - body = {"token": encoded_token} - else: - body = None - - return self.create_response( - content=body, - headers={self.auth_header: self.format_auth_header(encoded_token)}, - cookies=[cookie], - media_type=response_media_type, - status_code=response_status_code, - ) - - -@dataclass -class OAuth2Login: - """OAuth2 Login DTO""" - - access_token: str - """Valid JWT access token""" - token_type: str - """Type of the OAuth token used""" - refresh_token: str | None = field(default=None) - """Optional valid refresh token JWT""" - expires_in: int | None = field(default=None) - """Expiration time of the token in seconds. """ - - -@dataclass -class OAuth2PasswordBearerAuth(Generic[UserType], BaseJWTAuth[UserType]): - """OAUTH2 Schema for Password Bearer Authentication. - - This class implements an OAUTH2 authentication flow entry point to the library, and it includes all the - functionality of the :class:`JWTAuth` class and adds support for passing JWT tokens ``HttpOnly`` cookies. - - ``token_url`` is the only additional argument that is required, and it should point at your login route - """ - - token_secret: str - """Key with which to generate the token hash. - - Notes: - - This value should be kept as a secret and the standard practice is to inject it into the environment. - """ - token_url: str - """The URL for retrieving a new token.""" - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - guards: Iterable[Guard] | None = field(default=None) - """An iterable of guards to call for requests, providing authorization functionalities.""" - exclude: str | list[str] | None = field(default=None) - """A pattern or list of patterns to skip in the authentication middleware.""" - exclude_opt_key: str = field(default="exclude_from_auth") - """An identifier to use on routes to disable authentication and authorization checks for a particular route.""" - exclude_http_methods: Sequence[Method] | None = field( - default_factory=lambda: cast("Sequence[Method]", ["OPTIONS", "HEAD"]) - ) - """A sequence of http methods that do not require authentication. Defaults to ['OPTIONS', 'HEAD']""" - scopes: Scopes | None = field(default=None) - """ASGI scopes processed by the authentication middleware, if ``None``, both ``http`` and ``websocket`` will be - processed.""" - route_handlers: Iterable[ControllerRouterHandler] | None = field(default=None) - """An optional iterable of route handlers to register.""" - dependencies: dict[str, Provide] | None = field(default=None) - """An optional dictionary of dependency providers.""" - type_encoders: TypeEncodersMap | None = field(default=None) - """A mapping of types to callables that transform them into types supported for serialization.""" - algorithm: str = field(default="HS256") - """Algorithm to use for JWT hashing.""" - auth_header: str = field(default="Authorization") - """Request header key from which to retrieve the token. - - E.g. ``Authorization`` or 'X-Api-Key'. - """ - default_token_expiration: timedelta = field(default_factory=lambda: timedelta(days=1)) - """The default value for token expiration.""" - openapi_security_scheme_name: str = field(default="BearerToken") - """The value to use for the OpenAPI security scheme and security requirements.""" - oauth_scopes: dict[str, str] | None = field(default=None) - """Oauth Scopes available for the token.""" - key: str = field(default="token") - """Key for the cookie.""" - path: str = field(default="/") - """Path fragment that must exist in the request url for the cookie to be valid. - - Defaults to ``/``. - """ - domain: str | None = field(default=None) - """Domain for which the cookie is valid.""" - secure: bool | None = field(default=None) - """Https is required for the cookie.""" - samesite: Literal["lax", "strict", "none"] = field(default="lax") - """Controls whether or not a cookie is sent with cross-site requests. Defaults to ``lax``. """ - description: str = field(default="OAUTH2 password bearer authentication and authorization.") - """Description for the OpenAPI security scheme.""" - authentication_middleware_class: type[JWTCookieAuthenticationMiddleware] = field( # pyright: ignore - default=JWTCookieAuthenticationMiddleware - ) - """The authentication middleware class to use. - - Must inherit from :class:`JWTCookieAuthenticationMiddleware` - """ - - @property - def middleware(self) -> DefineMiddleware: - """Create ``JWTCookieAuthenticationMiddleware`` wrapped in - :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - - Returns: - An instance of :class:`DefineMiddleware <.middleware.base.DefineMiddleware>`. - """ - return DefineMiddleware( - self.authentication_middleware_class, - algorithm=self.algorithm, - auth_cookie_key=self.key, - auth_header=self.auth_header, - exclude=self.exclude, - exclude_opt_key=self.exclude_opt_key, - exclude_http_methods=self.exclude_http_methods, - retrieve_user_handler=self.retrieve_user_handler, - scopes=self.scopes, - token_secret=self.token_secret, - ) - - @property - def oauth_flow(self) -> OAuthFlow: - """Create an OpenAPI OAuth2 flow for the password bearer authentication scheme. - - Returns: - An :class:`OAuthFlow ` instance. - """ - return OAuthFlow( - token_url=self.token_url, - scopes=self.oauth_scopes, - ) - - @property - def openapi_components(self) -> Components: - """Create OpenAPI documentation for the OAUTH2 Password bearer auth scheme. - - Returns: - An :class:`Components ` instance. - """ - return Components( - security_schemes={ - self.openapi_security_scheme_name: SecurityScheme( - type="oauth2", - scheme="Bearer", - name=self.auth_header, - security_scheme_in="header", - flows=OAuthFlows(password=self.oauth_flow), # pyright: ignore[reportGeneralTypeIssues] - bearer_format="JWT", - description=self.description, - ) - } - ) - - def login( - self, - identifier: str, - *, - response_body: Any = Empty, - response_media_type: str | MediaType = MediaType.JSON, - response_status_code: int = HTTP_201_CREATED, - token_expiration: timedelta | None = None, - token_issuer: str | None = None, - token_audience: str | None = None, - token_unique_jwt_id: str | None = None, - token_extras: dict[str, Any] | None = None, - send_token_as_response_body: bool = True, - ) -> Response[Any]: - """Create a response with a JWT header. - - Args: - identifier: Unique identifier of the token subject. Usually this is a user ID or equivalent kind of value. - response_body: An optional response body to send. - response_media_type: An optional ``Content-Type``. Defaults to ``application/json``. - response_status_code: An optional status code for the response. Defaults to ``201``. - token_expiration: An optional timedelta for the token expiration. - token_issuer: An optional value of the token ``iss`` field. - token_audience: An optional value for the token ``aud`` field. - token_unique_jwt_id: An optional value for the token ``jti`` field. - token_extras: An optional dictionary to include in the token ``extras`` field. - send_token_as_response_body: If ``True`` the response will be an oAuth2 token response dict. - Note: if a response body is passed this setting will be ignored. - - Returns: - A :class:`Response <.response.Response>` instance. - """ - encoded_token = self.create_token( - identifier=identifier, - token_expiration=token_expiration, - token_issuer=token_issuer, - token_audience=token_audience, - token_unique_jwt_id=token_unique_jwt_id, - token_extras=token_extras, - ) - expires_in = int((token_expiration or self.default_token_expiration).total_seconds()) - cookie = Cookie( - key=self.key, - path=self.path, - httponly=True, - value=self.format_auth_header(encoded_token), - max_age=expires_in, - secure=self.secure, - samesite=self.samesite, - domain=self.domain, - ) - - if response_body is not Empty: - body = response_body - elif send_token_as_response_body: - token_dto = OAuth2Login( - access_token=encoded_token, - expires_in=expires_in, - token_type="bearer", # noqa: S106 - ) - body = asdict(token_dto) - else: - body = None - - return self.create_response( - content=body, - headers={self.auth_header: self.format_auth_header(encoded_token)}, - cookies=[cookie], - media_type=response_media_type, - status_code=response_status_code, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/middleware.py b/venv/lib/python3.11/site-packages/litestar/security/jwt/middleware.py deleted file mode 100644 index 84326da..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/jwt/middleware.py +++ /dev/null @@ -1,188 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Awaitable, Callable, Sequence - -from litestar.exceptions import NotAuthorizedException -from litestar.middleware.authentication import ( - AbstractAuthenticationMiddleware, - AuthenticationResult, -) -from litestar.security.jwt.token import Token - -__all__ = ("JWTAuthenticationMiddleware", "JWTCookieAuthenticationMiddleware") - - -if TYPE_CHECKING: - from typing import Any - - from litestar.connection import ASGIConnection - from litestar.types import ASGIApp, Method, Scopes - - -class JWTAuthenticationMiddleware(AbstractAuthenticationMiddleware): - """JWT Authentication middleware. - - This class provides JWT authentication functionalities. - """ - - __slots__ = ( - "algorithm", - "auth_header", - "retrieve_user_handler", - "token_secret", - ) - - def __init__( - self, - algorithm: str, - app: ASGIApp, - auth_header: str, - exclude: str | list[str] | None, - exclude_http_methods: Sequence[Method] | None, - exclude_opt_key: str, - retrieve_user_handler: Callable[[Token, ASGIConnection[Any, Any, Any, Any]], Awaitable[Any]], - scopes: Scopes, - token_secret: str, - ) -> None: - """Check incoming requests for an encoded token in the auth header specified, and if present retrieve the user - from persistence using the provided function. - - Args: - algorithm: JWT hashing algorithm to use. - app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack. - auth_header: Request header key from which to retrieve the token. E.g. ``Authorization`` or ``X-Api-Key``. - exclude: A pattern or list of patterns to skip. - exclude_opt_key: An identifier to use on routes to disable authentication for a particular route. - exclude_http_methods: A sequence of http methods that do not require authentication. - retrieve_user_handler: A function that receives a :class:`Token <.security.jwt.Token>` and returns a user, - which can be any arbitrary value. - scopes: ASGI scopes processed by the authentication middleware. - token_secret: Secret for decoding the JWT token. This value should be equivalent to the secret used to - encode it. - """ - super().__init__( - app=app, - exclude=exclude, - exclude_from_auth_key=exclude_opt_key, - exclude_http_methods=exclude_http_methods, - scopes=scopes, - ) - self.algorithm = algorithm - self.auth_header = auth_header - self.retrieve_user_handler = retrieve_user_handler - self.token_secret = token_secret - - async def authenticate_request(self, connection: ASGIConnection[Any, Any, Any, Any]) -> AuthenticationResult: - """Given an HTTP Connection, parse the JWT api key stored in the header and retrieve the user correlating to the - token from the DB. - - Args: - connection: An Litestar HTTPConnection instance. - - Returns: - AuthenticationResult - - Raises: - NotAuthorizedException: If token is invalid or user is not found. - """ - auth_header = connection.headers.get(self.auth_header) - if not auth_header: - raise NotAuthorizedException("No JWT token found in request header") - encoded_token = auth_header.partition(" ")[-1] - return await self.authenticate_token(encoded_token=encoded_token, connection=connection) - - async def authenticate_token( - self, encoded_token: str, connection: ASGIConnection[Any, Any, Any, Any] - ) -> AuthenticationResult: - """Given an encoded JWT token, parse, validate and look up sub within token. - - Args: - encoded_token: Encoded JWT token. - connection: An ASGI connection instance. - - Raises: - NotAuthorizedException: If token is invalid or user is not found. - - Returns: - AuthenticationResult - """ - token = Token.decode( - encoded_token=encoded_token, - secret=self.token_secret, - algorithm=self.algorithm, - ) - - user = await self.retrieve_user_handler(token, connection) - - if not user: - raise NotAuthorizedException() - - return AuthenticationResult(user=user, auth=token) - - -class JWTCookieAuthenticationMiddleware(JWTAuthenticationMiddleware): - """Cookie based JWT authentication middleware.""" - - __slots__ = ("auth_cookie_key",) - - def __init__( - self, - algorithm: str, - app: ASGIApp, - auth_cookie_key: str, - auth_header: str, - exclude: str | list[str] | None, - exclude_opt_key: str, - exclude_http_methods: Sequence[Method] | None, - retrieve_user_handler: Callable[[Token, ASGIConnection[Any, Any, Any, Any]], Awaitable[Any]], - scopes: Scopes, - token_secret: str, - ) -> None: - """Check incoming requests for an encoded token in the auth header or cookie name specified, and if present - retrieves the user from persistence using the provided function. - - Args: - algorithm: JWT hashing algorithm to use. - app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack. - auth_cookie_key: Cookie name from which to retrieve the token. E.g. ``token`` or ``accessToken``. - auth_header: Request header key from which to retrieve the token. E.g. ``Authorization`` or ``X-Api-Key``. - exclude: A pattern or list of patterns to skip. - exclude_opt_key: An identifier to use on routes to disable authentication for a particular route. - exclude_http_methods: A sequence of http methods that do not require authentication. - retrieve_user_handler: A function that receives a :class:`Token <.security.jwt.Token>` and returns a user, - which can be any arbitrary value. - scopes: ASGI scopes processed by the authentication middleware. - token_secret: Secret for decoding the JWT token. This value should be equivalent to the secret used to - encode it. - """ - super().__init__( - algorithm=algorithm, - app=app, - auth_header=auth_header, - exclude=exclude, - exclude_http_methods=exclude_http_methods, - exclude_opt_key=exclude_opt_key, - retrieve_user_handler=retrieve_user_handler, - scopes=scopes, - token_secret=token_secret, - ) - self.auth_cookie_key = auth_cookie_key - - async def authenticate_request(self, connection: ASGIConnection[Any, Any, Any, Any]) -> AuthenticationResult: - """Given an HTTP Connection, parse the JWT api key stored in the header and retrieve the user correlating to the - token from the DB. - - Args: - connection: An Litestar HTTPConnection instance. - - Raises: - NotAuthorizedException: If token is invalid or user is not found. - - Returns: - AuthenticationResult - """ - auth_header = connection.headers.get(self.auth_header) or connection.cookies.get(self.auth_cookie_key) - if not auth_header: - raise NotAuthorizedException("No JWT token found in request header or cookies") - encoded_token = auth_header.partition(" ")[-1] - return await self.authenticate_token(encoded_token=encoded_token, connection=connection) diff --git a/venv/lib/python3.11/site-packages/litestar/security/jwt/token.py b/venv/lib/python3.11/site-packages/litestar/security/jwt/token.py deleted file mode 100644 index 279111a..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/jwt/token.py +++ /dev/null @@ -1,119 +0,0 @@ -from __future__ import annotations - -import dataclasses -from dataclasses import asdict, dataclass, field -from datetime import datetime, timezone -from typing import TYPE_CHECKING, Any - -from jose import JWSError, JWTError, jwt - -from litestar.exceptions import ImproperlyConfiguredException, NotAuthorizedException - -if TYPE_CHECKING: - from typing_extensions import Self - - -__all__ = ("Token",) - - -def _normalize_datetime(value: datetime) -> datetime: - """Convert the given value into UTC and strip microseconds. - - Args: - value: A datetime instance - - Returns: - A datetime instance - """ - if value.tzinfo is not None: - value.astimezone(timezone.utc) - - return value.replace(microsecond=0) - - -@dataclass -class Token: - """JWT Token DTO.""" - - exp: datetime - """Expiration - datetime for token expiration.""" - sub: str - """Subject - usually a unique identifier of the user or equivalent entity.""" - iat: datetime = field(default_factory=lambda: _normalize_datetime(datetime.now(timezone.utc))) - """Issued at - should always be current now.""" - iss: str | None = field(default=None) - """Issuer - optional unique identifier for the issuer.""" - aud: str | None = field(default=None) - """Audience - intended audience.""" - jti: str | None = field(default=None) - """JWT ID - a unique identifier of the JWT between different issuers.""" - extras: dict[str, Any] = field(default_factory=dict) - """Extra fields that were found on the JWT token.""" - - def __post_init__(self) -> None: - if len(self.sub) < 1: - raise ImproperlyConfiguredException("sub must be a string with a length greater than 0") - - if isinstance(self.exp, datetime) and ( - (exp := _normalize_datetime(self.exp)).timestamp() - >= _normalize_datetime(datetime.now(timezone.utc)).timestamp() - ): - self.exp = exp - else: - raise ImproperlyConfiguredException("exp value must be a datetime in the future") - - if isinstance(self.iat, datetime) and ( - (iat := _normalize_datetime(self.iat)).timestamp() - <= _normalize_datetime(datetime.now(timezone.utc)).timestamp() - ): - self.iat = iat - else: - raise ImproperlyConfiguredException("iat must be a current or past time") - - @classmethod - def decode(cls, encoded_token: str, secret: str | dict[str, str], algorithm: str) -> Self: - """Decode a passed in token string and returns a Token instance. - - Args: - encoded_token: A base64 string containing an encoded JWT. - secret: The secret with which the JWT is encoded. It may optionally be an individual JWK or JWS set dict - algorithm: The algorithm used to encode the JWT. - - Returns: - A decoded Token instance. - - Raises: - NotAuthorizedException: If the token is invalid. - """ - try: - payload = jwt.decode(token=encoded_token, key=secret, algorithms=[algorithm], options={"verify_aud": False}) - exp = datetime.fromtimestamp(payload.pop("exp"), tz=timezone.utc) - iat = datetime.fromtimestamp(payload.pop("iat"), tz=timezone.utc) - field_names = {f.name for f in dataclasses.fields(Token)} - extra_fields = payload.keys() - field_names - extras = payload.pop("extras", {}) - for key in extra_fields: - extras[key] = payload.pop(key) - return cls(exp=exp, iat=iat, **payload, extras=extras) - except (KeyError, JWTError, ImproperlyConfiguredException) as e: - raise NotAuthorizedException("Invalid token") from e - - def encode(self, secret: str, algorithm: str) -> str: - """Encode the token instance into a string. - - Args: - secret: The secret with which the JWT is encoded. - algorithm: The algorithm used to encode the JWT. - - Returns: - An encoded token string. - - Raises: - ImproperlyConfiguredException: If encoding fails. - """ - try: - return jwt.encode( - claims={k: v for k, v in asdict(self).items() if v is not None}, key=secret, algorithm=algorithm - ) - except (JWTError, JWSError) as e: - raise ImproperlyConfiguredException("Failed to encode token") from e diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__init__.py b/venv/lib/python3.11/site-packages/litestar/security/session_auth/__init__.py deleted file mode 100644 index 7c83991..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -from litestar.security.session_auth.auth import SessionAuth -from litestar.security.session_auth.middleware import SessionAuthMiddleware - -__all__ = ("SessionAuth", "SessionAuthMiddleware") diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 95bf5c1..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/auth.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/auth.cpython-311.pyc deleted file mode 100644 index 8d4aa6c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/auth.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/middleware.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/middleware.cpython-311.pyc deleted file mode 100644 index 27e4213..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/security/session_auth/__pycache__/middleware.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/auth.py b/venv/lib/python3.11/site-packages/litestar/security/session_auth/auth.py deleted file mode 100644 index 7a5c542..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/session_auth/auth.py +++ /dev/null @@ -1,137 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from typing import TYPE_CHECKING, Any, Callable, Dict, Generic, Iterable, Sequence, cast - -from litestar.middleware.base import DefineMiddleware -from litestar.middleware.session.base import BaseBackendConfig, BaseSessionBackendT -from litestar.openapi.spec import Components, SecurityRequirement, SecurityScheme -from litestar.security.base import AbstractSecurityConfig, UserType -from litestar.security.session_auth.middleware import MiddlewareWrapper, SessionAuthMiddleware - -__all__ = ("SessionAuth",) - -if TYPE_CHECKING: - from litestar.connection import ASGIConnection - from litestar.di import Provide - from litestar.types import ControllerRouterHandler, Guard, Method, Scopes, SyncOrAsyncUnion, TypeEncodersMap - - -@dataclass -class SessionAuth(Generic[UserType, BaseSessionBackendT], AbstractSecurityConfig[UserType, Dict[str, Any]]): - """Session Based Security Backend.""" - - session_backend_config: BaseBackendConfig[BaseSessionBackendT] # pyright: ignore - """A session backend config.""" - retrieve_user_handler: Callable[[Any, ASGIConnection], SyncOrAsyncUnion[Any | None]] - """Callable that receives the ``auth`` value from the authentication middleware and returns a ``user`` value. - - Notes: - - User and Auth can be any arbitrary values specified by the security backend. - - The User and Auth values will be set by the middleware as ``scope["user"]`` and ``scope["auth"]`` respectively. - Once provided, they can access via the ``connection.user`` and ``connection.auth`` properties. - - The callable can be sync or async. If it is sync, it will be wrapped to support async. - - """ - - authentication_middleware_class: type[SessionAuthMiddleware] = field(default=SessionAuthMiddleware) # pyright: ignore - """The authentication middleware class to use. - - Must inherit from :class:`SessionAuthMiddleware ` - """ - - guards: Iterable[Guard] | None = field(default=None) - """An iterable of guards to call for requests, providing authorization functionalities.""" - exclude: str | list[str] | None = field(default=None) - """A pattern or list of patterns to skip in the authentication middleware.""" - exclude_opt_key: str = field(default="exclude_from_auth") - """An identifier to use on routes to disable authentication and authorization checks for a particular route.""" - exclude_http_methods: Sequence[Method] | None = field( - default_factory=lambda: cast("Sequence[Method]", ["OPTIONS", "HEAD"]) - ) - """A sequence of http methods that do not require authentication. Defaults to ['OPTIONS', 'HEAD']""" - scopes: Scopes | None = field(default=None) - """ASGI scopes processed by the authentication middleware, if ``None``, both ``http`` and ``websocket`` will be - processed.""" - route_handlers: Iterable[ControllerRouterHandler] | None = field(default=None) - """An optional iterable of route handlers to register.""" - dependencies: dict[str, Provide] | None = field(default=None) - """An optional dictionary of dependency providers.""" - - type_encoders: TypeEncodersMap | None = field(default=None) - """A mapping of types to callables that transform them into types supported for serialization.""" - - @property - def middleware(self) -> DefineMiddleware: - """Use this property to insert the config into a middleware list on one of the application layers. - - Examples: - .. code-block:: python - - from typing import Any - from os import urandom - - from litestar import Litestar, Request, get - from litestar_session import SessionAuth - - - async def retrieve_user_from_session(session: dict[str, Any]) -> Any: - # implement logic here to retrieve a ``user`` datum given the session dictionary - ... - - - session_auth_config = SessionAuth( - secret=urandom(16), retrieve_user_handler=retrieve_user_from_session - ) - - - @get("/") - def my_handler(request: Request) -> None: ... - - - app = Litestar(route_handlers=[my_handler], middleware=[session_auth_config.middleware]) - - - Returns: - An instance of DefineMiddleware including ``self`` as the config kwarg value. - """ - return DefineMiddleware(MiddlewareWrapper, config=self) - - @property - def session_backend(self) -> BaseSessionBackendT: - """Create a session backend. - - Returns: - A subclass of :class:`BaseSessionBackend ` - """ - return self.session_backend_config._backend_class(config=self.session_backend_config) # pyright: ignore - - @property - def openapi_components(self) -> Components: - """Create OpenAPI documentation for the Session Authentication schema used. - - Returns: - An :class:`Components ` instance. - """ - return Components( - security_schemes={ - "sessionCookie": SecurityScheme( - type="apiKey", - name=self.session_backend_config.key, - security_scheme_in="cookie", # pyright: ignore - description="Session cookie authentication.", - ) - } - ) - - @property - def security_requirement(self) -> SecurityRequirement: - """Return OpenAPI 3.1. - - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for the auth - backend. - - Returns: - An OpenAPI 3.1 :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` dictionary. - """ - return {"sessionCookie": []} diff --git a/venv/lib/python3.11/site-packages/litestar/security/session_auth/middleware.py b/venv/lib/python3.11/site-packages/litestar/security/session_auth/middleware.py deleted file mode 100644 index bb3fce4..0000000 --- a/venv/lib/python3.11/site-packages/litestar/security/session_auth/middleware.py +++ /dev/null @@ -1,125 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any, Awaitable, Callable, Sequence - -from litestar.exceptions import NotAuthorizedException -from litestar.middleware.authentication import ( - AbstractAuthenticationMiddleware, - AuthenticationResult, -) -from litestar.middleware.exceptions import ExceptionHandlerMiddleware -from litestar.types import Empty, Method, Scopes - -__all__ = ("MiddlewareWrapper", "SessionAuthMiddleware") - -if TYPE_CHECKING: - from litestar.connection import ASGIConnection - from litestar.security.session_auth.auth import SessionAuth - from litestar.types import ASGIApp, Receive, Scope, Send - - -class MiddlewareWrapper: - """Wrapper class that serves as the middleware entry point.""" - - def __init__(self, app: ASGIApp, config: SessionAuth[Any, Any]) -> None: - """Wrap the SessionAuthMiddleware inside ExceptionHandlerMiddleware, and it wraps this inside SessionMiddleware. - This allows the auth middleware to raise exceptions and still have the response handled, while having the - session cleared. - - Args: - app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack. - config: An instance of SessionAuth. - """ - self.app = app - self.config = config - self.has_wrapped_middleware = False - - async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: - """Handle creating a middleware stack and calling it. - - Args: - scope: The ASGI connection scope. - receive: The ASGI receive function. - send: The ASGI send function. - - Returns: - None - """ - if not self.has_wrapped_middleware: - litestar_app = scope["app"] - auth_middleware = self.config.authentication_middleware_class( - app=self.app, - exclude=self.config.exclude, - exclude_http_methods=self.config.exclude_http_methods, - exclude_opt_key=self.config.exclude_opt_key, - scopes=self.config.scopes, - retrieve_user_handler=self.config.retrieve_user_handler, # type: ignore[arg-type] - ) - exception_middleware = ExceptionHandlerMiddleware( - app=auth_middleware, - exception_handlers=litestar_app.exception_handlers or {}, # pyright: ignore - debug=None, - ) - self.app = self.config.session_backend_config.middleware.middleware( - app=exception_middleware, - backend=self.config.session_backend, - ) - self.has_wrapped_middleware = True - await self.app(scope, receive, send) - - -class SessionAuthMiddleware(AbstractAuthenticationMiddleware): - """Session Authentication Middleware.""" - - def __init__( - self, - app: ASGIApp, - exclude: str | list[str] | None, - exclude_http_methods: Sequence[Method] | None, - exclude_opt_key: str, - retrieve_user_handler: Callable[[dict[str, Any], ASGIConnection[Any, Any, Any, Any]], Awaitable[Any]], - scopes: Scopes | None, - ) -> None: - """Session based authentication middleware. - - Args: - app: An ASGIApp, this value is the next ASGI handler to call in the middleware stack. - exclude: A pattern or list of patterns to skip in the authentication middleware. - exclude_http_methods: A sequence of http methods that do not require authentication. - exclude_opt_key: An identifier to use on routes to disable authentication and authorization checks for a particular route. - scopes: ASGI scopes processed by the authentication middleware. - retrieve_user_handler: Callable that receives the ``session`` value from the authentication middleware and returns a ``user`` value. - """ - super().__init__( - app=app, - exclude=exclude, - exclude_from_auth_key=exclude_opt_key, - exclude_http_methods=exclude_http_methods, - scopes=scopes, - ) - self.retrieve_user_handler = retrieve_user_handler - - async def authenticate_request(self, connection: ASGIConnection[Any, Any, Any, Any]) -> AuthenticationResult: - """Authenticate an incoming connection. - - Args: - connection: An :class:`ASGIConnection <.connection.ASGIConnection>` instance. - - Raises: - NotAuthorizedException: if session data is empty or user is not found. - - Returns: - :class:`AuthenticationResult <.middleware.authentication.AuthenticationResult>` - """ - if not connection.session or connection.scope["session"] is Empty: - # the assignment of 'Empty' forces the session middleware to clear session data. - connection.scope["session"] = Empty - raise NotAuthorizedException("no session data found") - - user = await self.retrieve_user_handler(connection.session, connection) - - if not user: - connection.scope["session"] = Empty - raise NotAuthorizedException("no user correlating to session found") - - return AuthenticationResult(user=user, auth=connection.session) diff --git a/venv/lib/python3.11/site-packages/litestar/serialization/__init__.py b/venv/lib/python3.11/site-packages/litestar/serialization/__init__.py deleted file mode 100644 index 0a9189e..0000000 --- a/venv/lib/python3.11/site-packages/litestar/serialization/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -from .msgspec_hooks import ( - decode_json, - decode_msgpack, - default_deserializer, - default_serializer, - encode_json, - encode_msgpack, - get_serializer, -) - -__all__ = ( - "default_deserializer", - "decode_json", - "decode_msgpack", - "default_serializer", - "encode_json", - "encode_msgpack", - "get_serializer", -) diff --git a/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 68fa695..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/msgspec_hooks.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/msgspec_hooks.cpython-311.pyc deleted file mode 100644 index 00f6d48..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/serialization/__pycache__/msgspec_hooks.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/serialization/msgspec_hooks.py b/venv/lib/python3.11/site-packages/litestar/serialization/msgspec_hooks.py deleted file mode 100644 index 3d7fdb8..0000000 --- a/venv/lib/python3.11/site-packages/litestar/serialization/msgspec_hooks.py +++ /dev/null @@ -1,261 +0,0 @@ -from __future__ import annotations - -from collections import deque -from datetime import date, datetime, time -from decimal import Decimal -from functools import partial -from ipaddress import ( - IPv4Address, - IPv4Interface, - IPv4Network, - IPv6Address, - IPv6Interface, - IPv6Network, -) -from pathlib import Path, PurePath -from re import Pattern -from typing import TYPE_CHECKING, Any, Callable, Mapping, TypeVar, overload -from uuid import UUID - -import msgspec - -from litestar.exceptions import SerializationException -from litestar.types import Empty, EmptyType, Serializer, TypeDecodersSequence - -if TYPE_CHECKING: - from litestar.types import TypeEncodersMap - -__all__ = ( - "decode_json", - "decode_msgpack", - "default_deserializer", - "default_serializer", - "encode_json", - "encode_msgpack", - "get_serializer", -) - -T = TypeVar("T") - -DEFAULT_TYPE_ENCODERS: TypeEncodersMap = { - Path: str, - PurePath: str, - IPv4Address: str, - IPv4Interface: str, - IPv4Network: str, - IPv6Address: str, - IPv6Interface: str, - IPv6Network: str, - datetime: lambda val: val.isoformat(), - date: lambda val: val.isoformat(), - time: lambda val: val.isoformat(), - deque: list, - Decimal: lambda val: int(val) if val.as_tuple().exponent >= 0 else float(val), - Pattern: lambda val: val.pattern, - # support subclasses of stdlib types, If no previous type matched, these will be - # the last type in the mro, so we use this to (attempt to) convert a subclass into - # its base class. # see https://github.com/jcrist/msgspec/issues/248 - # and https://github.com/litestar-org/litestar/issues/1003 - str: str, - int: int, - float: float, - set: set, - frozenset: frozenset, - bytes: bytes, -} - - -def default_serializer(value: Any, type_encoders: Mapping[Any, Callable[[Any], Any]] | None = None) -> Any: - """Transform values non-natively supported by ``msgspec`` - - Args: - value: A value to serialized - type_encoders: Mapping of types to callables to transforming types - Returns: - A serialized value - Raises: - TypeError: if value is not supported - """ - type_encoders = {**DEFAULT_TYPE_ENCODERS, **(type_encoders or {})} - - for base in value.__class__.__mro__[:-1]: - try: - encoder = type_encoders[base] - return encoder(value) - except KeyError: - continue - - raise TypeError(f"Unsupported type: {type(value)!r}") - - -def default_deserializer( - target_type: Any, value: Any, type_decoders: TypeDecodersSequence | None = None -) -> Any: # pragma: no cover - """Transform values non-natively supported by ``msgspec`` - - Args: - target_type: Encountered type - value: Value to coerce - type_decoders: Optional sequence of type decoders - - Returns: - A ``msgspec``-supported type - """ - - from litestar.datastructures.state import ImmutableState - - if isinstance(value, target_type): - return value - - if type_decoders: - for predicate, decoder in type_decoders: - if predicate(target_type): - return decoder(target_type, value) - - if issubclass(target_type, (Path, PurePath, ImmutableState, UUID)): - return target_type(value) - - raise TypeError(f"Unsupported type: {type(value)!r}") - - -_msgspec_json_encoder = msgspec.json.Encoder(enc_hook=default_serializer) -_msgspec_json_decoder = msgspec.json.Decoder(dec_hook=default_deserializer) -_msgspec_msgpack_encoder = msgspec.msgpack.Encoder(enc_hook=default_serializer) -_msgspec_msgpack_decoder = msgspec.msgpack.Decoder(dec_hook=default_deserializer) - - -def encode_json(value: Any, serializer: Callable[[Any], Any] | None = None) -> bytes: - """Encode a value into JSON. - - Args: - value: Value to encode - serializer: Optional callable to support non-natively supported types. - - Returns: - JSON as bytes - - Raises: - SerializationException: If error encoding ``obj``. - """ - try: - return msgspec.json.encode(value, enc_hook=serializer) if serializer else _msgspec_json_encoder.encode(value) - except (TypeError, msgspec.EncodeError) as msgspec_error: - raise SerializationException(str(msgspec_error)) from msgspec_error - - -@overload -def decode_json(value: str | bytes) -> Any: ... - - -@overload -def decode_json(value: str | bytes, type_decoders: TypeDecodersSequence | None) -> Any: ... - - -@overload -def decode_json(value: str | bytes, target_type: type[T]) -> T: ... - - -@overload -def decode_json(value: str | bytes, target_type: type[T], type_decoders: TypeDecodersSequence | None) -> T: ... - - -def decode_json( # type: ignore[misc] - value: str | bytes, - target_type: type[T] | EmptyType = Empty, # pyright: ignore - type_decoders: TypeDecodersSequence | None = None, -) -> Any: - """Decode a JSON string/bytes into an object. - - Args: - value: Value to decode - target_type: An optional type to decode the data into - type_decoders: Optional sequence of type decoders - - Returns: - An object - - Raises: - SerializationException: If error decoding ``value``. - """ - try: - if target_type is Empty: - return _msgspec_json_decoder.decode(value) - return msgspec.json.decode( - value, dec_hook=partial(default_deserializer, type_decoders=type_decoders), type=target_type - ) - except msgspec.DecodeError as msgspec_error: - raise SerializationException(str(msgspec_error)) from msgspec_error - - -def encode_msgpack(value: Any, serializer: Callable[[Any], Any] | None = default_serializer) -> bytes: - """Encode a value into MessagePack. - - Args: - value: Value to encode - serializer: Optional callable to support non-natively supported types - - Returns: - MessagePack as bytes - - Raises: - SerializationException: If error encoding ``obj``. - """ - try: - if serializer is None or serializer is default_serializer: - return _msgspec_msgpack_encoder.encode(value) - return msgspec.msgpack.encode(value, enc_hook=serializer) - except (TypeError, msgspec.EncodeError) as msgspec_error: - raise SerializationException(str(msgspec_error)) from msgspec_error - - -@overload -def decode_msgpack(value: bytes) -> Any: ... - - -@overload -def decode_msgpack(value: bytes, type_decoders: TypeDecodersSequence | None) -> Any: ... - - -@overload -def decode_msgpack(value: bytes, target_type: type[T]) -> T: ... - - -@overload -def decode_msgpack(value: bytes, target_type: type[T], type_decoders: TypeDecodersSequence | None) -> T: ... - - -def decode_msgpack( # type: ignore[misc] - value: bytes, - target_type: type[T] | EmptyType = Empty, # pyright: ignore[reportInvalidTypeVarUse] - type_decoders: TypeDecodersSequence | None = None, -) -> Any: - """Decode a MessagePack string/bytes into an object. - - Args: - value: Value to decode - target_type: An optional type to decode the data into - type_decoders: Optional sequence of type decoders - - Returns: - An object - - Raises: - SerializationException: If error decoding ``value``. - """ - try: - if target_type is Empty: - return _msgspec_msgpack_decoder.decode(value) - return msgspec.msgpack.decode( - value, dec_hook=partial(default_deserializer, type_decoders=type_decoders), type=target_type - ) - except msgspec.DecodeError as msgspec_error: - raise SerializationException(str(msgspec_error)) from msgspec_error - - -def get_serializer(type_encoders: TypeEncodersMap | None = None) -> Serializer: - """Get the serializer for the given type encoders.""" - - if type_encoders: - return partial(default_serializer, type_encoders=type_encoders) - - return default_serializer diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/__init__.py b/venv/lib/python3.11/site-packages/litestar/static_files/__init__.py deleted file mode 100644 index 3cd4594..0000000 --- a/venv/lib/python3.11/site-packages/litestar/static_files/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -from litestar.static_files.base import StaticFiles -from litestar.static_files.config import StaticFilesConfig, create_static_files_router - -__all__ = ("StaticFiles", "StaticFilesConfig", "create_static_files_router") diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 1cc4497..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 0ca9dae..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/config.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/config.cpython-311.pyc deleted file mode 100644 index fd93af6..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/static_files/__pycache__/config.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/base.py b/venv/lib/python3.11/site-packages/litestar/static_files/base.py deleted file mode 100644 index 9827697..0000000 --- a/venv/lib/python3.11/site-packages/litestar/static_files/base.py +++ /dev/null @@ -1,141 +0,0 @@ -from __future__ import annotations - -from os.path import commonpath -from pathlib import Path -from typing import TYPE_CHECKING, Literal, Sequence - -from litestar.enums import ScopeType -from litestar.exceptions import MethodNotAllowedException, NotFoundException -from litestar.file_system import FileSystemAdapter -from litestar.response.file import ASGIFileResponse -from litestar.status_codes import HTTP_404_NOT_FOUND - -__all__ = ("StaticFiles",) - - -if TYPE_CHECKING: - from litestar.types import Receive, Scope, Send - from litestar.types.composite_types import PathType - from litestar.types.file_types import FileInfo, FileSystemProtocol - - -class StaticFiles: - """ASGI App that handles file sending.""" - - __slots__ = ("is_html_mode", "directories", "adapter", "send_as_attachment", "headers") - - def __init__( - self, - is_html_mode: bool, - directories: Sequence[PathType], - file_system: FileSystemProtocol, - send_as_attachment: bool = False, - resolve_symlinks: bool = True, - headers: dict[str, str] | None = None, - ) -> None: - """Initialize the Application. - - Args: - is_html_mode: Flag dictating whether serving html. If true, the default file will be ``index.html``. - directories: A list of directories to serve files from. - file_system: The file_system spec to use for serving files. - send_as_attachment: Whether to send the file with a ``content-disposition`` header of - ``attachment`` or ``inline`` - resolve_symlinks: Resolve symlinks to the directories - headers: Headers that will be sent with every response. - """ - self.adapter = FileSystemAdapter(file_system) - self.directories = tuple(Path(p).resolve() if resolve_symlinks else Path(p) for p in directories) - self.is_html_mode = is_html_mode - self.send_as_attachment = send_as_attachment - self.headers = headers - - async def get_fs_info( - self, directories: Sequence[PathType], file_path: PathType - ) -> tuple[Path, FileInfo] | tuple[None, None]: - """Return the resolved path and a :class:`stat_result `. - - Args: - directories: A list of directory paths. - file_path: A file path to resolve - - Returns: - A tuple with an optional resolved :class:`Path ` instance and an optional - :class:`stat_result `. - """ - for directory in directories: - try: - joined_path = Path(directory, file_path) - file_info = await self.adapter.info(joined_path) - if file_info and commonpath([str(directory), file_info["name"], joined_path]) == str(directory): - return joined_path, file_info - except FileNotFoundError: - continue - return None, None - - async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: - """ASGI callable. - - Args: - scope: ASGI scope - receive: ASGI ``receive`` callable - send: ASGI ``send`` callable - - Returns: - None - """ - if scope["type"] != ScopeType.HTTP or scope["method"] not in {"GET", "HEAD"}: - raise MethodNotAllowedException() - - res = await self.handle(path=scope["path"], is_head_response=scope["method"] == "HEAD") - await res(scope=scope, receive=receive, send=send) - - async def handle(self, path: str, is_head_response: bool) -> ASGIFileResponse: - split_path = path.split("/") - filename = split_path[-1] - joined_path = Path(*split_path) - resolved_path, fs_info = await self.get_fs_info(directories=self.directories, file_path=joined_path) - content_disposition_type: Literal["inline", "attachment"] = ( - "attachment" if self.send_as_attachment else "inline" - ) - - if self.is_html_mode and fs_info and fs_info["type"] == "directory": - filename = "index.html" - resolved_path, fs_info = await self.get_fs_info( - directories=self.directories, - file_path=Path(resolved_path or joined_path) / filename, - ) - - if fs_info and fs_info["type"] == "file": - return ASGIFileResponse( - file_path=resolved_path or joined_path, - file_info=fs_info, - file_system=self.adapter.file_system, - filename=filename, - content_disposition_type=content_disposition_type, - is_head_response=is_head_response, - headers=self.headers, - ) - - if self.is_html_mode: - # for some reason coverage doesn't catch these two lines - filename = "404.html" # pragma: no cover - resolved_path, fs_info = await self.get_fs_info( # pragma: no cover - directories=self.directories, file_path=filename - ) - - if fs_info and fs_info["type"] == "file": - return ASGIFileResponse( - file_path=resolved_path or joined_path, - file_info=fs_info, - file_system=self.adapter.file_system, - filename=filename, - status_code=HTTP_404_NOT_FOUND, - content_disposition_type=content_disposition_type, - is_head_response=is_head_response, - headers=self.headers, - ) - - raise NotFoundException( - f"no file or directory match the path {resolved_path or joined_path} was found" - ) # pragma: no cover diff --git a/venv/lib/python3.11/site-packages/litestar/static_files/config.py b/venv/lib/python3.11/site-packages/litestar/static_files/config.py deleted file mode 100644 index 22b6620..0000000 --- a/venv/lib/python3.11/site-packages/litestar/static_files/config.py +++ /dev/null @@ -1,224 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from pathlib import PurePath # noqa: TCH003 -from typing import TYPE_CHECKING, Any, Sequence - -from litestar.exceptions import ImproperlyConfiguredException -from litestar.file_system import BaseLocalFileSystem -from litestar.handlers import asgi, get, head -from litestar.response.file import ASGIFileResponse # noqa: TCH001 -from litestar.router import Router -from litestar.static_files.base import StaticFiles -from litestar.types import Empty -from litestar.utils import normalize_path, warn_deprecation - -__all__ = ("StaticFilesConfig",) - -if TYPE_CHECKING: - from litestar.datastructures import CacheControlHeader - from litestar.handlers.asgi_handlers import ASGIRouteHandler - from litestar.openapi.spec import SecurityRequirement - from litestar.types import ( - AfterRequestHookHandler, - AfterResponseHookHandler, - BeforeRequestHookHandler, - EmptyType, - ExceptionHandlersMap, - Guard, - Middleware, - PathType, - ) - - -@dataclass -class StaticFilesConfig: - """Configuration for static file service. - - To enable static files, pass an instance of this class to the :class:`Litestar ` constructor using - the 'static_files_config' key. - """ - - path: str - """Path to serve static files from. - - Note that the path cannot contain path parameters. - """ - directories: list[PathType] - """A list of directories to serve files from.""" - html_mode: bool = False - """Flag dictating whether serving html. - - If true, the default file will be 'index.html'. - """ - name: str | None = None - """An optional string identifying the static files handler.""" - file_system: Any = BaseLocalFileSystem() # noqa: RUF009 - """The file_system spec to use for serving files. - - Notes: - - A file_system is a class that adheres to the - :class:`FileSystemProtocol `. - - You can use any of the file systems exported from the - [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) library for this purpose. - """ - opt: dict[str, Any] | None = None - """A string key dictionary of arbitrary values that will be added to the static files handler.""" - guards: list[Guard] | None = None - """A list of :class:`Guard ` callables.""" - exception_handlers: ExceptionHandlersMap | None = None - """A dictionary that maps handler functions to status codes and/or exception types.""" - send_as_attachment: bool = False - """Whether to send the file as an attachment.""" - - def __post_init__(self) -> None: - _validate_config(path=self.path, directories=self.directories, file_system=self.file_system) - self.path = normalize_path(self.path) - warn_deprecation( - "2.6.0", - kind="class", - deprecated_name="StaticFilesConfig", - removal_in="3.0", - alternative="create_static_files_router", - info='Replace static_files_config=[StaticFilesConfig(path="/static", directories=["assets"])] with ' - 'route_handlers=[..., create_static_files_router(path="/static", directories=["assets"])]', - ) - - def to_static_files_app(self) -> ASGIRouteHandler: - """Return an ASGI app serving static files based on the config. - - Returns: - :class:`StaticFiles ` - """ - static_files = StaticFiles( - is_html_mode=self.html_mode, - directories=self.directories, - file_system=self.file_system, - send_as_attachment=self.send_as_attachment, - ) - return asgi( - path=self.path, - name=self.name, - is_static=True, - opt=self.opt, - guards=self.guards, - exception_handlers=self.exception_handlers, - )(static_files) - - -def create_static_files_router( - path: str, - directories: list[PathType], - file_system: Any = None, - send_as_attachment: bool = False, - html_mode: bool = False, - name: str = "static", - after_request: AfterRequestHookHandler | None = None, - after_response: AfterResponseHookHandler | None = None, - before_request: BeforeRequestHookHandler | None = None, - cache_control: CacheControlHeader | None = None, - exception_handlers: ExceptionHandlersMap | None = None, - guards: list[Guard] | None = None, - include_in_schema: bool | EmptyType = Empty, - middleware: Sequence[Middleware] | None = None, - opt: dict[str, Any] | None = None, - security: Sequence[SecurityRequirement] | None = None, - tags: Sequence[str] | None = None, - router_class: type[Router] = Router, - resolve_symlinks: bool = True, -) -> Router: - """Create a router with handlers to serve static files. - - Args: - path: Path to serve static files under - directories: Directories to serve static files from - file_system: A *file system* implementing - :class:`~litestar.types.FileSystemProtocol`. - `fsspec `_ can be passed - here as well - send_as_attachment: Whether to send the file as an attachment - html_mode: When in HTML: - - Serve an ``index.html`` file from ``/`` - - Serve ``404.html`` when a file could not be found - name: Name to pass to the generated handlers - after_request: ``after_request`` handlers passed to the router - after_response: ``after_response`` handlers passed to the router - before_request: ``before_request`` handlers passed to the router - cache_control: ``cache_control`` passed to the router - exception_handlers: Exception handlers passed to the router - guards: Guards passed to the router - include_in_schema: Include the routes / router in the OpenAPI schema - middleware: Middlewares passed to the router - opt: Opts passed to the router - security: Security options passed to the router - tags: ``tags`` passed to the router - router_class: The class used to construct a router from - resolve_symlinks: Resolve symlinks of ``directories`` - """ - - if file_system is None: - file_system = BaseLocalFileSystem() - - _validate_config(path=path, directories=directories, file_system=file_system) - path = normalize_path(path) - - headers = None - if cache_control: - headers = {cache_control.HEADER_NAME: cache_control.to_header()} - - static_files = StaticFiles( - is_html_mode=html_mode, - directories=directories, - file_system=file_system, - send_as_attachment=send_as_attachment, - resolve_symlinks=resolve_symlinks, - headers=headers, - ) - - @get("{file_path:path}", name=name) - async def get_handler(file_path: PurePath) -> ASGIFileResponse: - return await static_files.handle(path=file_path.as_posix(), is_head_response=False) - - @head("/{file_path:path}", name=f"{name}/head") - async def head_handler(file_path: PurePath) -> ASGIFileResponse: - return await static_files.handle(path=file_path.as_posix(), is_head_response=True) - - handlers = [get_handler, head_handler] - - if html_mode: - - @get("/", name=f"{name}/index") - async def index_handler() -> ASGIFileResponse: - return await static_files.handle(path="/", is_head_response=False) - - handlers.append(index_handler) - - return router_class( - after_request=after_request, - after_response=after_response, - before_request=before_request, - cache_control=cache_control, - exception_handlers=exception_handlers, - guards=guards, - include_in_schema=include_in_schema, - middleware=middleware, - opt=opt, - path=path, - route_handlers=handlers, - security=security, - tags=tags, - ) - - -def _validate_config(path: str, directories: list[PathType], file_system: Any) -> None: - if not path: - raise ImproperlyConfiguredException("path must be a non-zero length string,") - - if not directories or not any(bool(d) for d in directories): - raise ImproperlyConfiguredException("directories must include at least one path.") - - if "{" in path: - raise ImproperlyConfiguredException("path parameters are not supported for static files") - - if not (callable(getattr(file_system, "info", None)) and callable(getattr(file_system, "open", None))): - raise ImproperlyConfiguredException("file_system must adhere to the FileSystemProtocol type") diff --git a/venv/lib/python3.11/site-packages/litestar/status_codes.py b/venv/lib/python3.11/site-packages/litestar/status_codes.py deleted file mode 100644 index 9293365..0000000 --- a/venv/lib/python3.11/site-packages/litestar/status_codes.py +++ /dev/null @@ -1,321 +0,0 @@ -from typing import Final - -# HTTP Status Codes - -HTTP_100_CONTINUE: Final = 100 -"""HTTP status code 'Continue'""" - -HTTP_101_SWITCHING_PROTOCOLS: Final = 101 -"""HTTP status code 'Switching Protocols'""" - -HTTP_102_PROCESSING: Final = 102 -"""HTTP status code 'Processing'""" - -HTTP_103_EARLY_HINTS: Final = 103 -"""HTTP status code 'Early Hints'""" - -HTTP_200_OK: Final = 200 -"""HTTP status code 'OK'""" - -HTTP_201_CREATED: Final = 201 -"""HTTP status code 'Created'""" - -HTTP_202_ACCEPTED: Final = 202 -"""HTTP status code 'Accepted'""" - -HTTP_203_NON_AUTHORITATIVE_INFORMATION: Final = 203 -"""HTTP status code 'Non Authoritative Information'""" - -HTTP_204_NO_CONTENT: Final = 204 -"""HTTP status code 'No Content'""" - -HTTP_205_RESET_CONTENT: Final = 205 -"""HTTP status code 'Reset Content'""" - -HTTP_206_PARTIAL_CONTENT: Final = 206 -"""HTTP status code 'Partial Content'""" - -HTTP_207_MULTI_STATUS: Final = 207 -"""HTTP status code 'Multi Status'""" - -HTTP_208_ALREADY_REPORTED: Final = 208 -"""HTTP status code 'Already Reported'""" - -HTTP_226_IM_USED: Final = 226 -"""HTTP status code 'I'm Used'""" - -HTTP_300_MULTIPLE_CHOICES: Final = 300 -"""HTTP status code 'Multiple Choices'""" - -HTTP_301_MOVED_PERMANENTLY: Final = 301 -"""HTTP status code 'Moved Permanently'""" - -HTTP_302_FOUND: Final = 302 -"""HTTP status code 'Found'""" - -HTTP_303_SEE_OTHER: Final = 303 -"""HTTP status code 'See Other'""" - -HTTP_304_NOT_MODIFIED: Final = 304 -"""HTTP status code 'Not Modified'""" - -HTTP_305_USE_PROXY: Final = 305 -"""HTTP status code 'Use Proxy'""" - -HTTP_306_RESERVED: Final = 306 -"""HTTP status code 'Reserved'""" - -HTTP_307_TEMPORARY_REDIRECT: Final = 307 -"""HTTP status code 'Temporary Redirect'""" - -HTTP_308_PERMANENT_REDIRECT: Final = 308 -"""HTTP status code 'Permanent Redirect'""" - -HTTP_400_BAD_REQUEST: Final = 400 -"""HTTP status code 'Bad Request'""" - -HTTP_401_UNAUTHORIZED: Final = 401 -"""HTTP status code 'Unauthorized'""" - -HTTP_402_PAYMENT_REQUIRED: Final = 402 -"""HTTP status code 'Payment Required'""" - -HTTP_403_FORBIDDEN: Final = 403 -"""HTTP status code 'Forbidden'""" - -HTTP_404_NOT_FOUND: Final = 404 -"""HTTP status code 'Not Found'""" - -HTTP_405_METHOD_NOT_ALLOWED: Final = 405 -"""HTTP status code 'Method Not Allowed'""" - -HTTP_406_NOT_ACCEPTABLE: Final = 406 -"""HTTP status code 'Not Acceptable'""" - -HTTP_407_PROXY_AUTHENTICATION_REQUIRED: Final = 407 -"""HTTP status code 'Proxy Authentication Required'""" - -HTTP_408_REQUEST_TIMEOUT: Final = 408 -"""HTTP status code 'Request Timeout'""" - -HTTP_409_CONFLICT: Final = 409 -"""HTTP status code 'Conflict'""" - -HTTP_410_GONE: Final = 410 -"""HTTP status code 'Gone'""" - -HTTP_411_LENGTH_REQUIRED: Final = 411 -"""HTTP status code 'Length Required'""" - -HTTP_412_PRECONDITION_FAILED: Final = 412 -"""HTTP status code 'Precondition Failed'""" - -HTTP_413_REQUEST_ENTITY_TOO_LARGE: Final = 413 -"""HTTP status code 'Request Entity Too Large'""" - -HTTP_414_REQUEST_URI_TOO_LONG: Final = 414 -"""HTTP status code 'Request URI Too Long'""" - -HTTP_415_UNSUPPORTED_MEDIA_TYPE: Final = 415 -"""HTTP status code 'Unsupported Media Type'""" - -HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE: Final = 416 -"""HTTP status code 'Requested Range Not Satisfiable'""" - -HTTP_417_EXPECTATION_FAILED: Final = 417 -"""HTTP status code 'Expectation Failed'""" - -HTTP_418_IM_A_TEAPOT: Final = 418 -"""HTTP status code 'I'm A Teapot'""" - -HTTP_421_MISDIRECTED_REQUEST: Final = 421 -"""HTTP status code 'Misdirected Request'""" - -HTTP_422_UNPROCESSABLE_ENTITY: Final = 422 -"""HTTP status code 'Unprocessable Entity'""" - -HTTP_423_LOCKED: Final = 423 -"""HTTP status code 'Locked'""" - -HTTP_424_FAILED_DEPENDENCY: Final = 424 -"""HTTP status code 'Failed Dependency'""" - -HTTP_425_TOO_EARLY: Final = 425 -"""HTTP status code 'Too Early'""" - -HTTP_426_UPGRADE_REQUIRED: Final = 426 -"""HTTP status code 'Upgrade Required'""" - -HTTP_428_PRECONDITION_REQUIRED: Final = 428 -"""HTTP status code 'Precondition Required'""" - -HTTP_429_TOO_MANY_REQUESTS: Final = 429 -"""HTTP status code 'Too Many Requests'""" - -HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE: Final = 431 -"""HTTP status code 'Request Header Fields Too Large'""" - -HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS: Final = 451 -"""HTTP status code 'Unavailable For Legal Reasons'""" - -HTTP_500_INTERNAL_SERVER_ERROR: Final = 500 -"""HTTP status code 'Internal Server Error'""" - -HTTP_501_NOT_IMPLEMENTED: Final = 501 -"""HTTP status code 'Not Implemented'""" - -HTTP_502_BAD_GATEWAY: Final = 502 -"""HTTP status code 'Bad Gateway'""" - -HTTP_503_SERVICE_UNAVAILABLE: Final = 503 -"""HTTP status code 'Service Unavailable'""" - -HTTP_504_GATEWAY_TIMEOUT: Final = 504 -"""HTTP status code 'Gateway Timeout'""" - -HTTP_505_HTTP_VERSION_NOT_SUPPORTED: Final = 505 -"""HTTP status code 'Http Version Not Supported'""" - -HTTP_506_VARIANT_ALSO_NEGOTIATES: Final = 506 -"""HTTP status code 'Variant Also Negotiates'""" - -HTTP_507_INSUFFICIENT_STORAGE: Final = 507 -"""HTTP status code 'Insufficient Storage'""" - -HTTP_508_LOOP_DETECTED: Final = 508 -"""HTTP status code 'Loop Detected'""" - -HTTP_510_NOT_EXTENDED: Final = 510 -"""HTTP status code 'Not Extended'""" - -HTTP_511_NETWORK_AUTHENTICATION_REQUIRED: Final = 511 -"""HTTP status code 'Network Authentication Required'""" - - -# Websocket Codes -WS_1000_NORMAL_CLOSURE: Final = 1000 -"""WebSocket status code 'Normal Closure'""" - -WS_1001_GOING_AWAY: Final = 1001 -"""WebSocket status code 'Going Away'""" - -WS_1002_PROTOCOL_ERROR: Final = 1002 -"""WebSocket status code 'Protocol Error'""" - -WS_1003_UNSUPPORTED_DATA: Final = 1003 -"""WebSocket status code 'Unsupported Data'""" - -WS_1005_NO_STATUS_RECEIVED: Final = 1005 -"""WebSocket status code 'No Status Received'""" - -WS_1006_ABNORMAL_CLOSURE: Final = 1006 -"""WebSocket status code 'Abnormal Closure'""" - -WS_1007_INVALID_FRAME_PAYLOAD_DATA: Final = 1007 -"""WebSocket status code 'Invalid Frame Payload Data'""" - -WS_1008_POLICY_VIOLATION: Final = 1008 -"""WebSocket status code 'Policy Violation'""" - -WS_1009_MESSAGE_TOO_BIG: Final = 1009 -"""WebSocket status code 'Message Too Big'""" - -WS_1010_MANDATORY_EXT: Final = 1010 -"""WebSocket status code 'Mandatory Ext.'""" - -WS_1011_INTERNAL_ERROR: Final = 1011 -"""WebSocket status code 'Internal Error'""" - -WS_1012_SERVICE_RESTART: Final = 1012 -"""WebSocket status code 'Service Restart'""" - -WS_1013_TRY_AGAIN_LATER: Final = 1013 -"""WebSocket status code 'Try Again Later'""" - -WS_1014_BAD_GATEWAY: Final = 1014 -"""WebSocket status code 'Bad Gateway'""" - -WS_1015_TLS_HANDSHAKE: Final = 1015 -"""WebSocket status code 'TLS Handshake'""" - - -__all__ = ( - "HTTP_100_CONTINUE", - "HTTP_101_SWITCHING_PROTOCOLS", - "HTTP_102_PROCESSING", - "HTTP_103_EARLY_HINTS", - "HTTP_200_OK", - "HTTP_201_CREATED", - "HTTP_202_ACCEPTED", - "HTTP_203_NON_AUTHORITATIVE_INFORMATION", - "HTTP_204_NO_CONTENT", - "HTTP_205_RESET_CONTENT", - "HTTP_206_PARTIAL_CONTENT", - "HTTP_207_MULTI_STATUS", - "HTTP_208_ALREADY_REPORTED", - "HTTP_226_IM_USED", - "HTTP_300_MULTIPLE_CHOICES", - "HTTP_301_MOVED_PERMANENTLY", - "HTTP_302_FOUND", - "HTTP_303_SEE_OTHER", - "HTTP_304_NOT_MODIFIED", - "HTTP_305_USE_PROXY", - "HTTP_306_RESERVED", - "HTTP_307_TEMPORARY_REDIRECT", - "HTTP_308_PERMANENT_REDIRECT", - "HTTP_400_BAD_REQUEST", - "HTTP_401_UNAUTHORIZED", - "HTTP_402_PAYMENT_REQUIRED", - "HTTP_403_FORBIDDEN", - "HTTP_404_NOT_FOUND", - "HTTP_405_METHOD_NOT_ALLOWED", - "HTTP_406_NOT_ACCEPTABLE", - "HTTP_407_PROXY_AUTHENTICATION_REQUIRED", - "HTTP_408_REQUEST_TIMEOUT", - "HTTP_409_CONFLICT", - "HTTP_410_GONE", - "HTTP_411_LENGTH_REQUIRED", - "HTTP_412_PRECONDITION_FAILED", - "HTTP_413_REQUEST_ENTITY_TOO_LARGE", - "HTTP_414_REQUEST_URI_TOO_LONG", - "HTTP_415_UNSUPPORTED_MEDIA_TYPE", - "HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE", - "HTTP_417_EXPECTATION_FAILED", - "HTTP_418_IM_A_TEAPOT", - "HTTP_421_MISDIRECTED_REQUEST", - "HTTP_422_UNPROCESSABLE_ENTITY", - "HTTP_423_LOCKED", - "HTTP_424_FAILED_DEPENDENCY", - "HTTP_425_TOO_EARLY", - "HTTP_426_UPGRADE_REQUIRED", - "HTTP_428_PRECONDITION_REQUIRED", - "HTTP_429_TOO_MANY_REQUESTS", - "HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE", - "HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS", - "HTTP_500_INTERNAL_SERVER_ERROR", - "HTTP_501_NOT_IMPLEMENTED", - "HTTP_502_BAD_GATEWAY", - "HTTP_503_SERVICE_UNAVAILABLE", - "HTTP_504_GATEWAY_TIMEOUT", - "HTTP_505_HTTP_VERSION_NOT_SUPPORTED", - "HTTP_506_VARIANT_ALSO_NEGOTIATES", - "HTTP_507_INSUFFICIENT_STORAGE", - "HTTP_508_LOOP_DETECTED", - "HTTP_510_NOT_EXTENDED", - "HTTP_511_NETWORK_AUTHENTICATION_REQUIRED", - "WS_1000_NORMAL_CLOSURE", - "WS_1001_GOING_AWAY", - "WS_1002_PROTOCOL_ERROR", - "WS_1003_UNSUPPORTED_DATA", - "WS_1005_NO_STATUS_RECEIVED", - "WS_1006_ABNORMAL_CLOSURE", - "WS_1007_INVALID_FRAME_PAYLOAD_DATA", - "WS_1008_POLICY_VIOLATION", - "WS_1009_MESSAGE_TOO_BIG", - "WS_1010_MANDATORY_EXT", - "WS_1011_INTERNAL_ERROR", - "WS_1012_SERVICE_RESTART", - "WS_1013_TRY_AGAIN_LATER", - "WS_1014_BAD_GATEWAY", - "WS_1015_TLS_HANDSHAKE", -) diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__init__.py b/venv/lib/python3.11/site-packages/litestar/stores/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 78604d0..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 21d2fb4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/file.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/file.cpython-311.pyc deleted file mode 100644 index b39333c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/file.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/memory.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/memory.cpython-311.pyc deleted file mode 100644 index c8e3b05..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/memory.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/redis.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/redis.cpython-311.pyc deleted file mode 100644 index 21e7e2f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/redis.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/registry.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/registry.cpython-311.pyc deleted file mode 100644 index c87c31a..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/stores/__pycache__/registry.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/stores/base.py b/venv/lib/python3.11/site-packages/litestar/stores/base.py deleted file mode 100644 index 34aa514..0000000 --- a/venv/lib/python3.11/site-packages/litestar/stores/base.py +++ /dev/null @@ -1,145 +0,0 @@ -from __future__ import annotations - -from abc import ABC, abstractmethod -from datetime import datetime, timedelta, timezone -from typing import TYPE_CHECKING, Optional - -from msgspec import Struct -from msgspec.msgpack import decode as msgpack_decode -from msgspec.msgpack import encode as msgpack_encode - -if TYPE_CHECKING: - from types import TracebackType - - from typing_extensions import Self - - -__all__ = ("Store", "NamespacedStore", "StorageObject") - - -class Store(ABC): - """Thread and process safe asynchronous key/value store.""" - - @abstractmethod - async def set(self, key: str, value: str | bytes, expires_in: int | timedelta | None = None) -> None: - """Set a value. - - Args: - key: Key to associate the value with - value: Value to store - expires_in: Time in seconds before the key is considered expired - - Returns: - ``None`` - """ - raise NotImplementedError - - @abstractmethod - async def get(self, key: str, renew_for: int | timedelta | None = None) -> bytes | None: - """Get a value. - - Args: - key: Key associated with the value - renew_for: If given and the value had an initial expiry time set, renew the - expiry time for ``renew_for`` seconds. If the value has not been set - with an expiry time this is a no-op - - Returns: - The value associated with ``key`` if it exists and is not expired, else - ``None`` - """ - raise NotImplementedError - - @abstractmethod - async def delete(self, key: str) -> None: - """Delete a value. - - If no such key exists, this is a no-op. - - Args: - key: Key of the value to delete - """ - raise NotImplementedError - - @abstractmethod - async def delete_all(self) -> None: - """Delete all stored values.""" - raise NotImplementedError - - @abstractmethod - async def exists(self, key: str) -> bool: - """Check if a given ``key`` exists.""" - raise NotImplementedError - - @abstractmethod - async def expires_in(self, key: str) -> int | None: - """Get the time in seconds ``key`` expires in. If no such ``key`` exists or no - expiry time was set, return ``None``. - """ - raise NotImplementedError - - async def __aenter__(self) -> None: # noqa: B027 - pass - - async def __aexit__( # noqa: B027 - self, - exc_type: type[BaseException] | None, - exc_val: BaseException | None, - exc_tb: TracebackType | None, - ) -> None: - pass - - -class NamespacedStore(Store): - """A subclass of :class:`Store`, offering hierarchical namespacing. - - Bulk actions on a parent namespace should affect all child namespaces, whereas other operations on all namespaces - should be isolated. - """ - - @abstractmethod - def with_namespace(self, namespace: str) -> Self: - """Return a new instance of :class:`NamespacedStore`, which exists in a child namespace of the current namespace. - Bulk actions on the parent namespace should affect all child namespaces, whereas other operations on all - namespaces should be isolated. - """ - - -class StorageObject(Struct): - """:class:`msgspec.Struct` to store serialized data alongside with their expiry time.""" - - expires_at: Optional[datetime] # noqa: UP007 - data: bytes - - @classmethod - def new(cls, data: bytes, expires_in: int | timedelta | None) -> StorageObject: - """Construct a new :class:`StorageObject` instance.""" - if expires_in is not None and not isinstance(expires_in, timedelta): - expires_in = timedelta(seconds=expires_in) - return cls( - data=data, - expires_at=(datetime.now(tz=timezone.utc) + expires_in) if expires_in else None, - ) - - @property - def expired(self) -> bool: - """Return if the :class:`StorageObject` is expired""" - return self.expires_at is not None and datetime.now(tz=timezone.utc) >= self.expires_at - - @property - def expires_in(self) -> int: - """Return the expiry time of this ``StorageObject`` in seconds. If no expiry time - was set, return ``-1``. - """ - if self.expires_at: - return int(self.expires_at.timestamp() - datetime.now(tz=timezone.utc).timestamp()) - return -1 - - def to_bytes(self) -> bytes: - """Encode the instance to bytes""" - return msgpack_encode(self) - - @classmethod - def from_bytes(cls, raw: bytes) -> StorageObject: - """Load a previously encoded with :meth:`StorageObject.to_bytes`""" - return msgpack_decode(raw, type=cls) diff --git a/venv/lib/python3.11/site-packages/litestar/stores/file.py b/venv/lib/python3.11/site-packages/litestar/stores/file.py deleted file mode 100644 index 25c52eb..0000000 --- a/venv/lib/python3.11/site-packages/litestar/stores/file.py +++ /dev/null @@ -1,170 +0,0 @@ -from __future__ import annotations - -import os -import shutil -import unicodedata -from tempfile import mkstemp -from typing import TYPE_CHECKING - -from anyio import Path - -from litestar.concurrency import sync_to_thread - -from .base import NamespacedStore, StorageObject - -__all__ = ("FileStore",) - - -if TYPE_CHECKING: - from datetime import timedelta - from os import PathLike - - -def _safe_file_name(name: str) -> str: - name = unicodedata.normalize("NFKD", name) - return "".join(c if c.isalnum() else str(ord(c)) for c in name) - - -class FileStore(NamespacedStore): - """File based, thread and process safe, asynchronous key/value store.""" - - __slots__ = {"path": "file path"} - - def __init__(self, path: PathLike[str]) -> None: - """Initialize ``FileStorage``. - - Args: - path: Path to store data under - """ - self.path = Path(path) - - def with_namespace(self, namespace: str) -> FileStore: - """Return a new instance of :class:`FileStore`, using a sub-path of the current store's path.""" - if not namespace.isalnum(): - raise ValueError(f"Invalid namespace: {namespace!r}") - return FileStore(self.path / namespace) - - def _path_from_key(self, key: str) -> Path: - return self.path / _safe_file_name(key) - - @staticmethod - async def _load_from_path(path: Path) -> StorageObject | None: - try: - data = await path.read_bytes() - return StorageObject.from_bytes(data) - except FileNotFoundError: - return None - - def _write_sync(self, target_file: Path, storage_obj: StorageObject) -> None: - try: - tmp_file_fd, tmp_file_name = mkstemp(dir=self.path, prefix=f"{target_file.name}.tmp") - renamed = False - try: - try: - os.write(tmp_file_fd, storage_obj.to_bytes()) - finally: - os.close(tmp_file_fd) - - os.replace(tmp_file_name, target_file) # noqa: PTH105 - renamed = True - finally: - if not renamed: - os.unlink(tmp_file_name) # noqa: PTH108 - except OSError: - pass - - async def _write(self, target_file: Path, storage_obj: StorageObject) -> None: - await sync_to_thread(self._write_sync, target_file, storage_obj) - - async def set(self, key: str, value: str | bytes, expires_in: int | timedelta | None = None) -> None: - """Set a value. - - Args: - key: Key to associate the value with - value: Value to store - expires_in: Time in seconds before the key is considered expired - - Returns: - ``None`` - """ - - await self.path.mkdir(exist_ok=True) - path = self._path_from_key(key) - if isinstance(value, str): - value = value.encode("utf-8") - storage_obj = StorageObject.new(data=value, expires_in=expires_in) - await self._write(path, storage_obj) - - async def get(self, key: str, renew_for: int | timedelta | None = None) -> bytes | None: - """Get a value. - - Args: - key: Key associated with the value - renew_for: If given and the value had an initial expiry time set, renew the - expiry time for ``renew_for`` seconds. If the value has not been set - with an expiry time this is a no-op - - Returns: - The value associated with ``key`` if it exists and is not expired, else - ``None`` - """ - path = self._path_from_key(key) - storage_obj = await self._load_from_path(path) - - if not storage_obj: - return None - - if storage_obj.expired: - await path.unlink(missing_ok=True) - return None - - if renew_for and storage_obj.expires_at: - await self.set(key, value=storage_obj.data, expires_in=renew_for) - - return storage_obj.data - - async def delete(self, key: str) -> None: - """Delete a value. - - If no such key exists, this is a no-op. - - Args: - key: Key of the value to delete - """ - path = self._path_from_key(key) - await path.unlink(missing_ok=True) - - async def delete_all(self) -> None: - """Delete all stored values. - - Note: - This deletes and recreates :attr:`FileStore.path` - """ - - await sync_to_thread(shutil.rmtree, self.path) - await self.path.mkdir(exist_ok=True) - - async def delete_expired(self) -> None: - """Delete expired items. - - Since expired items are normally only cleared on access (i.e. when calling - :meth:`.get`), this method should be called in regular intervals - to free disk space. - """ - async for file in self.path.iterdir(): - wrapper = await self._load_from_path(file) - if wrapper and wrapper.expired: - await file.unlink(missing_ok=True) - - async def exists(self, key: str) -> bool: - """Check if a given ``key`` exists.""" - path = self._path_from_key(key) - return await path.exists() - - async def expires_in(self, key: str) -> int | None: - """Get the time in seconds ``key`` expires in. If no such ``key`` exists or no - expiry time was set, return ``None``. - """ - if storage_obj := await self._load_from_path(self._path_from_key(key)): - return storage_obj.expires_in - return None diff --git a/venv/lib/python3.11/site-packages/litestar/stores/memory.py b/venv/lib/python3.11/site-packages/litestar/stores/memory.py deleted file mode 100644 index 1da8931..0000000 --- a/venv/lib/python3.11/site-packages/litestar/stores/memory.py +++ /dev/null @@ -1,115 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -import anyio -from anyio import Lock - -from .base import StorageObject, Store - -__all__ = ("MemoryStore",) - - -if TYPE_CHECKING: - from datetime import timedelta - - -class MemoryStore(Store): - """In memory, atomic, asynchronous key/value store.""" - - __slots__ = ("_store", "_lock") - - def __init__(self) -> None: - """Initialize :class:`MemoryStore`""" - self._store: dict[str, StorageObject] = {} - self._lock = Lock() - - async def set(self, key: str, value: str | bytes, expires_in: int | timedelta | None = None) -> None: - """Set a value. - - Args: - key: Key to associate the value with - value: Value to store - expires_in: Time in seconds before the key is considered expired - - Returns: - ``None`` - """ - if isinstance(value, str): - value = value.encode("utf-8") - async with self._lock: - self._store[key] = StorageObject.new(data=value, expires_in=expires_in) - - async def get(self, key: str, renew_for: int | timedelta | None = None) -> bytes | None: - """Get a value. - - Args: - key: Key associated with the value - renew_for: If given and the value had an initial expiry time set, renew the - expiry time for ``renew_for`` seconds. If the value has not been set - with an expiry time this is a no-op - - Returns: - The value associated with ``key`` if it exists and is not expired, else - ``None`` - """ - async with self._lock: - storage_obj = self._store.get(key) - - if not storage_obj: - return None - - if storage_obj.expired: - self._store.pop(key) - return None - - if renew_for and storage_obj.expires_at: - # don't use .set() here, so we can hold onto the lock for the whole operation - storage_obj = StorageObject.new(data=storage_obj.data, expires_in=renew_for) - self._store[key] = storage_obj - - return storage_obj.data - - async def delete(self, key: str) -> None: - """Delete a value. - - If no such key exists, this is a no-op. - - Args: - key: Key of the value to delete - """ - async with self._lock: - self._store.pop(key, None) - - async def delete_all(self) -> None: - """Delete all stored values.""" - async with self._lock: - self._store.clear() - - async def delete_expired(self) -> None: - """Delete expired items. - - Since expired items are normally only cleared on access (i.e. when calling - :meth:`.get`), this method should be called in regular intervals - to free memory. - """ - async with self._lock: - new_store = {} - for i, (key, storage_obj) in enumerate(self._store.items()): - if not storage_obj.expired: - new_store[key] = storage_obj - if i % 1000 == 0: - await anyio.sleep(0) - self._store = new_store - - async def exists(self, key: str) -> bool: - """Check if a given ``key`` exists.""" - return key in self._store - - async def expires_in(self, key: str) -> int | None: - """Get the time in seconds ``key`` expires in. If no such ``key`` exists or no - expiry time was set, return ``None``. - """ - if storage_obj := self._store.get(key): - return storage_obj.expires_in - return None diff --git a/venv/lib/python3.11/site-packages/litestar/stores/redis.py b/venv/lib/python3.11/site-packages/litestar/stores/redis.py deleted file mode 100644 index 6697962..0000000 --- a/venv/lib/python3.11/site-packages/litestar/stores/redis.py +++ /dev/null @@ -1,204 +0,0 @@ -from __future__ import annotations - -from datetime import timedelta -from typing import TYPE_CHECKING, cast - -from redis.asyncio import Redis -from redis.asyncio.connection import ConnectionPool - -from litestar.exceptions import ImproperlyConfiguredException -from litestar.types import Empty, EmptyType -from litestar.utils.empty import value_or_default - -from .base import NamespacedStore - -__all__ = ("RedisStore",) - -if TYPE_CHECKING: - from types import TracebackType - - -class RedisStore(NamespacedStore): - """Redis based, thread and process safe asynchronous key/value store.""" - - __slots__ = ("_redis",) - - def __init__( - self, redis: Redis, namespace: str | None | EmptyType = Empty, handle_client_shutdown: bool = False - ) -> None: - """Initialize :class:`RedisStore` - - Args: - redis: An :class:`redis.asyncio.Redis` instance - namespace: A key prefix to simulate a namespace in redis. If not given, - defaults to ``LITESTAR``. Namespacing can be explicitly disabled by passing - ``None``. This will make :meth:`.delete_all` unavailable. - handle_client_shutdown: If ``True``, handle the shutdown of the `redis` instance automatically during the store's lifespan. Should be set to `True` unless the shutdown is handled externally - """ - self._redis = redis - self.namespace: str | None = value_or_default(namespace, "LITESTAR") - self.handle_client_shutdown = handle_client_shutdown - - # script to get and renew a key in one atomic step - self._get_and_renew_script = self._redis.register_script( - b""" - local key = KEYS[1] - local renew = tonumber(ARGV[1]) - - local data = redis.call('GET', key) - local ttl = redis.call('TTL', key) - - if ttl > 0 then - redis.call('EXPIRE', key, renew) - end - - return data - """ - ) - - # script to delete all keys in the namespace - self._delete_all_script = self._redis.register_script( - b""" - local cursor = 0 - - repeat - local result = redis.call('SCAN', cursor, 'MATCH', ARGV[1]) - for _,key in ipairs(result[2]) do - redis.call('UNLINK', key) - end - cursor = tonumber(result[1]) - until cursor == 0 - """ - ) - - async def _shutdown(self) -> None: - if self.handle_client_shutdown: - await self._redis.aclose(close_connection_pool=True) # type: ignore[attr-defined] - - async def __aexit__( - self, - exc_type: type[BaseException] | None, - exc_val: BaseException | None, - exc_tb: TracebackType | None, - ) -> None: - await self._shutdown() - - @classmethod - def with_client( - cls, - url: str = "redis://localhost:6379", - *, - db: int | None = None, - port: int | None = None, - username: str | None = None, - password: str | None = None, - namespace: str | None | EmptyType = Empty, - ) -> RedisStore: - """Initialize a :class:`RedisStore` instance with a new class:`redis.asyncio.Redis` instance. - - Args: - url: Redis URL to connect to - db: Redis database to use - port: Redis port to use - username: Redis username to use - password: Redis password to use - namespace: Virtual key namespace to use - """ - pool = ConnectionPool.from_url( - url=url, - db=db, - decode_responses=False, - port=port, - username=username, - password=password, - ) - return cls( - redis=Redis(connection_pool=pool), - namespace=namespace, - handle_client_shutdown=True, - ) - - def with_namespace(self, namespace: str) -> RedisStore: - """Return a new :class:`RedisStore` with a nested virtual key namespace. - The current instances namespace will serve as a prefix for the namespace, so it - can be considered the parent namespace. - """ - return type(self)( - redis=self._redis, - namespace=f"{self.namespace}_{namespace}" if self.namespace else namespace, - handle_client_shutdown=self.handle_client_shutdown, - ) - - def _make_key(self, key: str) -> str: - prefix = f"{self.namespace}:" if self.namespace else "" - return prefix + key - - async def set(self, key: str, value: str | bytes, expires_in: int | timedelta | None = None) -> None: - """Set a value. - - Args: - key: Key to associate the value with - value: Value to store - expires_in: Time in seconds before the key is considered expired - - Returns: - ``None`` - """ - if isinstance(value, str): - value = value.encode("utf-8") - await self._redis.set(self._make_key(key), value, ex=expires_in) - - async def get(self, key: str, renew_for: int | timedelta | None = None) -> bytes | None: - """Get a value. - - Args: - key: Key associated with the value - renew_for: If given and the value had an initial expiry time set, renew the - expiry time for ``renew_for`` seconds. If the value has not been set - with an expiry time this is a no-op. Atomicity of this step is guaranteed - by using a lua script to execute fetch and renewal. If ``renew_for`` is - not given, the script will be bypassed so no overhead will occur - - Returns: - The value associated with ``key`` if it exists and is not expired, else - ``None`` - """ - key = self._make_key(key) - if renew_for: - if isinstance(renew_for, timedelta): - renew_for = renew_for.seconds - data = await self._get_and_renew_script(keys=[key], args=[renew_for]) - return cast("bytes | None", data) - return await self._redis.get(key) - - async def delete(self, key: str) -> None: - """Delete a value. - - If no such key exists, this is a no-op. - - Args: - key: Key of the value to delete - """ - await self._redis.delete(self._make_key(key)) - - async def delete_all(self) -> None: - """Delete all stored values in the virtual key namespace. - - Raises: - ImproperlyConfiguredException: If no namespace was configured - """ - if not self.namespace: - raise ImproperlyConfiguredException("Cannot perform delete operation: No namespace configured") - - await self._delete_all_script(keys=[], args=[f"{self.namespace}*:*"]) - - async def exists(self, key: str) -> bool: - """Check if a given ``key`` exists.""" - return await self._redis.exists(self._make_key(key)) == 1 - - async def expires_in(self, key: str) -> int | None: - """Get the time in seconds ``key`` expires in. If no such ``key`` exists or no - expiry time was set, return ``None``. - """ - ttl = await self._redis.ttl(self._make_key(key)) - return None if ttl == -2 else ttl diff --git a/venv/lib/python3.11/site-packages/litestar/stores/registry.py b/venv/lib/python3.11/site-packages/litestar/stores/registry.py deleted file mode 100644 index 11a08c2..0000000 --- a/venv/lib/python3.11/site-packages/litestar/stores/registry.py +++ /dev/null @@ -1,64 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Callable - -if TYPE_CHECKING: - from .base import Store - - -from .memory import MemoryStore - -__all__ = ("StoreRegistry",) - - -def default_default_factory(name: str) -> Store: - return MemoryStore() - - -class StoreRegistry: - """Registry for :class:`Store <.base.Store>` instances.""" - - __slots__ = ("_stores", "_default_factory") - - def __init__( - self, stores: dict[str, Store] | None = None, default_factory: Callable[[str], Store] = default_default_factory - ) -> None: - """Initialize ``StoreRegistry``. - - Args: - stores: A dictionary mapping store names to stores, used to initialize the registry - default_factory: A callable used by :meth:`StoreRegistry.get` to provide a store, if the requested name hasn't - been registered yet. This callable receives the requested name and should return a - :class:`Store <.base.Store>` instance. - """ - self._stores = stores or {} - self._default_factory = default_factory - - def register(self, name: str, store: Store, allow_override: bool = False) -> None: - """Register a new :class:`Store <.base.Store>`. - - Args: - name: Name to register the store under - store: The store to register - allow_override: Whether to allow overriding an existing store of the same name - - Raises: - ValueError: If a store is already registered under this name and ``override`` is not ``True`` - """ - if not allow_override and name in self._stores: - raise ValueError(f"Store with the name {name!r} already exists") - self._stores[name] = store - - def get(self, name: str) -> Store: - """Get a store registered under ``name``. If no such store is registered, create a store using the default - factory with ``name`` and register the returned store under ``name``. - - Args: - name: Name of the store - - Returns: - A :class:`Store <.base.Store>` - """ - if not self._stores.get(name): - self._stores[name] = self._default_factory(name) - return self._stores[name] diff --git a/venv/lib/python3.11/site-packages/litestar/template/__init__.py b/venv/lib/python3.11/site-packages/litestar/template/__init__.py deleted file mode 100644 index 5989cea..0000000 --- a/venv/lib/python3.11/site-packages/litestar/template/__init__.py +++ /dev/null @@ -1,4 +0,0 @@ -from litestar.template.base import TemplateEngineProtocol, TemplateProtocol -from litestar.template.config import TemplateConfig - -__all__ = ("TemplateEngineProtocol", "TemplateProtocol", "TemplateConfig") diff --git a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/template/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 7270a06..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/template/__pycache__/base.cpython-311.pyc deleted file mode 100644 index f69e72d..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/config.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/template/__pycache__/config.cpython-311.pyc deleted file mode 100644 index 536a922..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/template/__pycache__/config.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/template/base.py b/venv/lib/python3.11/site-packages/litestar/template/base.py deleted file mode 100644 index 3474717..0000000 --- a/venv/lib/python3.11/site-packages/litestar/template/base.py +++ /dev/null @@ -1,187 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any, Callable, Mapping, Protocol, TypedDict, TypeVar, cast, runtime_checkable - -from typing_extensions import Concatenate, ParamSpec, TypeAlias - -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.empty import value_or_default -from litestar.utils.scope.state import ScopeState - -if TYPE_CHECKING: - from pathlib import Path - - from litestar.connection import Request - -__all__ = ( - "TemplateCallableType", - "TemplateEngineProtocol", - "TemplateProtocol", - "csrf_token", - "url_for", - "url_for_static_asset", -) - - -def _get_request_from_context(context: Mapping[str, Any]) -> Request: - """Get the request from the template context. - - Args: - context: The template context. - - Returns: - The request object. - """ - return cast("Request", context["request"]) - - -def url_for(context: Mapping[str, Any], /, route_name: str, **path_parameters: Any) -> str: - """Wrap :func:`route_reverse ` to be used in templates. - - Args: - context: The template context. - route_name: The name of the route handler. - **path_parameters: Actual values for path parameters in the route. - - Raises: - NoRouteMatchFoundException: If ``route_name`` does not exist, path parameters are missing in **path_parameters - or have wrong type. - - Returns: - A fully formatted url path. - """ - return _get_request_from_context(context).app.route_reverse(route_name, **path_parameters) - - -def csrf_token(context: Mapping[str, Any], /) -> str: - """Set a CSRF token on the template. - - Notes: - - to use this function make sure to pass an instance of :ref:`CSRFConfig ` to - the :class:`Litestar ` constructor. - - Args: - context: The template context. - - Returns: - A CSRF token if the app level ``csrf_config`` is set, otherwise an empty string. - """ - scope = _get_request_from_context(context).scope - return value_or_default(ScopeState.from_scope(scope).csrf_token, "") - - -def url_for_static_asset(context: Mapping[str, Any], /, name: str, file_path: str) -> str: - """Wrap :meth:`url_for_static_asset ` to be used in templates. - - Args: - context: The template context object. - name: A static handler unique name. - file_path: a string containing path to an asset. - - Raises: - NoRouteMatchFoundException: If static files handler with ``name`` does not exist. - - Returns: - A url path to the asset. - """ - return _get_request_from_context(context).app.url_for_static_asset(name, file_path) - - -class TemplateProtocol(Protocol): - """Protocol Defining a ``Template``. - - Template is a class that has a render method which renders the template into a string. - """ - - def render(self, *args: Any, **kwargs: Any) -> str: - """Return the rendered template as a string. - - Args: - *args: Positional arguments passed to the TemplateEngine - **kwargs: A string keyed mapping of values passed to the TemplateEngine - - Returns: - The rendered template string - """ - raise NotImplementedError - - -P = ParamSpec("P") -R = TypeVar("R") -ContextType = TypeVar("ContextType") -ContextType_co = TypeVar("ContextType_co", covariant=True) -TemplateType_co = TypeVar("TemplateType_co", bound=TemplateProtocol, covariant=True) -TemplateCallableType: TypeAlias = Callable[Concatenate[ContextType, P], R] - - -@runtime_checkable -class TemplateEngineProtocol(Protocol[TemplateType_co, ContextType_co]): - """Protocol for template engines.""" - - def __init__(self, directory: Path | list[Path] | None, engine_instance: Any | None) -> None: - """Initialize the template engine with a directory. - - Args: - directory: Direct path or list of directory paths from which to serve templates, if provided the - implementation has to create the engine instance. - engine_instance: A template engine object, if provided the implementation has to use it. - """ - - def get_template(self, template_name: str) -> TemplateType_co: - """Retrieve a template by matching its name (dotted path) with files in the directory or directories provided. - - Args: - template_name: A dotted path - - Returns: - Template instance - - Raises: - TemplateNotFoundException: if no template is found. - """ - raise NotImplementedError - - def render_string(self, template_string: str, context: Mapping[str, Any]) -> str: - """Render a template from a string with the given context. - - Args: - template_string: The template string to render. - context: A dictionary of variables to pass to the template. - - Returns: - The rendered template as a string. - """ - raise NotImplementedError - - def register_template_callable( - self, key: str, template_callable: TemplateCallableType[ContextType_co, P, R] - ) -> None: - """Register a callable on the template engine. - - Args: - key: The callable key, i.e. the value to use inside the template to call the callable. - template_callable: A callable to register. - - Returns: - None - """ - - -class _TemplateContext(TypedDict): - """Dictionary representing a template context.""" - - request: Request[Any, Any, Any] - csrf_input: str - - -def __getattr__(name: str) -> Any: - if name == "TemplateContext": - warn_deprecation( - "2.3.0", - "TemplateContext", - "import", - removal_in="3.0.0", - alternative="Mapping", - ) - return _TemplateContext - raise AttributeError(f"module {__name__!r} has no attribute {name!r}") diff --git a/venv/lib/python3.11/site-packages/litestar/template/config.py b/venv/lib/python3.11/site-packages/litestar/template/config.py deleted file mode 100644 index d2aa87c..0000000 --- a/venv/lib/python3.11/site-packages/litestar/template/config.py +++ /dev/null @@ -1,57 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field -from functools import cached_property -from inspect import isclass -from typing import TYPE_CHECKING, Callable, Generic, TypeVar, cast - -from litestar.exceptions import ImproperlyConfiguredException -from litestar.template import TemplateEngineProtocol - -__all__ = ("TemplateConfig",) - -if TYPE_CHECKING: - from litestar.types import PathType - -EngineType = TypeVar("EngineType", bound=TemplateEngineProtocol) - - -@dataclass -class TemplateConfig(Generic[EngineType]): - """Configuration for Templating. - - To enable templating, pass an instance of this class to the :class:`Litestar ` constructor using the - 'template_config' key. - """ - - engine: type[EngineType] | EngineType | None = field(default=None) - """A template engine adhering to the :class:`TemplateEngineProtocol `.""" - directory: PathType | list[PathType] | None = field(default=None) - """A directory or list of directories from which to serve templates.""" - engine_callback: Callable[[EngineType], None] | None = field(default=None) - """A callback function that allows modifying the instantiated templating protocol.""" - instance: EngineType | None = field(default=None) - """An instance of the templating protocol.""" - - def __post_init__(self) -> None: - """Ensure that directory is set if engine is a class.""" - if isclass(self.engine) and not self.directory: - raise ImproperlyConfiguredException("directory is a required kwarg when passing a template engine class") - """Ensure that directory is not set if instance is.""" - if self.instance is not None and self.directory is not None: - raise ImproperlyConfiguredException("directory cannot be set if instance is") - - def to_engine(self) -> EngineType: - """Instantiate the template engine.""" - template_engine = cast( - "EngineType", - self.engine(directory=self.directory, engine_instance=None) if isclass(self.engine) else self.engine, - ) - if callable(self.engine_callback): - self.engine_callback(template_engine) - return template_engine - - @cached_property - def engine_instance(self) -> EngineType: - """Return the template engine instance.""" - return self.to_engine() if self.instance is None else self.instance diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__init__.py b/venv/lib/python3.11/site-packages/litestar/testing/__init__.py deleted file mode 100644 index 55af446..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ -from litestar.testing.client.async_client import AsyncTestClient -from litestar.testing.client.base import BaseTestClient -from litestar.testing.client.sync_client import TestClient -from litestar.testing.helpers import create_async_test_client, create_test_client -from litestar.testing.request_factory import RequestFactory -from litestar.testing.websocket_test_session import WebSocketTestSession - -__all__ = ( - "AsyncTestClient", - "BaseTestClient", - "create_async_test_client", - "create_test_client", - "RequestFactory", - "TestClient", - "WebSocketTestSession", -) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 77c7908..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/helpers.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/helpers.cpython-311.pyc deleted file mode 100644 index a85995f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/helpers.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/life_span_handler.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/life_span_handler.cpython-311.pyc deleted file mode 100644 index b3ea9ef..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/life_span_handler.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/request_factory.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/request_factory.cpython-311.pyc deleted file mode 100644 index 9a66826..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/request_factory.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/transport.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/transport.cpython-311.pyc deleted file mode 100644 index 78a1aa6..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/transport.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/websocket_test_session.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/websocket_test_session.cpython-311.pyc deleted file mode 100644 index 6b00590..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/__pycache__/websocket_test_session.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/__init__.py b/venv/lib/python3.11/site-packages/litestar/testing/client/__init__.py deleted file mode 100644 index 5d03a7a..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/client/__init__.py +++ /dev/null @@ -1,36 +0,0 @@ -"""Some code in this module was adapted from https://github.com/encode/starlette/blob/master/starlette/testclient.py. - -Copyright © 2018, [Encode OSS Ltd](https://www.encode.io/). -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -""" - -from .async_client import AsyncTestClient -from .base import BaseTestClient -from .sync_client import TestClient - -__all__ = ("TestClient", "AsyncTestClient", "BaseTestClient") diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 18ad148..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/async_client.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/async_client.cpython-311.pyc deleted file mode 100644 index 1ccc805..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/async_client.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/base.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/base.cpython-311.pyc deleted file mode 100644 index 87d5de7..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/base.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/sync_client.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/sync_client.cpython-311.pyc deleted file mode 100644 index 29f0576..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/testing/client/__pycache__/sync_client.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/async_client.py b/venv/lib/python3.11/site-packages/litestar/testing/client/async_client.py deleted file mode 100644 index cf66f12..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/client/async_client.py +++ /dev/null @@ -1,534 +0,0 @@ -from __future__ import annotations - -from contextlib import AsyncExitStack -from typing import TYPE_CHECKING, Any, Generic, Mapping, TypeVar - -from httpx import USE_CLIENT_DEFAULT, AsyncClient, Response - -from litestar import HttpMethod -from litestar.testing.client.base import BaseTestClient -from litestar.testing.life_span_handler import LifeSpanHandler -from litestar.testing.transport import TestClientTransport -from litestar.types import AnyIOBackend, ASGIApp - -if TYPE_CHECKING: - from httpx._client import UseClientDefault - from httpx._types import ( - AuthTypes, - CookieTypes, - HeaderTypes, - QueryParamTypes, - RequestContent, - RequestData, - RequestFiles, - TimeoutTypes, - URLTypes, - ) - from typing_extensions import Self - - from litestar.middleware.session.base import BaseBackendConfig - - -T = TypeVar("T", bound=ASGIApp) - - -class AsyncTestClient(AsyncClient, BaseTestClient, Generic[T]): # type: ignore[misc] - lifespan_handler: LifeSpanHandler[Any] - exit_stack: AsyncExitStack - - def __init__( - self, - app: T, - base_url: str = "http://testserver.local", - raise_server_exceptions: bool = True, - root_path: str = "", - backend: AnyIOBackend = "asyncio", - backend_options: Mapping[str, Any] | None = None, - session_config: BaseBackendConfig | None = None, - timeout: float | None = None, - cookies: CookieTypes | None = None, - ) -> None: - """An Async client implementation providing a context manager for testing applications asynchronously. - - Args: - app: The instance of :class:`Litestar ` under test. - base_url: URL scheme and domain for test request paths, e.g. ``http://testserver``. - raise_server_exceptions: Flag for the underlying test client to raise server exceptions instead of - wrapping them in an HTTP response. - root_path: Path prefix for requests. - backend: The async backend to use, options are "asyncio" or "trio". - backend_options: 'anyio' options. - session_config: Configuration for Session Middleware class to create raw session cookies for request to the - route handlers. - timeout: Request timeout - cookies: Cookies to set on the client. - """ - BaseTestClient.__init__( - self, - app=app, - base_url=base_url, - backend=backend, - backend_options=backend_options, - session_config=session_config, - cookies=cookies, - ) - AsyncClient.__init__( - self, - base_url=base_url, - headers={"user-agent": "testclient"}, - follow_redirects=True, - cookies=cookies, - transport=TestClientTransport( # type: ignore [arg-type] - client=self, - raise_server_exceptions=raise_server_exceptions, - root_path=root_path, - ), - timeout=timeout, - ) - - async def __aenter__(self) -> Self: - async with AsyncExitStack() as stack: - self.blocking_portal = portal = stack.enter_context(self.portal()) - self.lifespan_handler = LifeSpanHandler(client=self) - - @stack.callback - def reset_portal() -> None: - delattr(self, "blocking_portal") - - @stack.callback - def wait_shutdown() -> None: - portal.call(self.lifespan_handler.wait_shutdown) - - self.exit_stack = stack.pop_all() - return self - - async def __aexit__(self, *args: Any) -> None: - await self.exit_stack.aclose() - - async def request( - self, - method: str, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault | None = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a request. - - Args: - method: An HTTP method. - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.request( - self, - url=self.base_url.join(url), - method=method.value if isinstance(method, HttpMethod) else method, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def get( # type: ignore [override] - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a GET request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.get( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def options( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends an OPTIONS request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.options( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def head( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a HEAD request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.head( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def post( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a POST request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.post( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def put( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a PUT request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.put( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def patch( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a PATCH request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.patch( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def delete( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a DELETE request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return await AsyncClient.delete( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - async def get_session_data(self) -> dict[str, Any]: - """Get session data. - - Returns: - A dictionary containing session data. - - Examples: - .. code-block:: python - - from litestar import Litestar, post - from litestar.middleware.session.memory_backend import MemoryBackendConfig - - session_config = MemoryBackendConfig() - - - @post(path="/test") - def set_session_data(request: Request) -> None: - request.session["foo"] == "bar" - - - app = Litestar( - route_handlers=[set_session_data], middleware=[session_config.middleware] - ) - - async with AsyncTestClient(app=app, session_config=session_config) as client: - await client.post("/test") - assert await client.get_session_data() == {"foo": "bar"} - - """ - return await super()._get_session_data() - - async def set_session_data(self, data: dict[str, Any]) -> None: - """Set session data. - - Args: - data: Session data - - Returns: - None - - Examples: - .. code-block:: python - - from litestar import Litestar, get - from litestar.middleware.session.memory_backend import MemoryBackendConfig - - session_config = MemoryBackendConfig() - - - @get(path="/test") - def get_session_data(request: Request) -> Dict[str, Any]: - return request.session - - - app = Litestar( - route_handlers=[get_session_data], middleware=[session_config.middleware] - ) - - async with AsyncTestClient(app=app, session_config=session_config) as client: - await client.set_session_data({"foo": "bar"}) - assert await client.get("/test").json() == {"foo": "bar"} - - """ - return await super()._set_session_data(data) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/base.py b/venv/lib/python3.11/site-packages/litestar/testing/client/base.py deleted file mode 100644 index 3c25be1..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/client/base.py +++ /dev/null @@ -1,180 +0,0 @@ -from __future__ import annotations - -from contextlib import contextmanager -from http.cookiejar import CookieJar -from typing import TYPE_CHECKING, Any, Generator, Generic, Mapping, TypeVar, cast -from warnings import warn - -from anyio.from_thread import BlockingPortal, start_blocking_portal -from httpx import Cookies, Request, Response - -from litestar import Litestar -from litestar.connection import ASGIConnection -from litestar.datastructures import MutableScopeHeaders -from litestar.enums import ScopeType -from litestar.exceptions import ( - ImproperlyConfiguredException, -) -from litestar.types import AnyIOBackend, ASGIApp, HTTPResponseStartEvent -from litestar.utils.scope.state import ScopeState - -if TYPE_CHECKING: - from httpx._types import CookieTypes - - from litestar.middleware.session.base import BaseBackendConfig, BaseSessionBackend - from litestar.types.asgi_types import HTTPScope, Receive, Scope, Send - -T = TypeVar("T", bound=ASGIApp) - - -def fake_http_send_message(headers: MutableScopeHeaders) -> HTTPResponseStartEvent: - headers.setdefault("content-type", "application/text") - return HTTPResponseStartEvent(type="http.response.start", status=200, headers=headers.headers) - - -def fake_asgi_connection(app: ASGIApp, cookies: dict[str, str]) -> ASGIConnection[Any, Any, Any, Any]: - scope: HTTPScope = { - "type": ScopeType.HTTP, - "path": "/", - "raw_path": b"/", - "root_path": "", - "scheme": "http", - "query_string": b"", - "client": ("testclient", 50000), - "server": ("testserver", 80), - "headers": [], - "method": "GET", - "http_version": "1.1", - "extensions": {"http.response.template": {}}, - "app": app, # type: ignore[typeddict-item] - "state": {}, - "path_params": {}, - "route_handler": None, # type: ignore[typeddict-item] - "asgi": {"version": "3.0", "spec_version": "2.1"}, - "auth": None, - "session": None, - "user": None, - } - ScopeState.from_scope(scope).cookies = cookies - return ASGIConnection[Any, Any, Any, Any](scope=scope) - - -def _wrap_app_to_add_state(app: ASGIApp) -> ASGIApp: - """Wrap an ASGI app to add state to the scope. - - Litestar depends on `state` being present in the ASGI connection scope. Scope state is optional in the ASGI spec, - however, the Litestar app always ensures it is present so that it can be depended on internally. - - When the ASGI app that is passed to the test client is _not_ a Litestar app, we need to add - state to the scope, because httpx does not do this for us. - - This assists us in testing Litestar components that rely on state being present in the scope, without having - to create a Litestar app for every test case. - - Args: - app: The ASGI app to wrap. - - Returns: - The wrapped ASGI app. - """ - - async def wrapped(scope: Scope, receive: Receive, send: Send) -> None: - scope["state"] = {} - await app(scope, receive, send) - - return wrapped - - -class BaseTestClient(Generic[T]): - __test__ = False - blocking_portal: BlockingPortal - - __slots__ = ( - "app", - "base_url", - "backend", - "backend_options", - "session_config", - "_session_backend", - "cookies", - ) - - def __init__( - self, - app: T, - base_url: str = "http://testserver.local", - backend: AnyIOBackend = "asyncio", - backend_options: Mapping[str, Any] | None = None, - session_config: BaseBackendConfig | None = None, - cookies: CookieTypes | None = None, - ) -> None: - if "." not in base_url: - warn( - f"The base_url {base_url!r} might cause issues. Try adding a domain name such as .local: " - f"'{base_url}.local'", - UserWarning, - stacklevel=1, - ) - - self._session_backend: BaseSessionBackend | None = None - if session_config: - self._session_backend = session_config._backend_class(config=session_config) - - if not isinstance(app, Litestar): - app = _wrap_app_to_add_state(app) # type: ignore[assignment] - - self.app = cast("T", app) # type: ignore[redundant-cast] # pyright needs this - - self.base_url = base_url - self.backend = backend - self.backend_options = backend_options - self.cookies = cookies - - @property - def session_backend(self) -> BaseSessionBackend[Any]: - if not self._session_backend: - raise ImproperlyConfiguredException( - "Session has not been initialized for this TestClient instance. You can" - "do so by passing a configuration object to TestClient: TestClient(app=app, session_config=...)" - ) - return self._session_backend - - @contextmanager - def portal(self) -> Generator[BlockingPortal, None, None]: - """Get a BlockingPortal. - - Returns: - A contextmanager for a BlockingPortal. - """ - if hasattr(self, "blocking_portal"): - yield self.blocking_portal - else: - with start_blocking_portal( - backend=self.backend, backend_options=dict(self.backend_options or {}) - ) as portal: - yield portal - - async def _set_session_data(self, data: dict[str, Any]) -> None: - mutable_headers = MutableScopeHeaders() - connection = fake_asgi_connection( - app=self.app, - cookies=dict(self.cookies), # type: ignore[arg-type] - ) - session_id = self.session_backend.get_session_id(connection) - connection._connection_state.session_id = session_id # pyright: ignore [reportGeneralTypeIssues] - await self.session_backend.store_in_message( - scope_session=data, message=fake_http_send_message(mutable_headers), connection=connection - ) - response = Response(200, request=Request("GET", self.base_url), headers=mutable_headers.headers) - - cookies = Cookies(CookieJar()) - cookies.extract_cookies(response) - self.cookies.update(cookies) # type: ignore[union-attr] - - async def _get_session_data(self) -> dict[str, Any]: - return await self.session_backend.load_from_connection( - connection=fake_asgi_connection( - app=self.app, - cookies=dict(self.cookies), # type: ignore[arg-type] - ), - ) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/client/sync_client.py b/venv/lib/python3.11/site-packages/litestar/testing/client/sync_client.py deleted file mode 100644 index d907056..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/client/sync_client.py +++ /dev/null @@ -1,593 +0,0 @@ -from __future__ import annotations - -from contextlib import ExitStack -from typing import TYPE_CHECKING, Any, Generic, Mapping, Sequence, TypeVar -from urllib.parse import urljoin - -from httpx import USE_CLIENT_DEFAULT, Client, Response - -from litestar import HttpMethod -from litestar.testing.client.base import BaseTestClient -from litestar.testing.life_span_handler import LifeSpanHandler -from litestar.testing.transport import ConnectionUpgradeExceptionError, TestClientTransport -from litestar.types import AnyIOBackend, ASGIApp - -if TYPE_CHECKING: - from httpx._client import UseClientDefault - from httpx._types import ( - AuthTypes, - CookieTypes, - HeaderTypes, - QueryParamTypes, - RequestContent, - RequestData, - RequestFiles, - TimeoutTypes, - URLTypes, - ) - from typing_extensions import Self - - from litestar.middleware.session.base import BaseBackendConfig - from litestar.testing.websocket_test_session import WebSocketTestSession - - -T = TypeVar("T", bound=ASGIApp) - - -class TestClient(Client, BaseTestClient, Generic[T]): # type: ignore[misc] - lifespan_handler: LifeSpanHandler[Any] - exit_stack: ExitStack - - def __init__( - self, - app: T, - base_url: str = "http://testserver.local", - raise_server_exceptions: bool = True, - root_path: str = "", - backend: AnyIOBackend = "asyncio", - backend_options: Mapping[str, Any] | None = None, - session_config: BaseBackendConfig | None = None, - timeout: float | None = None, - cookies: CookieTypes | None = None, - ) -> None: - """A client implementation providing a context manager for testing applications. - - Args: - app: The instance of :class:`Litestar ` under test. - base_url: URL scheme and domain for test request paths, e.g. ``http://testserver``. - raise_server_exceptions: Flag for the underlying test client to raise server exceptions instead of - wrapping them in an HTTP response. - root_path: Path prefix for requests. - backend: The async backend to use, options are "asyncio" or "trio". - backend_options: ``anyio`` options. - session_config: Configuration for Session Middleware class to create raw session cookies for request to the - route handlers. - timeout: Request timeout - cookies: Cookies to set on the client. - """ - BaseTestClient.__init__( - self, - app=app, - base_url=base_url, - backend=backend, - backend_options=backend_options, - session_config=session_config, - cookies=cookies, - ) - - Client.__init__( - self, - base_url=base_url, - headers={"user-agent": "testclient"}, - follow_redirects=True, - cookies=cookies, - transport=TestClientTransport( # type: ignore[arg-type] - client=self, - raise_server_exceptions=raise_server_exceptions, - root_path=root_path, - ), - timeout=timeout, - ) - - def __enter__(self) -> Self: - with ExitStack() as stack: - self.blocking_portal = portal = stack.enter_context(self.portal()) - self.lifespan_handler = LifeSpanHandler(client=self) - - @stack.callback - def reset_portal() -> None: - delattr(self, "blocking_portal") - - @stack.callback - def wait_shutdown() -> None: - portal.call(self.lifespan_handler.wait_shutdown) - - self.exit_stack = stack.pop_all() - - return self - - def __exit__(self, *args: Any) -> None: - self.exit_stack.close() - - def request( - self, - method: str, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault | None = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a request. - - Args: - method: An HTTP method. - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.request( - self, - url=self.base_url.join(url), - method=method.value if isinstance(method, HttpMethod) else method, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def get( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a GET request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.get( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def options( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends an OPTIONS request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.options( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def head( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a HEAD request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.head( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def post( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a POST request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.post( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def put( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a PUT request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.put( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def patch( - self, - url: URLTypes, - *, - content: RequestContent | None = None, - data: RequestData | None = None, - files: RequestFiles | None = None, - json: Any | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a PATCH request. - - Args: - url: URL or path for the request. - content: Request content. - data: Form encoded data. - files: Multipart files to send. - json: JSON data to send. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.patch( - self, - url, - content=content, - data=data, - files=files, - json=json, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def delete( - self, - url: URLTypes, - *, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> Response: - """Sends a DELETE request. - - Args: - url: URL or path for the request. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - An HTTPX Response. - """ - return Client.delete( - self, - url, - params=params, - headers=headers, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - - def websocket_connect( - self, - url: str, - subprotocols: Sequence[str] | None = None, - params: QueryParamTypes | None = None, - headers: HeaderTypes | None = None, - cookies: CookieTypes | None = None, - auth: AuthTypes | UseClientDefault = USE_CLIENT_DEFAULT, - follow_redirects: bool | UseClientDefault = USE_CLIENT_DEFAULT, - timeout: TimeoutTypes | UseClientDefault = USE_CLIENT_DEFAULT, - extensions: Mapping[str, Any] | None = None, - ) -> WebSocketTestSession: - """Sends a GET request to establish a websocket connection. - - Args: - url: Request URL. - subprotocols: Websocket subprotocols. - params: Query parameters. - headers: Request headers. - cookies: Request cookies. - auth: Auth headers. - follow_redirects: Whether to follow redirects. - timeout: Request timeout. - extensions: Dictionary of ASGI extensions. - - Returns: - A `WebSocketTestSession ` instance. - """ - url = urljoin("ws://testserver", url) - default_headers: dict[str, str] = {} - default_headers.setdefault("connection", "upgrade") - default_headers.setdefault("sec-websocket-key", "testserver==") - default_headers.setdefault("sec-websocket-version", "13") - if subprotocols is not None: - default_headers.setdefault("sec-websocket-protocol", ", ".join(subprotocols)) - try: - Client.request( - self, - "GET", - url, - headers={**dict(headers or {}), **default_headers}, # type: ignore[misc] - params=params, - cookies=cookies, - auth=auth, - follow_redirects=follow_redirects, - timeout=timeout, - extensions=None if extensions is None else dict(extensions), - ) - except ConnectionUpgradeExceptionError as exc: - return exc.session - - raise RuntimeError("Expected WebSocket upgrade") # pragma: no cover - - def set_session_data(self, data: dict[str, Any]) -> None: - """Set session data. - - Args: - data: Session data - - Returns: - None - - Examples: - .. code-block:: python - - from litestar import Litestar, get - from litestar.middleware.session.memory_backend import MemoryBackendConfig - - session_config = MemoryBackendConfig() - - - @get(path="/test") - def get_session_data(request: Request) -> Dict[str, Any]: - return request.session - - - app = Litestar( - route_handlers=[get_session_data], middleware=[session_config.middleware] - ) - - with TestClient(app=app, session_config=session_config) as client: - client.set_session_data({"foo": "bar"}) - assert client.get("/test").json() == {"foo": "bar"} - - """ - with self.portal() as portal: - portal.call(self._set_session_data, data) - - def get_session_data(self) -> dict[str, Any]: - """Get session data. - - Returns: - A dictionary containing session data. - - Examples: - .. code-block:: python - - from litestar import Litestar, post - from litestar.middleware.session.memory_backend import MemoryBackendConfig - - session_config = MemoryBackendConfig() - - - @post(path="/test") - def set_session_data(request: Request) -> None: - request.session["foo"] == "bar" - - - app = Litestar( - route_handlers=[set_session_data], middleware=[session_config.middleware] - ) - - with TestClient(app=app, session_config=session_config) as client: - client.post("/test") - assert client.get_session_data() == {"foo": "bar"} - - """ - with self.portal() as portal: - return portal.call(self._get_session_data) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/helpers.py b/venv/lib/python3.11/site-packages/litestar/testing/helpers.py deleted file mode 100644 index 5ac59af..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/helpers.py +++ /dev/null @@ -1,561 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any, Callable, Literal, Mapping, Sequence - -from litestar.app import DEFAULT_OPENAPI_CONFIG, Litestar -from litestar.controller import Controller -from litestar.events import SimpleEventEmitter -from litestar.testing.client import AsyncTestClient, TestClient -from litestar.types import Empty -from litestar.utils.predicates import is_class_and_subclass - -if TYPE_CHECKING: - from contextlib import AbstractAsyncContextManager - - from litestar import Request, Response, WebSocket - from litestar.config.allowed_hosts import AllowedHostsConfig - from litestar.config.app import ExperimentalFeatures - from litestar.config.compression import CompressionConfig - from litestar.config.cors import CORSConfig - from litestar.config.csrf import CSRFConfig - from litestar.config.response_cache import ResponseCacheConfig - from litestar.datastructures import CacheControlHeader, ETag, State - from litestar.dto import AbstractDTO - from litestar.events import BaseEventEmitterBackend, EventListener - from litestar.logging.config import BaseLoggingConfig - from litestar.middleware.session.base import BaseBackendConfig - from litestar.openapi.config import OpenAPIConfig - from litestar.openapi.spec import SecurityRequirement - from litestar.plugins import PluginProtocol - from litestar.static_files.config import StaticFilesConfig - from litestar.stores.base import Store - from litestar.stores.registry import StoreRegistry - from litestar.template.config import TemplateConfig - from litestar.types import ( - AfterExceptionHookHandler, - AfterRequestHookHandler, - AfterResponseHookHandler, - BeforeMessageSendHookHandler, - BeforeRequestHookHandler, - ControllerRouterHandler, - Dependencies, - EmptyType, - ExceptionHandlersMap, - Guard, - LifespanHook, - Middleware, - OnAppInitHandler, - ParametersMap, - ResponseCookies, - ResponseHeaders, - TypeEncodersMap, - ) - - -def create_test_client( - route_handlers: ControllerRouterHandler | Sequence[ControllerRouterHandler] | None = None, - *, - after_exception: Sequence[AfterExceptionHookHandler] | None = None, - after_request: AfterRequestHookHandler | None = None, - after_response: AfterResponseHookHandler | None = None, - allowed_hosts: Sequence[str] | AllowedHostsConfig | None = None, - backend: Literal["asyncio", "trio"] = "asyncio", - backend_options: Mapping[str, Any] | None = None, - base_url: str = "http://testserver.local", - before_request: BeforeRequestHookHandler | None = None, - before_send: Sequence[BeforeMessageSendHookHandler] | None = None, - cache_control: CacheControlHeader | None = None, - compression_config: CompressionConfig | None = None, - cors_config: CORSConfig | None = None, - csrf_config: CSRFConfig | None = None, - debug: bool = True, - dependencies: Dependencies | None = None, - dto: type[AbstractDTO] | None | EmptyType = Empty, - etag: ETag | None = None, - event_emitter_backend: type[BaseEventEmitterBackend] = SimpleEventEmitter, - exception_handlers: ExceptionHandlersMap | None = None, - guards: Sequence[Guard] | None = None, - include_in_schema: bool | EmptyType = Empty, - listeners: Sequence[EventListener] | None = None, - logging_config: BaseLoggingConfig | EmptyType | None = Empty, - middleware: Sequence[Middleware] | None = None, - multipart_form_part_limit: int = 1000, - on_app_init: Sequence[OnAppInitHandler] | None = None, - on_shutdown: Sequence[LifespanHook] | None = None, - on_startup: Sequence[LifespanHook] | None = None, - openapi_config: OpenAPIConfig | None = DEFAULT_OPENAPI_CONFIG, - opt: Mapping[str, Any] | None = None, - parameters: ParametersMap | None = None, - plugins: Sequence[PluginProtocol] | None = None, - lifespan: list[Callable[[Litestar], AbstractAsyncContextManager] | AbstractAsyncContextManager] | None = None, - raise_server_exceptions: bool = True, - pdb_on_exception: bool | None = None, - request_class: type[Request] | None = None, - response_cache_config: ResponseCacheConfig | None = None, - response_class: type[Response] | None = None, - response_cookies: ResponseCookies | None = None, - response_headers: ResponseHeaders | None = None, - return_dto: type[AbstractDTO] | None | EmptyType = Empty, - root_path: str = "", - security: Sequence[SecurityRequirement] | None = None, - session_config: BaseBackendConfig | None = None, - signature_namespace: Mapping[str, Any] | None = None, - signature_types: Sequence[Any] | None = None, - state: State | None = None, - static_files_config: Sequence[StaticFilesConfig] | None = None, - stores: StoreRegistry | dict[str, Store] | None = None, - tags: Sequence[str] | None = None, - template_config: TemplateConfig | None = None, - timeout: float | None = None, - type_encoders: TypeEncodersMap | None = None, - websocket_class: type[WebSocket] | None = None, - experimental_features: list[ExperimentalFeatures] | None = None, -) -> TestClient[Litestar]: - """Create a Litestar app instance and initializes it. - - :class:`TestClient ` with it. - - Notes: - - This function should be called as a context manager to ensure async startup and shutdown are - handled correctly. - - Examples: - .. code-block:: python - - from litestar import get - from litestar.testing import create_test_client - - - @get("/some-path") - def my_handler() -> dict[str, str]: - return {"hello": "world"} - - - def test_my_handler() -> None: - with create_test_client(my_handler) as client: - response = client.get("/some-path") - assert response.json() == {"hello": "world"} - - Args: - route_handlers: A single handler or a sequence of route handlers, which can include instances of - :class:`Router `, subclasses of :class:`Controller <.controller.Controller>` or - any function decorated by the route handler decorators. - backend: The async backend to use, options are "asyncio" or "trio". - backend_options: ``anyio`` options. - base_url: URL scheme and domain for test request paths, e.g. ``http://testserver``. - raise_server_exceptions: Flag for underlying the test client to raise server exceptions instead of wrapping them - in an HTTP response. - root_path: Path prefix for requests. - session_config: Configuration for Session Middleware class to create raw session cookies for request to the - route handlers. - after_exception: A sequence of :class:`exception hook handlers <.types.AfterExceptionHookHandler>`. This - hook is called after an exception occurs. In difference to exception handlers, it is not meant to - return a response - only to process the exception (e.g. log it, send it to Sentry etc.). - after_request: A sync or async function executed after the route handler function returned and the response - object has been resolved. Receives the response object. - after_response: A sync or async function called after the response has been awaited. It receives the - :class:`Request <.connection.Request>` object and should not return any values. - allowed_hosts: A sequence of allowed hosts, or an - :class:`AllowedHostsConfig <.config.allowed_hosts.AllowedHostsConfig>` instance. Enables the builtin - allowed hosts middleware. - before_request: A sync or async function called immediately before calling the route handler. Receives the - :class:`Request <.connection.Request>` instance and any non-``None`` return value is used for the - response, bypassing the route handler. - before_send: A sequence of :class:`before send hook handlers <.types.BeforeMessageSendHookHandler>`. Called - when the ASGI send function is called. - cache_control: A ``cache-control`` header of type - :class:`CacheControlHeader ` to add to route handlers of - this app. Can be overridden by route handlers. - compression_config: Configures compression behaviour of the application, this enabled a builtin or user - defined Compression middleware. - cors_config: If set, configures :class:`CORSMiddleware <.middleware.cors.CORSMiddleware>`. - csrf_config: If set, configures :class:`CSRFMiddleware <.middleware.csrf.CSRFMiddleware>`. - debug: If ``True``, app errors rendered as HTML with a stack trace. - dependencies: A string keyed mapping of dependency :class:`Providers <.di.Provide>`. - dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for (de)serializing and - validation of request data. - etag: An ``etag`` header of type :class:`ETag <.datastructures.ETag>` to add to route handlers of this app. - Can be overridden by route handlers. - event_emitter_backend: A subclass of - :class:`BaseEventEmitterBackend <.events.emitter.BaseEventEmitterBackend>`. - exception_handlers: A mapping of status codes and/or exception types to handler functions. - guards: A sequence of :class:`Guard <.types.Guard>` callables. - include_in_schema: A boolean flag dictating whether the route handler should be documented in the OpenAPI schema. - lifespan: A list of callables returning async context managers, wrapping the lifespan of the ASGI application - listeners: A sequence of :class:`EventListener <.events.listener.EventListener>`. - logging_config: A subclass of :class:`BaseLoggingConfig <.logging.config.BaseLoggingConfig>`. - middleware: A sequence of :class:`Middleware <.types.Middleware>`. - multipart_form_part_limit: The maximal number of allowed parts in a multipart/formdata request. This limit - is intended to protect from DoS attacks. - on_app_init: A sequence of :class:`OnAppInitHandler <.types.OnAppInitHandler>` instances. Handlers receive - an instance of :class:`AppConfig <.config.app.AppConfig>` that will have been initially populated with - the parameters passed to :class:`Litestar `, and must return an instance of same. - If more than one handler is registered they are called in the order they are provided. - on_shutdown: A sequence of :class:`LifespanHook <.types.LifespanHook>` called during application - shutdown. - on_startup: A sequence of :class:`LifespanHook ` called during - application startup. - openapi_config: Defaults to :attr:`DEFAULT_OPENAPI_CONFIG` - opt: A string keyed mapping of arbitrary values that can be accessed in :class:`Guards <.types.Guard>` or - wherever you have access to :class:`Request ` or - :class:`ASGI Scope <.types.Scope>`. - parameters: A mapping of :class:`Parameter <.params.Parameter>` definitions available to all application - paths. - pdb_on_exception: Drop into the PDB when an exception occurs. - plugins: Sequence of plugins. - request_class: An optional subclass of :class:`Request <.connection.Request>` to use for http connections. - response_class: A custom subclass of :class:`Response <.response.Response>` to be used as the app's default - response. - response_cookies: A sequence of :class:`Cookie <.datastructures.Cookie>`. - response_headers: A string keyed mapping of :class:`ResponseHeader <.datastructures.ResponseHeader>` - response_cache_config: Configures caching behavior of the application. - return_dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for serializing - outbound response data. - route_handlers: A sequence of route handlers, which can include instances of - :class:`Router <.router.Router>`, subclasses of :class:`Controller <.controller.Controller>` or any - callable decorated by the route handler decorators. - security: A sequence of dicts that will be added to the schema of all route handlers in the application. - See - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details. - signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling. - signature_types: A sequence of types for use in forward reference resolution during signature modeling. - These types will be added to the signature namespace using their ``__name__`` attribute. - state: An optional :class:`State <.datastructures.State>` for application state. - static_files_config: A sequence of :class:`StaticFilesConfig <.static_files.StaticFilesConfig>` - stores: Central registry of :class:`Store <.stores.base.Store>` that will be available throughout the - application. If this is a dictionary to it will be passed to a - :class:`StoreRegistry <.stores.registry.StoreRegistry>`. If it is a - :class:`StoreRegistry <.stores.registry.StoreRegistry>`, this instance will be used directly. - tags: A sequence of string tags that will be appended to the schema of all route handlers under the - application. - template_config: An instance of :class:`TemplateConfig <.template.TemplateConfig>` - timeout: Request timeout - type_encoders: A mapping of types to callables that transform them into types supported for serialization. - websocket_class: An optional subclass of :class:`WebSocket <.connection.WebSocket>` to use for websocket - connections. - experimental_features: An iterable of experimental features to enable - - - Returns: - An instance of :class:`TestClient <.testing.TestClient>` with a created app instance. - """ - route_handlers = () if route_handlers is None else route_handlers - if is_class_and_subclass(route_handlers, Controller) or not isinstance(route_handlers, Sequence): - route_handlers = (route_handlers,) - - app = Litestar( - after_exception=after_exception, - after_request=after_request, - after_response=after_response, - allowed_hosts=allowed_hosts, - before_request=before_request, - before_send=before_send, - cache_control=cache_control, - compression_config=compression_config, - cors_config=cors_config, - csrf_config=csrf_config, - debug=debug, - dependencies=dependencies, - dto=dto, - etag=etag, - lifespan=lifespan, - event_emitter_backend=event_emitter_backend, - exception_handlers=exception_handlers, - guards=guards, - include_in_schema=include_in_schema, - listeners=listeners, - logging_config=logging_config, - middleware=middleware, - multipart_form_part_limit=multipart_form_part_limit, - on_app_init=on_app_init, - on_shutdown=on_shutdown, - on_startup=on_startup, - openapi_config=openapi_config, - opt=opt, - parameters=parameters, - pdb_on_exception=pdb_on_exception, - plugins=plugins, - request_class=request_class, - response_cache_config=response_cache_config, - response_class=response_class, - response_cookies=response_cookies, - response_headers=response_headers, - return_dto=return_dto, - route_handlers=route_handlers, - security=security, - signature_namespace=signature_namespace, - signature_types=signature_types, - state=state, - static_files_config=static_files_config, - stores=stores, - tags=tags, - template_config=template_config, - type_encoders=type_encoders, - websocket_class=websocket_class, - experimental_features=experimental_features, - ) - - return TestClient[Litestar]( - app=app, - backend=backend, - backend_options=backend_options, - base_url=base_url, - raise_server_exceptions=raise_server_exceptions, - root_path=root_path, - session_config=session_config, - timeout=timeout, - ) - - -def create_async_test_client( - route_handlers: ControllerRouterHandler | Sequence[ControllerRouterHandler] | None = None, - *, - after_exception: Sequence[AfterExceptionHookHandler] | None = None, - after_request: AfterRequestHookHandler | None = None, - after_response: AfterResponseHookHandler | None = None, - allowed_hosts: Sequence[str] | AllowedHostsConfig | None = None, - backend: Literal["asyncio", "trio"] = "asyncio", - backend_options: Mapping[str, Any] | None = None, - base_url: str = "http://testserver.local", - before_request: BeforeRequestHookHandler | None = None, - before_send: Sequence[BeforeMessageSendHookHandler] | None = None, - cache_control: CacheControlHeader | None = None, - compression_config: CompressionConfig | None = None, - cors_config: CORSConfig | None = None, - csrf_config: CSRFConfig | None = None, - debug: bool = True, - dependencies: Dependencies | None = None, - dto: type[AbstractDTO] | None | EmptyType = Empty, - etag: ETag | None = None, - event_emitter_backend: type[BaseEventEmitterBackend] = SimpleEventEmitter, - exception_handlers: ExceptionHandlersMap | None = None, - guards: Sequence[Guard] | None = None, - include_in_schema: bool | EmptyType = Empty, - lifespan: list[Callable[[Litestar], AbstractAsyncContextManager] | AbstractAsyncContextManager] | None = None, - listeners: Sequence[EventListener] | None = None, - logging_config: BaseLoggingConfig | EmptyType | None = Empty, - middleware: Sequence[Middleware] | None = None, - multipart_form_part_limit: int = 1000, - on_app_init: Sequence[OnAppInitHandler] | None = None, - on_shutdown: Sequence[LifespanHook] | None = None, - on_startup: Sequence[LifespanHook] | None = None, - openapi_config: OpenAPIConfig | None = DEFAULT_OPENAPI_CONFIG, - opt: Mapping[str, Any] | None = None, - parameters: ParametersMap | None = None, - pdb_on_exception: bool | None = None, - plugins: Sequence[PluginProtocol] | None = None, - raise_server_exceptions: bool = True, - request_class: type[Request] | None = None, - response_cache_config: ResponseCacheConfig | None = None, - response_class: type[Response] | None = None, - response_cookies: ResponseCookies | None = None, - response_headers: ResponseHeaders | None = None, - return_dto: type[AbstractDTO] | None | EmptyType = Empty, - root_path: str = "", - security: Sequence[SecurityRequirement] | None = None, - session_config: BaseBackendConfig | None = None, - signature_namespace: Mapping[str, Any] | None = None, - signature_types: Sequence[Any] | None = None, - state: State | None = None, - static_files_config: Sequence[StaticFilesConfig] | None = None, - stores: StoreRegistry | dict[str, Store] | None = None, - tags: Sequence[str] | None = None, - template_config: TemplateConfig | None = None, - timeout: float | None = None, - type_encoders: TypeEncodersMap | None = None, - websocket_class: type[WebSocket] | None = None, - experimental_features: list[ExperimentalFeatures] | None = None, -) -> AsyncTestClient[Litestar]: - """Create a Litestar app instance and initializes it. - - :class:`AsyncTestClient ` with it. - - Notes: - - This function should be called as a context manager to ensure async startup and shutdown are - handled correctly. - - Examples: - .. code-block:: python - - from litestar import get - from litestar.testing import create_async_test_client - - - @get("/some-path") - def my_handler() -> dict[str, str]: - return {"hello": "world"} - - - async def test_my_handler() -> None: - async with create_async_test_client(my_handler) as client: - response = await client.get("/some-path") - assert response.json() == {"hello": "world"} - - Args: - route_handlers: A single handler or a sequence of route handlers, which can include instances of - :class:`Router `, subclasses of :class:`Controller <.controller.Controller>` or - any function decorated by the route handler decorators. - backend: The async backend to use, options are "asyncio" or "trio". - backend_options: ``anyio`` options. - base_url: URL scheme and domain for test request paths, e.g. ``http://testserver``. - raise_server_exceptions: Flag for underlying the test client to raise server exceptions instead of wrapping them - in an HTTP response. - root_path: Path prefix for requests. - session_config: Configuration for Session Middleware class to create raw session cookies for request to the - route handlers. - after_exception: A sequence of :class:`exception hook handlers <.types.AfterExceptionHookHandler>`. This - hook is called after an exception occurs. In difference to exception handlers, it is not meant to - return a response - only to process the exception (e.g. log it, send it to Sentry etc.). - after_request: A sync or async function executed after the route handler function returned and the response - object has been resolved. Receives the response object. - after_response: A sync or async function called after the response has been awaited. It receives the - :class:`Request <.connection.Request>` object and should not return any values. - allowed_hosts: A sequence of allowed hosts, or an - :class:`AllowedHostsConfig <.config.allowed_hosts.AllowedHostsConfig>` instance. Enables the builtin - allowed hosts middleware. - before_request: A sync or async function called immediately before calling the route handler. Receives the - :class:`Request <.connection.Request>` instance and any non-``None`` return value is used for the - response, bypassing the route handler. - before_send: A sequence of :class:`before send hook handlers <.types.BeforeMessageSendHookHandler>`. Called - when the ASGI send function is called. - cache_control: A ``cache-control`` header of type - :class:`CacheControlHeader ` to add to route handlers of - this app. Can be overridden by route handlers. - compression_config: Configures compression behaviour of the application, this enabled a builtin or user - defined Compression middleware. - cors_config: If set, configures :class:`CORSMiddleware <.middleware.cors.CORSMiddleware>`. - csrf_config: If set, configures :class:`CSRFMiddleware <.middleware.csrf.CSRFMiddleware>`. - debug: If ``True``, app errors rendered as HTML with a stack trace. - dependencies: A string keyed mapping of dependency :class:`Providers <.di.Provide>`. - dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for (de)serializing and - validation of request data. - etag: An ``etag`` header of type :class:`ETag <.datastructures.ETag>` to add to route handlers of this app. - Can be overridden by route handlers. - event_emitter_backend: A subclass of - :class:`BaseEventEmitterBackend <.events.emitter.BaseEventEmitterBackend>`. - exception_handlers: A mapping of status codes and/or exception types to handler functions. - guards: A sequence of :class:`Guard <.types.Guard>` callables. - include_in_schema: A boolean flag dictating whether the route handler should be documented in the OpenAPI schema. - lifespan: A list of callables returning async context managers, wrapping the lifespan of the ASGI application - listeners: A sequence of :class:`EventListener <.events.listener.EventListener>`. - logging_config: A subclass of :class:`BaseLoggingConfig <.logging.config.BaseLoggingConfig>`. - middleware: A sequence of :class:`Middleware <.types.Middleware>`. - multipart_form_part_limit: The maximal number of allowed parts in a multipart/formdata request. This limit - is intended to protect from DoS attacks. - on_app_init: A sequence of :class:`OnAppInitHandler <.types.OnAppInitHandler>` instances. Handlers receive - an instance of :class:`AppConfig <.config.app.AppConfig>` that will have been initially populated with - the parameters passed to :class:`Litestar `, and must return an instance of same. - If more than one handler is registered they are called in the order they are provided. - on_shutdown: A sequence of :class:`LifespanHook <.types.LifespanHook>` called during application - shutdown. - on_startup: A sequence of :class:`LifespanHook ` called during - application startup. - openapi_config: Defaults to :attr:`DEFAULT_OPENAPI_CONFIG` - opt: A string keyed mapping of arbitrary values that can be accessed in :class:`Guards <.types.Guard>` or - wherever you have access to :class:`Request ` or - :class:`ASGI Scope <.types.Scope>`. - parameters: A mapping of :class:`Parameter <.params.Parameter>` definitions available to all application - paths. - pdb_on_exception: Drop into the PDB when an exception occurs. - plugins: Sequence of plugins. - request_class: An optional subclass of :class:`Request <.connection.Request>` to use for http connections. - response_class: A custom subclass of :class:`Response <.response.Response>` to be used as the app's default - response. - response_cookies: A sequence of :class:`Cookie <.datastructures.Cookie>`. - response_headers: A string keyed mapping of :class:`ResponseHeader <.datastructures.ResponseHeader>` - response_cache_config: Configures caching behavior of the application. - return_dto: :class:`AbstractDTO <.dto.base_dto.AbstractDTO>` to use for serializing - outbound response data. - route_handlers: A sequence of route handlers, which can include instances of - :class:`Router <.router.Router>`, subclasses of :class:`Controller <.controller.Controller>` or any - callable decorated by the route handler decorators. - security: A sequence of dicts that will be added to the schema of all route handlers in the application. - See - :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details. - signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling. - signature_types: A sequence of types for use in forward reference resolution during signature modeling. - These types will be added to the signature namespace using their ``__name__`` attribute. - state: An optional :class:`State <.datastructures.State>` for application state. - static_files_config: A sequence of :class:`StaticFilesConfig <.static_files.StaticFilesConfig>` - stores: Central registry of :class:`Store <.stores.base.Store>` that will be available throughout the - application. If this is a dictionary to it will be passed to a - :class:`StoreRegistry <.stores.registry.StoreRegistry>`. If it is a - :class:`StoreRegistry <.stores.registry.StoreRegistry>`, this instance will be used directly. - tags: A sequence of string tags that will be appended to the schema of all route handlers under the - application. - template_config: An instance of :class:`TemplateConfig <.template.TemplateConfig>` - timeout: Request timeout - type_encoders: A mapping of types to callables that transform them into types supported for serialization. - websocket_class: An optional subclass of :class:`WebSocket <.connection.WebSocket>` to use for websocket - connections. - experimental_features: An iterable of experimental features to enable - - Returns: - An instance of :class:`AsyncTestClient ` with a created app instance. - """ - route_handlers = () if route_handlers is None else route_handlers - if is_class_and_subclass(route_handlers, Controller) or not isinstance(route_handlers, Sequence): - route_handlers = (route_handlers,) - - app = Litestar( - after_exception=after_exception, - after_request=after_request, - after_response=after_response, - allowed_hosts=allowed_hosts, - before_request=before_request, - before_send=before_send, - cache_control=cache_control, - compression_config=compression_config, - cors_config=cors_config, - csrf_config=csrf_config, - debug=debug, - dependencies=dependencies, - dto=dto, - etag=etag, - event_emitter_backend=event_emitter_backend, - exception_handlers=exception_handlers, - guards=guards, - include_in_schema=include_in_schema, - lifespan=lifespan, - listeners=listeners, - logging_config=logging_config, - middleware=middleware, - multipart_form_part_limit=multipart_form_part_limit, - on_app_init=on_app_init, - on_shutdown=on_shutdown, - on_startup=on_startup, - openapi_config=openapi_config, - opt=opt, - parameters=parameters, - pdb_on_exception=pdb_on_exception, - plugins=plugins, - request_class=request_class, - response_cache_config=response_cache_config, - response_class=response_class, - response_cookies=response_cookies, - response_headers=response_headers, - return_dto=return_dto, - route_handlers=route_handlers, - security=security, - signature_namespace=signature_namespace, - signature_types=signature_types, - state=state, - static_files_config=static_files_config, - stores=stores, - tags=tags, - template_config=template_config, - type_encoders=type_encoders, - websocket_class=websocket_class, - experimental_features=experimental_features, - ) - - return AsyncTestClient[Litestar]( - app=app, - backend=backend, - backend_options=backend_options, - base_url=base_url, - raise_server_exceptions=raise_server_exceptions, - root_path=root_path, - session_config=session_config, - timeout=timeout, - ) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/life_span_handler.py b/venv/lib/python3.11/site-packages/litestar/testing/life_span_handler.py deleted file mode 100644 index 8ee7d22..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/life_span_handler.py +++ /dev/null @@ -1,78 +0,0 @@ -from __future__ import annotations - -from math import inf -from typing import TYPE_CHECKING, Generic, Optional, TypeVar, cast - -from anyio import create_memory_object_stream -from anyio.streams.stapled import StapledObjectStream - -from litestar.testing.client.base import BaseTestClient - -if TYPE_CHECKING: - from litestar.types import ( - LifeSpanReceiveMessage, # noqa: F401 - LifeSpanSendMessage, - LifeSpanShutdownEvent, - LifeSpanStartupEvent, - ) - -T = TypeVar("T", bound=BaseTestClient) - - -class LifeSpanHandler(Generic[T]): - __slots__ = "stream_send", "stream_receive", "client", "task" - - def __init__(self, client: T) -> None: - self.client = client - self.stream_send = StapledObjectStream[Optional["LifeSpanSendMessage"]](*create_memory_object_stream(inf)) # type: ignore[arg-type] - self.stream_receive = StapledObjectStream["LifeSpanReceiveMessage"](*create_memory_object_stream(inf)) # type: ignore[arg-type] - - with self.client.portal() as portal: - self.task = portal.start_task_soon(self.lifespan) - portal.call(self.wait_startup) - - async def receive(self) -> LifeSpanSendMessage: - message = await self.stream_send.receive() - if message is None: - self.task.result() - return cast("LifeSpanSendMessage", message) - - async def wait_startup(self) -> None: - event: LifeSpanStartupEvent = {"type": "lifespan.startup"} - await self.stream_receive.send(event) - - message = await self.receive() - if message["type"] not in ( - "lifespan.startup.complete", - "lifespan.startup.failed", - ): - raise RuntimeError( - "Received unexpected ASGI message type. Expected 'lifespan.startup.complete' or " - f"'lifespan.startup.failed'. Got {message['type']!r}", - ) - if message["type"] == "lifespan.startup.failed": - await self.receive() - - async def wait_shutdown(self) -> None: - async with self.stream_send: - lifespan_shutdown_event: LifeSpanShutdownEvent = {"type": "lifespan.shutdown"} - await self.stream_receive.send(lifespan_shutdown_event) - - message = await self.receive() - if message["type"] not in ( - "lifespan.shutdown.complete", - "lifespan.shutdown.failed", - ): - raise RuntimeError( - "Received unexpected ASGI message type. Expected 'lifespan.shutdown.complete' or " - f"'lifespan.shutdown.failed'. Got {message['type']!r}", - ) - if message["type"] == "lifespan.shutdown.failed": - await self.receive() - - async def lifespan(self) -> None: - scope = {"type": "lifespan"} - try: - await self.client.app(scope, self.stream_receive.receive, self.stream_send.send) - finally: - await self.stream_send.send(None) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/request_factory.py b/venv/lib/python3.11/site-packages/litestar/testing/request_factory.py deleted file mode 100644 index ccb29c6..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/request_factory.py +++ /dev/null @@ -1,565 +0,0 @@ -from __future__ import annotations - -import json -from functools import partial -from typing import TYPE_CHECKING, Any, cast -from urllib.parse import urlencode - -from httpx._content import encode_json as httpx_encode_json -from httpx._content import encode_multipart_data, encode_urlencoded_data - -from litestar import delete, patch, post, put -from litestar.app import Litestar -from litestar.connection import Request -from litestar.enums import HttpMethod, ParamType, RequestEncodingType, ScopeType -from litestar.handlers.http_handlers import get -from litestar.serialization import decode_json, default_serializer, encode_json -from litestar.types import DataContainerType, HTTPScope, RouteHandlerType -from litestar.types.asgi_types import ASGIVersion -from litestar.utils import get_serializer_from_scope -from litestar.utils.scope.state import ScopeState - -if TYPE_CHECKING: - from httpx._types import FileTypes - - from litestar.datastructures.cookie import Cookie - from litestar.handlers.http_handlers import HTTPRouteHandler - -_decorator_http_method_map: dict[HttpMethod, type[HTTPRouteHandler]] = { - HttpMethod.GET: get, - HttpMethod.POST: post, - HttpMethod.DELETE: delete, - HttpMethod.PATCH: patch, - HttpMethod.PUT: put, -} - - -def _create_default_route_handler( - http_method: HttpMethod, handler_kwargs: dict[str, Any] | None, app: Litestar -) -> HTTPRouteHandler: - handler_decorator = _decorator_http_method_map[http_method] - - def _default_route_handler() -> None: ... - - handler = handler_decorator("/", sync_to_thread=False, **(handler_kwargs or {}))(_default_route_handler) - handler.owner = app - return handler - - -def _create_default_app() -> Litestar: - return Litestar(route_handlers=[]) - - -class RequestFactory: - """Factory to create :class:`Request ` instances.""" - - __slots__ = ( - "app", - "server", - "port", - "root_path", - "scheme", - "handler_kwargs", - "serializer", - ) - - def __init__( - self, - app: Litestar | None = None, - server: str = "test.org", - port: int = 3000, - root_path: str = "", - scheme: str = "http", - handler_kwargs: dict[str, Any] | None = None, - ) -> None: - """Initialize ``RequestFactory`` - - Args: - app: An instance of :class:`Litestar ` to set as ``request.scope["app"]``. - server: The server's domain. - port: The server's port. - root_path: Root path for the server. - scheme: Scheme for the server. - handler_kwargs: Kwargs to pass to the route handler created for the request - - Examples: - .. code-block:: python - - from litestar import Litestar - from litestar.enums import RequestEncodingType - from litestar.testing import RequestFactory - - from tests import PersonFactory - - my_app = Litestar(route_handlers=[]) - my_server = "litestar.org" - - # Create a GET request - query_params = {"id": 1} - get_user_request = RequestFactory(app=my_app, server=my_server).get( - "/person", query_params=query_params - ) - - # Create a POST request - new_person = PersonFactory.build() - create_user_request = RequestFactory(app=my_app, server=my_server).post( - "/person", data=person - ) - - # Create a request with a special header - headers = {"header1": "value1"} - request_with_header = RequestFactory(app=my_app, server=my_server).get( - "/person", query_params=query_params, headers=headers - ) - - # Create a request with a media type - request_with_media_type = RequestFactory(app=my_app, server=my_server).post( - "/person", data=person, request_media_type=RequestEncodingType.MULTI_PART - ) - - """ - - self.app = app if app is not None else _create_default_app() - self.server = server - self.port = port - self.root_path = root_path - self.scheme = scheme - self.handler_kwargs = handler_kwargs - self.serializer = partial(default_serializer, type_encoders=self.app.type_encoders) - - def _create_scope( - self, - path: str, - http_method: HttpMethod, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> HTTPScope: - """Create the scope for the :class:`Request `. - - Args: - path: The request's path. - http_method: The request's HTTP method. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A dictionary that can be passed as a scope to the :class:`Request ` ctor. - """ - if session is None: - session = {} - - if state is None: - state = {} - - if path_params is None: - path_params = {} - - return HTTPScope( - type=ScopeType.HTTP, - method=http_method.value, - scheme=self.scheme, - server=(self.server, self.port), - root_path=self.root_path.rstrip("/"), - path=path, - headers=[], - app=self.app, - session=session, - user=user, - auth=auth, - query_string=urlencode(query_params, doseq=True).encode() if query_params else b"", - path_params=path_params, - client=(self.server, self.port), - state=state, - asgi=ASGIVersion(spec_version="3.0", version="3.0"), - http_version=http_version or "1.1", - raw_path=path.encode("ascii"), - route_handler=route_handler - or _create_default_route_handler(http_method, self.handler_kwargs, app=self.app), - extensions={}, - ) - - @classmethod - def _create_cookie_header(cls, headers: dict[str, str], cookies: list[Cookie] | str | None = None) -> None: - """Create the cookie header and add it to the ``headers`` dictionary. - - Args: - headers: A dictionary of headers, the cookie header will be added to it. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - """ - if not cookies: - return - - if isinstance(cookies, list): - cookie_header = "; ".join(cookie.to_header(header="") for cookie in cookies) - headers[ParamType.COOKIE] = cookie_header - elif isinstance(cookies, str): - headers[ParamType.COOKIE] = cookies - - def _build_headers( - self, - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - ) -> list[tuple[bytes, bytes]]: - """Build a list of encoded headers that can be passed to the request scope. - - Args: - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - - Returns: - A list of encoded headers that can be passed to the request scope. - """ - headers = headers or {} - self._create_cookie_header(headers, cookies) - return [ - ((key.lower()).encode("latin-1", errors="ignore"), value.encode("latin-1", errors="ignore")) - for key, value in headers.items() - ] - - def _create_request_with_data( - self, - http_method: HttpMethod, - path: str, - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - request_media_type: RequestEncodingType = RequestEncodingType.JSON, - data: dict[str, Any] | DataContainerType | None = None, # pyright: ignore - files: dict[str, FileTypes] | list[tuple[str, FileTypes]] | None = None, - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a :class:`Request ` instance that has body (data) - - Args: - http_method: The request's HTTP method. - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]` - auth: A value for `request.scope["auth"]` - request_media_type: The 'Content-Type' header of the request. - data: A value for the request's body. Can be any supported serializable type. - files: A dictionary of files to be sent with the request. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - scope = self._create_scope( - path=path, - http_method=http_method, - session=session, - user=user, - auth=auth, - query_params=query_params, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - - headers = headers or {} - body = b"" - if data: - data = json.loads(encode_json(data, serializer=get_serializer_from_scope(scope))) - - if request_media_type == RequestEncodingType.JSON: - encoding_headers, stream = httpx_encode_json(data) - elif request_media_type == RequestEncodingType.MULTI_PART: - encoding_headers, stream = encode_multipart_data( # type: ignore[assignment] - cast("dict[str, Any]", data), files=files or [], boundary=None - ) - else: - encoding_headers, stream = encode_urlencoded_data(decode_json(value=encode_json(data))) - headers.update(encoding_headers) - for chunk in stream: - body += chunk - ScopeState.from_scope(scope).body = body - self._create_cookie_header(headers, cookies) - scope["headers"] = self._build_headers(headers) - return Request(scope=scope) - - def get( - self, - path: str = "/", - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a GET :class:`Request ` instance. - - Args: - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - scope = self._create_scope( - path=path, - http_method=HttpMethod.GET, - session=session, - user=user, - auth=auth, - query_params=query_params, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - - scope["headers"] = self._build_headers(headers, cookies) - return Request(scope=scope) - - def post( - self, - path: str = "/", - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - request_media_type: RequestEncodingType = RequestEncodingType.JSON, - data: dict[str, Any] | DataContainerType | None = None, # pyright: ignore - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a POST :class:`Request ` instance. - - Args: - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - request_media_type: The 'Content-Type' header of the request. - data: A value for the request's body. Can be any supported serializable type. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - return self._create_request_with_data( - auth=auth, - cookies=cookies, - data=data, - headers=headers, - http_method=HttpMethod.POST, - path=path, - query_params=query_params, - request_media_type=request_media_type, - session=session, - user=user, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - - def put( - self, - path: str = "/", - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - request_media_type: RequestEncodingType = RequestEncodingType.JSON, - data: dict[str, Any] | DataContainerType | None = None, # pyright: ignore - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a PUT :class:`Request ` instance. - - Args: - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - request_media_type: The 'Content-Type' header of the request. - data: A value for the request's body. Can be any supported serializable type. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - return self._create_request_with_data( - auth=auth, - cookies=cookies, - data=data, - headers=headers, - http_method=HttpMethod.PUT, - path=path, - query_params=query_params, - request_media_type=request_media_type, - session=session, - user=user, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - - def patch( - self, - path: str = "/", - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - request_media_type: RequestEncodingType = RequestEncodingType.JSON, - data: dict[str, Any] | DataContainerType | None = None, # pyright: ignore - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a PATCH :class:`Request ` instance. - - Args: - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - request_media_type: The 'Content-Type' header of the request. - data: A value for the request's body. Can be any supported serializable type. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - return self._create_request_with_data( - auth=auth, - cookies=cookies, - data=data, - headers=headers, - http_method=HttpMethod.PATCH, - path=path, - query_params=query_params, - request_media_type=request_media_type, - session=session, - user=user, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - - def delete( - self, - path: str = "/", - headers: dict[str, str] | None = None, - cookies: list[Cookie] | str | None = None, - session: dict[str, Any] | None = None, - user: Any = None, - auth: Any = None, - query_params: dict[str, str | list[str]] | None = None, - state: dict[str, Any] | None = None, - path_params: dict[str, str] | None = None, - http_version: str | None = "1.1", - route_handler: RouteHandlerType | None = None, - ) -> Request[Any, Any, Any]: - """Create a POST :class:`Request ` instance. - - Args: - path: The request's path. - headers: A dictionary of headers. - cookies: A string representing the cookie header or a list of "Cookie" instances. - This value can include multiple cookies. - session: A dictionary of session data. - user: A value for `request.scope["user"]`. - auth: A value for `request.scope["auth"]`. - query_params: A dictionary of values from which the request's query will be generated. - state: Arbitrary request state. - path_params: A string keyed dictionary of path parameter values. - http_version: HTTP version. Defaults to "1.1". - route_handler: A route handler instance or method. If not provided a default handler is set. - - Returns: - A :class:`Request ` instance - """ - scope = self._create_scope( - path=path, - http_method=HttpMethod.DELETE, - session=session, - user=user, - auth=auth, - query_params=query_params, - state=state, - path_params=path_params, - http_version=http_version, - route_handler=route_handler, - ) - scope["headers"] = self._build_headers(headers, cookies) - return Request(scope=scope) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/transport.py b/venv/lib/python3.11/site-packages/litestar/testing/transport.py deleted file mode 100644 index ffa76a4..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/transport.py +++ /dev/null @@ -1,192 +0,0 @@ -from __future__ import annotations - -from io import BytesIO -from types import GeneratorType -from typing import TYPE_CHECKING, Any, Generic, TypedDict, TypeVar, Union, cast -from urllib.parse import unquote - -from anyio import Event -from httpx import ByteStream, Response - -from litestar.status_codes import HTTP_500_INTERNAL_SERVER_ERROR -from litestar.testing.websocket_test_session import WebSocketTestSession - -if TYPE_CHECKING: - from httpx import Request - - from litestar.testing.client import AsyncTestClient, TestClient - from litestar.types import ( - HTTPDisconnectEvent, - HTTPRequestEvent, - Message, - Receive, - ReceiveMessage, - Send, - WebSocketScope, - ) - - -T = TypeVar("T", bound=Union["AsyncTestClient", "TestClient"]) - - -class ConnectionUpgradeExceptionError(Exception): - def __init__(self, session: WebSocketTestSession) -> None: - self.session = session - - -class SendReceiveContext(TypedDict): - request_complete: bool - response_complete: Event - raw_kwargs: dict[str, Any] - response_started: bool - template: str | None - context: Any | None - - -class TestClientTransport(Generic[T]): - def __init__( - self, - client: T, - raise_server_exceptions: bool = True, - root_path: str = "", - ) -> None: - self.client = client - self.raise_server_exceptions = raise_server_exceptions - self.root_path = root_path - - @staticmethod - def create_receive(request: Request, context: SendReceiveContext) -> Receive: - async def receive() -> ReceiveMessage: - if context["request_complete"]: - if not context["response_complete"].is_set(): - await context["response_complete"].wait() - disconnect_event: HTTPDisconnectEvent = {"type": "http.disconnect"} - return disconnect_event - - body = cast("Union[bytes, str, GeneratorType]", (request.read() or b"")) - request_event: HTTPRequestEvent = {"type": "http.request", "body": b"", "more_body": False} - if isinstance(body, GeneratorType): # pragma: no cover - try: - chunk = body.send(None) - request_event["body"] = chunk if isinstance(chunk, bytes) else chunk.encode("utf-8") - request_event["more_body"] = True - except StopIteration: - context["request_complete"] = True - else: - context["request_complete"] = True - request_event["body"] = body if isinstance(body, bytes) else body.encode("utf-8") - return request_event - - return receive - - @staticmethod - def create_send(request: Request, context: SendReceiveContext) -> Send: - async def send(message: Message) -> None: - if message["type"] == "http.response.start": - assert not context["response_started"], 'Received multiple "http.response.start" messages.' # noqa: S101 - context["raw_kwargs"]["status_code"] = message["status"] - context["raw_kwargs"]["headers"] = [ - (k.decode("utf-8"), v.decode("utf-8")) for k, v in message.get("headers", []) - ] - context["response_started"] = True - elif message["type"] == "http.response.body": - assert context["response_started"], 'Received "http.response.body" without "http.response.start".' # noqa: S101 - assert not context[ # noqa: S101 - "response_complete" - ].is_set(), 'Received "http.response.body" after response completed.' - body = message.get("body", b"") - more_body = message.get("more_body", False) - if request.method != "HEAD": - context["raw_kwargs"]["stream"].write(body) - if not more_body: - context["raw_kwargs"]["stream"].seek(0) - context["response_complete"].set() - elif message["type"] == "http.response.template": # type: ignore[comparison-overlap] # pragma: no cover - context["template"] = message["template"] # type: ignore[unreachable] - context["context"] = message["context"] - - return send - - def parse_request(self, request: Request) -> dict[str, Any]: - scheme = request.url.scheme - netloc = unquote(request.url.netloc.decode(encoding="ascii")) - path = request.url.path - raw_path = request.url.raw_path - query = request.url.query.decode(encoding="ascii") - default_port = 433 if scheme in {"https", "wss"} else 80 - - if ":" in netloc: - host, port_string = netloc.split(":", 1) - port = int(port_string) - else: - host = netloc - port = default_port - - host_header = request.headers.pop("host", host if port == default_port else f"{host}:{port}") - - headers = [(k.lower().encode(), v.encode()) for k, v in (("host", host_header), *request.headers.items())] - - return { - "type": "websocket" if scheme in {"ws", "wss"} else "http", - "path": unquote(path), - "raw_path": raw_path, - "root_path": self.root_path, - "scheme": scheme, - "query_string": query.encode(), - "headers": headers, - "client": ("testclient", 50000), - "server": (host, port), - } - - def handle_request(self, request: Request) -> Response: - scope = self.parse_request(request=request) - if scope["type"] == "websocket": - scope.update( - subprotocols=[value.strip() for value in request.headers.get("sec-websocket-protocol", "").split(",")] - ) - session = WebSocketTestSession(client=self.client, scope=cast("WebSocketScope", scope)) # type: ignore[arg-type] - raise ConnectionUpgradeExceptionError(session) - - scope.update(method=request.method, http_version="1.1", extensions={"http.response.template": {}}) - - raw_kwargs: dict[str, Any] = {"stream": BytesIO()} - - try: - with self.client.portal() as portal: - response_complete = portal.call(Event) - context: SendReceiveContext = { - "response_complete": response_complete, - "request_complete": False, - "raw_kwargs": raw_kwargs, - "response_started": False, - "template": None, - "context": None, - } - portal.call( - self.client.app, - scope, - self.create_receive(request=request, context=context), - self.create_send(request=request, context=context), - ) - except BaseException as exc: # noqa: BLE001 - if self.raise_server_exceptions: - raise exc - return Response( - status_code=HTTP_500_INTERNAL_SERVER_ERROR, headers=[], stream=ByteStream(b""), request=request - ) - else: - if not context["response_started"]: # pragma: no cover - if self.raise_server_exceptions: - assert context["response_started"], "TestClient did not receive any response." # noqa: S101 - return Response( - status_code=HTTP_500_INTERNAL_SERVER_ERROR, headers=[], stream=ByteStream(b""), request=request - ) - - stream = ByteStream(raw_kwargs.pop("stream", BytesIO()).read()) - response = Response(**raw_kwargs, stream=stream, request=request) - setattr(response, "template", context["template"]) - setattr(response, "context", context["context"]) - return response - - async def handle_async_request(self, request: Request) -> Response: - return self.handle_request(request=request) diff --git a/venv/lib/python3.11/site-packages/litestar/testing/websocket_test_session.py b/venv/lib/python3.11/site-packages/litestar/testing/websocket_test_session.py deleted file mode 100644 index 292e8a9..0000000 --- a/venv/lib/python3.11/site-packages/litestar/testing/websocket_test_session.py +++ /dev/null @@ -1,248 +0,0 @@ -from __future__ import annotations - -from contextlib import ExitStack -from queue import Queue -from typing import TYPE_CHECKING, Any, Literal, cast - -from anyio import sleep - -from litestar.exceptions import WebSocketDisconnect -from litestar.serialization import decode_json, decode_msgpack, encode_json, encode_msgpack -from litestar.status_codes import WS_1000_NORMAL_CLOSURE - -if TYPE_CHECKING: - from litestar.testing.client.sync_client import TestClient - from litestar.types import ( - WebSocketConnectEvent, - WebSocketDisconnectEvent, - WebSocketReceiveMessage, - WebSocketScope, - WebSocketSendMessage, - ) - - -__all__ = ("WebSocketTestSession",) - - -class WebSocketTestSession: - exit_stack: ExitStack - - def __init__( - self, - client: TestClient[Any], - scope: WebSocketScope, - ) -> None: - self.client = client - self.scope = scope - self.accepted_subprotocol: str | None = None - self.receive_queue: Queue[WebSocketReceiveMessage] = Queue() - self.send_queue: Queue[WebSocketSendMessage | BaseException] = Queue() - self.extra_headers: list[tuple[bytes, bytes]] | None = None - - def __enter__(self) -> WebSocketTestSession: - self.exit_stack = ExitStack() - - portal = self.exit_stack.enter_context(self.client.portal()) - - try: - portal.start_task_soon(self.do_asgi_call) - event: WebSocketConnectEvent = {"type": "websocket.connect"} - self.receive_queue.put(event) - - message = self.receive(timeout=self.client.timeout.read) - self.accepted_subprotocol = cast("str | None", message.get("subprotocol", None)) - self.extra_headers = cast("list[tuple[bytes, bytes]] | None", message.get("headers", None)) - return self - except Exception: - self.exit_stack.close() - raise - - def __exit__(self, *args: Any) -> None: - try: - self.close() - finally: - self.exit_stack.close() - while not self.send_queue.empty(): - message = self.send_queue.get() - if isinstance(message, BaseException): - raise message - - async def do_asgi_call(self) -> None: - """The sub-thread in which the websocket session runs.""" - - async def receive() -> WebSocketReceiveMessage: - while self.receive_queue.empty(): - await sleep(0) - return self.receive_queue.get() - - async def send(message: WebSocketSendMessage) -> None: - if message["type"] == "websocket.accept": - headers = message.get("headers", []) - if headers: - headers_list = list(self.scope["headers"]) - headers_list.extend(headers) - self.scope["headers"] = headers_list - subprotocols = cast("str | None", message.get("subprotocols")) - if subprotocols: # pragma: no cover - self.scope["subprotocols"].append(subprotocols) - self.send_queue.put(message) - - try: - await self.client.app(self.scope, receive, send) - except BaseException as exc: - self.send_queue.put(exc) - raise - - def send(self, data: str | bytes, mode: Literal["text", "binary"] = "text", encoding: str = "utf-8") -> None: - """Sends a "receive" event. This is the inverse of the ASGI send method. - - Args: - data: Either a string or a byte string. - mode: The key to use - ``text`` or ``bytes`` - encoding: The encoding to use when encoding or decoding data. - - Returns: - None. - """ - if mode == "text": - data = data.decode(encoding) if isinstance(data, bytes) else data - text_event: WebSocketReceiveMessage = {"type": "websocket.receive", "text": data} # type: ignore[assignment] - self.receive_queue.put(text_event) - else: - data = data if isinstance(data, bytes) else data.encode(encoding) - binary_event: WebSocketReceiveMessage = {"type": "websocket.receive", "bytes": data} # type: ignore[assignment] - self.receive_queue.put(binary_event) - - def send_text(self, data: str, encoding: str = "utf-8") -> None: - """Sends the data using the ``text`` key. - - Args: - data: Data to send. - encoding: Encoding to use. - - Returns: - None - """ - self.send(data=data, encoding=encoding) - - def send_bytes(self, data: bytes, encoding: str = "utf-8") -> None: - """Sends the data using the ``bytes`` key. - - Args: - data: Data to send. - encoding: Encoding to use. - - Returns: - None - """ - self.send(data=data, mode="binary", encoding=encoding) - - def send_json(self, data: Any, mode: Literal["text", "binary"] = "text") -> None: - """Sends the given data as JSON. - - Args: - data: The data to send. - mode: Either ``text`` or ``binary`` - - Returns: - None - """ - self.send(encode_json(data), mode=mode) - - def send_msgpack(self, data: Any) -> None: - """Sends the given data as MessagePack. - - Args: - data: The data to send. - - Returns: - None - """ - self.send(encode_msgpack(data), mode="binary") - - def close(self, code: int = WS_1000_NORMAL_CLOSURE) -> None: - """Sends an 'websocket.disconnect' event. - - Args: - code: status code for closing the connection. - - Returns: - None. - """ - event: WebSocketDisconnectEvent = {"type": "websocket.disconnect", "code": code} - self.receive_queue.put(event) - - def receive(self, block: bool = True, timeout: float | None = None) -> WebSocketSendMessage: - """This is the base receive method. - - Args: - block: Block until a message is received - timeout: If ``block`` is ``True``, block at most ``timeout`` seconds - - Notes: - - you can use one of the other receive methods to extract the data from the message. - - Returns: - A websocket message. - """ - message = cast("WebSocketSendMessage", self.send_queue.get(block=block, timeout=timeout)) - - if isinstance(message, BaseException): - raise message - - if message["type"] == "websocket.close": - raise WebSocketDisconnect( - detail=cast("str", message.get("reason", "")), - code=message.get("code", WS_1000_NORMAL_CLOSURE), - ) - return message - - def receive_text(self, block: bool = True, timeout: float | None = None) -> str: - """Receive data in ``text`` mode and return a string - - Args: - block: Block until a message is received - timeout: If ``block`` is ``True``, block at most ``timeout`` seconds - - Returns: - A string value. - """ - message = self.receive(block=block, timeout=timeout) - return cast("str", message.get("text", "")) - - def receive_bytes(self, block: bool = True, timeout: float | None = None) -> bytes: - """Receive data in ``binary`` mode and return bytes - - Args: - block: Block until a message is received - timeout: If ``block`` is ``True``, block at most ``timeout`` seconds - - Returns: - A string value. - """ - message = self.receive(block=block, timeout=timeout) - return cast("bytes", message.get("bytes", b"")) - - def receive_json( - self, mode: Literal["text", "binary"] = "text", block: bool = True, timeout: float | None = None - ) -> Any: - """Receive data in either ``text`` or ``binary`` mode and decode it as JSON. - - Args: - mode: Either ``text`` or ``binary`` - block: Block until a message is received - timeout: If ``block`` is ``True``, block at most ``timeout`` seconds - - Returns: - An arbitrary value - """ - message = self.receive(block=block, timeout=timeout) - - if mode == "text": - return decode_json(cast("str", message.get("text", ""))) - - return decode_json(cast("bytes", message.get("bytes", b""))) - - def receive_msgpack(self, block: bool = True, timeout: float | None = None) -> Any: - message = self.receive(block=block, timeout=timeout) - return decode_msgpack(cast("bytes", message.get("bytes", b""))) diff --git a/venv/lib/python3.11/site-packages/litestar/types/__init__.py b/venv/lib/python3.11/site-packages/litestar/types/__init__.py deleted file mode 100644 index 90e3192..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/__init__.py +++ /dev/null @@ -1,169 +0,0 @@ -from .asgi_types import ( - ASGIApp, - ASGIVersion, - BaseScope, - HTTPDisconnectEvent, - HTTPReceiveMessage, - HTTPRequestEvent, - HTTPResponseBodyEvent, - HTTPResponseStartEvent, - HTTPScope, - HTTPSendMessage, - HTTPServerPushEvent, - LifeSpanReceive, - LifeSpanReceiveMessage, - LifeSpanScope, - LifeSpanSend, - LifeSpanSendMessage, - LifeSpanShutdownCompleteEvent, - LifeSpanShutdownEvent, - LifeSpanShutdownFailedEvent, - LifeSpanStartupCompleteEvent, - LifeSpanStartupEvent, - LifeSpanStartupFailedEvent, - Message, - Method, - Receive, - ReceiveMessage, - Scope, - ScopeSession, - Send, - WebSocketAcceptEvent, - WebSocketCloseEvent, - WebSocketConnectEvent, - WebSocketDisconnectEvent, - WebSocketReceiveEvent, - WebSocketReceiveMessage, - WebSocketResponseBodyEvent, - WebSocketResponseStartEvent, - WebSocketScope, - WebSocketSendEvent, - WebSocketSendMessage, -) -from .builtin_types import TypedDictClass -from .callable_types import ( - AfterExceptionHookHandler, - AfterRequestHookHandler, - AfterResponseHookHandler, - AnyCallable, - AnyGenerator, - AsyncAnyCallable, - BeforeMessageSendHookHandler, - BeforeRequestHookHandler, - CacheKeyBuilder, - ExceptionHandler, - GetLogger, - Guard, - LifespanHook, - OnAppInitHandler, - OperationIDCreator, - Serializer, -) -from .composite_types import ( - Dependencies, - ExceptionHandlersMap, - Middleware, - ParametersMap, - PathType, - ResponseCookies, - ResponseHeaders, - Scopes, - TypeDecodersSequence, - TypeEncodersMap, -) -from .empty import Empty, EmptyType -from .file_types import FileInfo, FileSystemProtocol -from .helper_types import AnyIOBackend, MaybePartial, OptionalSequence, SSEData, StreamType, SyncOrAsyncUnion -from .internal_types import ControllerRouterHandler, ReservedKwargs, RouteHandlerMapItem, RouteHandlerType -from .protocols import DataclassProtocol, Logger -from .serialization import DataContainerType, LitestarEncodableType - -__all__ = ( - "ASGIApp", - "ASGIVersion", - "AfterExceptionHookHandler", - "AfterRequestHookHandler", - "AfterResponseHookHandler", - "AnyCallable", - "AnyGenerator", - "AnyIOBackend", - "AsyncAnyCallable", - "BaseScope", - "BeforeMessageSendHookHandler", - "BeforeRequestHookHandler", - "CacheKeyBuilder", - "ControllerRouterHandler", - "DataContainerType", - "DataclassProtocol", - "Dependencies", - "Empty", - "EmptyType", - "ExceptionHandler", - "ExceptionHandlersMap", - "FileInfo", - "FileSystemProtocol", - "GetLogger", - "Guard", - "HTTPDisconnectEvent", - "HTTPReceiveMessage", - "HTTPRequestEvent", - "HTTPResponseBodyEvent", - "HTTPResponseStartEvent", - "HTTPScope", - "HTTPSendMessage", - "HTTPServerPushEvent", - "LifeSpanReceive", - "LifeSpanReceiveMessage", - "LifeSpanScope", - "LifeSpanSend", - "LifeSpanSendMessage", - "LifeSpanShutdownCompleteEvent", - "LifeSpanShutdownEvent", - "LifeSpanShutdownFailedEvent", - "LifeSpanStartupCompleteEvent", - "LifeSpanStartupEvent", - "LifeSpanStartupFailedEvent", - "LifespanHook", - "LitestarEncodableType", - "Logger", - "MaybePartial", - "Message", - "Method", - "Middleware", - "OnAppInitHandler", - "OperationIDCreator", - "OptionalSequence", - "ParametersMap", - "PathType", - "Receive", - "ReceiveMessage", - "ReservedKwargs", - "ResponseCookies", - "ResponseHeaders", - "RouteHandlerMapItem", - "RouteHandlerType", - "Scope", - "ScopeSession", - "Scopes", - "Send", - "Serializer", - "StreamType", - "SSEData", - "SyncOrAsyncUnion", - "TypeDecodersSequence", - "TypeEncodersMap", - "TypedDictClass", - "WebSocketAcceptEvent", - "WebSocketCloseEvent", - "WebSocketConnectEvent", - "WebSocketDisconnectEvent", - "WebSocketReceiveEvent", - "WebSocketReceiveMessage", - "WebSocketReceiveMessage", - "WebSocketResponseBodyEvent", - "WebSocketResponseStartEvent", - "WebSocketScope", - "WebSocketSendEvent", - "WebSocketSendMessage", - "WebSocketSendMessage", -) diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index 6f64e92..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/asgi_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/asgi_types.cpython-311.pyc deleted file mode 100644 index cbed524..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/asgi_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/builtin_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/builtin_types.cpython-311.pyc deleted file mode 100644 index 42a633c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/builtin_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/callable_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/callable_types.cpython-311.pyc deleted file mode 100644 index e956ed6..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/callable_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/composite_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/composite_types.cpython-311.pyc deleted file mode 100644 index 4761e1c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/composite_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/empty.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/empty.cpython-311.pyc deleted file mode 100644 index 1ce4b48..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/empty.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/file_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/file_types.cpython-311.pyc deleted file mode 100644 index c2a5ffd..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/file_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/helper_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/helper_types.cpython-311.pyc deleted file mode 100644 index e0ee6eb..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/helper_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/internal_types.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/internal_types.cpython-311.pyc deleted file mode 100644 index 8d0ac7e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/internal_types.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/protocols.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/protocols.cpython-311.pyc deleted file mode 100644 index 1caf78a..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/protocols.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/serialization.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/types/__pycache__/serialization.cpython-311.pyc deleted file mode 100644 index 3bd8dc5..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/types/__pycache__/serialization.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/types/asgi_types.py b/venv/lib/python3.11/site-packages/litestar/types/asgi_types.py deleted file mode 100644 index 0a6f77f..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/asgi_types.py +++ /dev/null @@ -1,343 +0,0 @@ -"""Includes code adapted from https://github.com/django/asgiref/blob/main/asgiref/typing.py. - -Copyright (c) Django Software Foundation and individual contributors. -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - - 3. Neither the name of Django nor the names of its contributors may be used - to endorse or promote products derived from this software without - specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -""" - -from __future__ import annotations - -from typing import ( - TYPE_CHECKING, - Any, - Awaitable, - Callable, - Dict, - Iterable, - List, - Literal, - Tuple, - TypedDict, - Union, -) - -from litestar.enums import HttpMethod - -__all__ = ( - "ASGIApp", - "ASGIVersion", - "BaseScope", - "HeaderScope", - "HTTPDisconnectEvent", - "HTTPReceiveMessage", - "HTTPRequestEvent", - "HTTPResponseBodyEvent", - "HTTPResponseStartEvent", - "HTTPScope", - "HTTPSendMessage", - "HTTPServerPushEvent", - "LifeSpanReceive", - "LifeSpanReceiveMessage", - "LifeSpanScope", - "LifeSpanSend", - "LifeSpanSendMessage", - "LifeSpanShutdownCompleteEvent", - "LifeSpanShutdownEvent", - "LifeSpanShutdownFailedEvent", - "LifeSpanStartupCompleteEvent", - "LifeSpanStartupEvent", - "LifeSpanStartupFailedEvent", - "Message", - "Method", - "RawHeaders", - "RawHeadersList", - "Receive", - "ReceiveMessage", - "Scope", - "ScopeSession", - "Send", - "WebSocketAcceptEvent", - "WebSocketCloseEvent", - "WebSocketConnectEvent", - "WebSocketDisconnectEvent", - "WebSocketMode", - "WebSocketReceiveEvent", - "WebSocketReceiveMessage", - "WebSocketResponseBodyEvent", - "WebSocketResponseStartEvent", - "WebSocketScope", - "WebSocketSendEvent", - "WebSocketSendMessage", -) - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - - from litestar.app import Litestar - from litestar.enums import ScopeType - from litestar.types.empty import EmptyType - - from .internal_types import RouteHandlerType - from .serialization import DataContainerType - -Method: TypeAlias = Union[Literal["GET", "POST", "DELETE", "PATCH", "PUT", "HEAD", "TRACE", "OPTIONS"], HttpMethod] -ScopeSession: TypeAlias = "EmptyType | Dict[str, Any] | DataContainerType | None" - - -class ASGIVersion(TypedDict): - """ASGI spec version.""" - - spec_version: str - version: Literal["3.0"] - - -class HeaderScope(TypedDict): - """Base class for ASGI-scopes that supports headers.""" - - headers: RawHeaders - - -class BaseScope(HeaderScope): - """Base ASGI-scope.""" - - app: Litestar - asgi: ASGIVersion - auth: Any - client: tuple[str, int] | None - extensions: dict[str, dict[object, object]] | None - http_version: str - path: str - path_params: dict[str, str] - query_string: bytes - raw_path: bytes - root_path: str - route_handler: RouteHandlerType - scheme: str - server: tuple[str, int | None] | None - session: ScopeSession - state: dict[str, Any] - user: Any - - -class HTTPScope(BaseScope): - """HTTP-ASGI-scope.""" - - method: Method - type: Literal[ScopeType.HTTP] - - -class WebSocketScope(BaseScope): - """WebSocket-ASGI-scope.""" - - subprotocols: list[str] - type: Literal[ScopeType.WEBSOCKET] - - -class LifeSpanScope(TypedDict): - """Lifespan-ASGI-scope.""" - - app: Litestar - asgi: ASGIVersion - type: Literal["lifespan"] - - -class HTTPRequestEvent(TypedDict): - """ASGI `http.request` event.""" - - type: Literal["http.request"] - body: bytes - more_body: bool - - -class HTTPResponseStartEvent(HeaderScope): - """ASGI `http.response.start` event.""" - - type: Literal["http.response.start"] - status: int - - -class HTTPResponseBodyEvent(TypedDict): - """ASGI `http.response.body` event.""" - - type: Literal["http.response.body"] - body: bytes - more_body: bool - - -class HTTPServerPushEvent(HeaderScope): - """ASGI `http.response.push` event.""" - - type: Literal["http.response.push"] - path: str - - -class HTTPDisconnectEvent(TypedDict): - """ASGI `http.disconnect` event.""" - - type: Literal["http.disconnect"] - - -class WebSocketConnectEvent(TypedDict): - """ASGI `websocket.connect` event.""" - - type: Literal["websocket.connect"] - - -class WebSocketAcceptEvent(HeaderScope): - """ASGI `websocket.accept` event.""" - - type: Literal["websocket.accept"] - subprotocol: str | None - - -class WebSocketReceiveEvent(TypedDict): - """ASGI `websocket.receive` event.""" - - type: Literal["websocket.receive"] - bytes: bytes | None - text: str | None - - -class WebSocketSendEvent(TypedDict): - """ASGI `websocket.send` event.""" - - type: Literal["websocket.send"] - bytes: bytes | None - text: str | None - - -class WebSocketResponseStartEvent(HeaderScope): - """ASGI `websocket.http.response.start` event.""" - - type: Literal["websocket.http.response.start"] - status: int - - -class WebSocketResponseBodyEvent(TypedDict): - """ASGI `websocket.http.response.body` event.""" - - type: Literal["websocket.http.response.body"] - body: bytes - more_body: bool - - -class WebSocketDisconnectEvent(TypedDict): - """ASGI `websocket.disconnect` event.""" - - type: Literal["websocket.disconnect"] - code: int - - -class WebSocketCloseEvent(TypedDict): - """ASGI `websocket.close` event.""" - - type: Literal["websocket.close"] - code: int - reason: str | None - - -class LifeSpanStartupEvent(TypedDict): - """ASGI `lifespan.startup` event.""" - - type: Literal["lifespan.startup"] - - -class LifeSpanShutdownEvent(TypedDict): - """ASGI `lifespan.shutdown` event.""" - - type: Literal["lifespan.shutdown"] - - -class LifeSpanStartupCompleteEvent(TypedDict): - """ASGI `lifespan.startup.complete` event.""" - - type: Literal["lifespan.startup.complete"] - - -class LifeSpanStartupFailedEvent(TypedDict): - """ASGI `lifespan.startup.failed` event.""" - - type: Literal["lifespan.startup.failed"] - message: str - - -class LifeSpanShutdownCompleteEvent(TypedDict): - """ASGI `lifespan.shutdown.complete` event.""" - - type: Literal["lifespan.shutdown.complete"] - - -class LifeSpanShutdownFailedEvent(TypedDict): - """ASGI `lifespan.shutdown.failed` event.""" - - type: Literal["lifespan.shutdown.failed"] - message: str - - -HTTPReceiveMessage: TypeAlias = Union[ - HTTPRequestEvent, - HTTPDisconnectEvent, -] -WebSocketReceiveMessage: TypeAlias = Union[ - WebSocketConnectEvent, - WebSocketReceiveEvent, - WebSocketDisconnectEvent, -] -LifeSpanReceiveMessage: TypeAlias = Union[ - LifeSpanStartupEvent, - LifeSpanShutdownEvent, -] -HTTPSendMessage: TypeAlias = Union[ - HTTPResponseStartEvent, - HTTPResponseBodyEvent, - HTTPServerPushEvent, - HTTPDisconnectEvent, -] -WebSocketSendMessage: TypeAlias = Union[ - WebSocketAcceptEvent, - WebSocketSendEvent, - WebSocketResponseStartEvent, - WebSocketResponseBodyEvent, - WebSocketCloseEvent, -] -LifeSpanSendMessage: TypeAlias = Union[ - LifeSpanStartupCompleteEvent, - LifeSpanStartupFailedEvent, - LifeSpanShutdownCompleteEvent, - LifeSpanShutdownFailedEvent, -] -LifeSpanReceive: TypeAlias = Callable[..., Awaitable[LifeSpanReceiveMessage]] -LifeSpanSend: TypeAlias = Callable[[LifeSpanSendMessage], Awaitable[None]] -Message: TypeAlias = Union[HTTPSendMessage, WebSocketSendMessage] -ReceiveMessage: TypeAlias = Union[HTTPReceiveMessage, WebSocketReceiveMessage] -Scope: TypeAlias = Union[HTTPScope, WebSocketScope] -Receive: TypeAlias = Callable[..., Awaitable[Union[HTTPReceiveMessage, WebSocketReceiveMessage]]] -Send: TypeAlias = Callable[[Message], Awaitable[None]] -ASGIApp: TypeAlias = Callable[[Scope, Receive, Send], Awaitable[None]] -RawHeaders: TypeAlias = Iterable[Tuple[bytes, bytes]] -RawHeadersList: TypeAlias = List[Tuple[bytes, bytes]] -WebSocketMode: TypeAlias = Literal["text", "binary"] diff --git a/venv/lib/python3.11/site-packages/litestar/types/builtin_types.py b/venv/lib/python3.11/site-packages/litestar/types/builtin_types.py deleted file mode 100644 index 335dedd..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/builtin_types.py +++ /dev/null @@ -1,25 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Type, Union - -from typing_extensions import _TypedDictMeta # type: ignore[attr-defined] - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - -__all__ = ( - "NoneType", - "UnionType", - "UnionTypes", - "TypedDictClass", -) - -NoneType: type[None] = type(None) - -try: - from types import UnionType # type: ignore[attr-defined] -except ImportError: - UnionType: TypeAlias = Union # type: ignore[no-redef] - -UnionTypes = {UnionType, Union} -TypedDictClass: TypeAlias = Type[_TypedDictMeta] diff --git a/venv/lib/python3.11/site-packages/litestar/types/callable_types.py b/venv/lib/python3.11/site-packages/litestar/types/callable_types.py deleted file mode 100644 index 36055d7..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/callable_types.py +++ /dev/null @@ -1,40 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any, AsyncGenerator, Awaitable, Callable, Generator, TypeVar - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - - from litestar.app import Litestar - from litestar.config.app import AppConfig - from litestar.connection.base import ASGIConnection - from litestar.connection.request import Request - from litestar.handlers.base import BaseRouteHandler - from litestar.handlers.http_handlers import HTTPRouteHandler - from litestar.response.base import Response - from litestar.types.asgi_types import ASGIApp, Message, Method, Scope - from litestar.types.helper_types import SyncOrAsyncUnion - from litestar.types.internal_types import PathParameterDefinition - from litestar.types.protocols import Logger - -ExceptionT = TypeVar("ExceptionT", bound=Exception) - -AfterExceptionHookHandler: TypeAlias = "Callable[[ExceptionT, Scope], SyncOrAsyncUnion[None]]" -AfterRequestHookHandler: TypeAlias = ( - "Callable[[ASGIApp], SyncOrAsyncUnion[ASGIApp]] | Callable[[Response], SyncOrAsyncUnion[Response]]" -) -AfterResponseHookHandler: TypeAlias = "Callable[[Request], SyncOrAsyncUnion[None]]" -AsyncAnyCallable: TypeAlias = Callable[..., Awaitable[Any]] -AnyCallable: TypeAlias = Callable[..., Any] -AnyGenerator: TypeAlias = "Generator[Any, Any, Any] | AsyncGenerator[Any, Any]" -BeforeMessageSendHookHandler: TypeAlias = "Callable[[Message, Scope], SyncOrAsyncUnion[None]]" -BeforeRequestHookHandler: TypeAlias = "Callable[[Request], Any | Awaitable[Any]]" -CacheKeyBuilder: TypeAlias = "Callable[[Request], str]" -ExceptionHandler: TypeAlias = "Callable[[Request, ExceptionT], Response]" -ExceptionLoggingHandler: TypeAlias = "Callable[[Logger, Scope, list[str]], None]" -GetLogger: TypeAlias = "Callable[..., Logger]" -Guard: TypeAlias = "Callable[[ASGIConnection, BaseRouteHandler], SyncOrAsyncUnion[None]]" -LifespanHook: TypeAlias = "Callable[[Litestar], SyncOrAsyncUnion[Any]] | Callable[[], SyncOrAsyncUnion[Any]]" -OnAppInitHandler: TypeAlias = "Callable[[AppConfig], AppConfig]" -OperationIDCreator: TypeAlias = "Callable[[HTTPRouteHandler, Method, list[str | PathParameterDefinition]], str]" -Serializer: TypeAlias = Callable[[Any], Any] diff --git a/venv/lib/python3.11/site-packages/litestar/types/composite_types.py b/venv/lib/python3.11/site-packages/litestar/types/composite_types.py deleted file mode 100644 index afd905f..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/composite_types.py +++ /dev/null @@ -1,56 +0,0 @@ -from __future__ import annotations - -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Dict, - Iterator, - Literal, - Mapping, - MutableMapping, - Sequence, - Tuple, - Type, - Union, -) - -__all__ = ( - "Dependencies", - "ExceptionHandlersMap", - "Middleware", - "ParametersMap", - "PathType", - "ResponseCookies", - "ResponseHeaders", - "Scopes", - "TypeEncodersMap", -) - - -if TYPE_CHECKING: - from os import PathLike - from pathlib import Path - - from typing_extensions import TypeAlias - - from litestar.datastructures.cookie import Cookie - from litestar.datastructures.response_header import ResponseHeader - from litestar.di import Provide - from litestar.enums import ScopeType - from litestar.middleware.base import DefineMiddleware, MiddlewareProtocol - from litestar.params import ParameterKwarg - - from .asgi_types import ASGIApp - from .callable_types import AnyCallable, ExceptionHandler - -Dependencies: TypeAlias = "Mapping[str, Union[Provide, AnyCallable]]" -ExceptionHandlersMap: TypeAlias = "MutableMapping[Union[int, Type[Exception]], ExceptionHandler]" -Middleware: TypeAlias = "Union[Callable[..., ASGIApp], DefineMiddleware, Iterator[Tuple[ASGIApp, Dict[str, Any]]], Type[MiddlewareProtocol]]" -ParametersMap: TypeAlias = "Mapping[str, ParameterKwarg]" -PathType: TypeAlias = "Union[Path, PathLike, str]" -ResponseCookies: TypeAlias = "Union[Sequence[Cookie], Mapping[str, str]]" -ResponseHeaders: TypeAlias = "Union[Sequence[ResponseHeader], Mapping[str, str]]" -Scopes: TypeAlias = "set[Literal[ScopeType.HTTP, ScopeType.WEBSOCKET]]" -TypeDecodersSequence: TypeAlias = "Sequence[tuple[Callable[[Any], bool], Callable[[Any, Any], Any]]]" -TypeEncodersMap: TypeAlias = "Mapping[Any, Callable[[Any], Any]]" diff --git a/venv/lib/python3.11/site-packages/litestar/types/empty.py b/venv/lib/python3.11/site-packages/litestar/types/empty.py deleted file mode 100644 index dee9bc1..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/empty.py +++ /dev/null @@ -1,16 +0,0 @@ -from __future__ import annotations - -__all__ = ("Empty", "EmptyType") - -from enum import Enum -from typing import Final, Literal - - -class _EmptyEnum(Enum): - """A sentinel enum used as placeholder.""" - - EMPTY = 0 - - -EmptyType = Literal[_EmptyEnum.EMPTY] -Empty: Final = _EmptyEnum.EMPTY diff --git a/venv/lib/python3.11/site-packages/litestar/types/file_types.py b/venv/lib/python3.11/site-packages/litestar/types/file_types.py deleted file mode 100644 index 7848721..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/file_types.py +++ /dev/null @@ -1,106 +0,0 @@ -from __future__ import annotations - -from typing import ( - IO, - TYPE_CHECKING, - Any, - AnyStr, - Awaitable, - Literal, - Protocol, - TypedDict, - overload, -) - -__all__ = ("FileInfo", "FileSystemProtocol") - - -if TYPE_CHECKING: - from _typeshed import OpenBinaryMode, OpenTextMode - from anyio import AsyncFile - from typing_extensions import NotRequired - - from litestar.types.composite_types import PathType - - -class FileInfo(TypedDict): - """File information gathered from a file system.""" - - created: float - """Created time stamp, equal to 'stat_result.st_ctime'.""" - destination: NotRequired[bytes | None] - """Output of loading a symbolic link.""" - gid: int - """Group ID of owner.""" - ino: int - """inode value.""" - islink: bool - """True if the file is a symbolic link.""" - mode: int - """Protection mode.""" - mtime: float - """Modified time stamp.""" - name: str - """The path of the file.""" - nlink: int - """Number of hard links.""" - size: int - """Total size, in bytes.""" - type: Literal["file", "directory", "other"] - """The type of the file system object.""" - uid: int - """User ID of owner.""" - - -class FileSystemProtocol(Protocol): - """Base protocol used to interact with a file-system. - - This protocol is commensurable with the file systems - exported by the `fsspec ` library. - """ - - def info(self, path: PathType, **kwargs: Any) -> FileInfo | Awaitable[FileInfo]: - """Retrieve information about a given file path. - - Args: - path: A file path. - **kwargs: Any additional kwargs. - - Returns: - A dictionary of file info. - """ - ... - - @overload - def open( - self, - file: PathType, - mode: OpenBinaryMode, - buffering: int = -1, - ) -> IO[bytes] | Awaitable[AsyncFile[bytes]]: ... - - @overload - def open( - self, - file: PathType, - mode: OpenTextMode, - buffering: int = -1, - ) -> IO[str] | Awaitable[AsyncFile[str]]: ... - - def open( # pyright: ignore - self, - file: PathType, - mode: str, - buffering: int = -1, - ) -> IO[AnyStr] | Awaitable[AsyncFile[AnyStr]]: - """Return a file-like object from the filesystem. - - Notes: - - The return value must function correctly in a context ``with`` block. - - Args: - file: Path to the target file. - mode: Mode, similar to the built ``open``. - buffering: Buffer size. - """ - ... diff --git a/venv/lib/python3.11/site-packages/litestar/types/helper_types.py b/venv/lib/python3.11/site-packages/litestar/types/helper_types.py deleted file mode 100644 index 588ae54..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/helper_types.py +++ /dev/null @@ -1,47 +0,0 @@ -from __future__ import annotations - -from functools import partial -from typing import ( - TYPE_CHECKING, - Any, - AsyncIterable, - AsyncIterator, - Awaitable, - Dict, - Iterable, - Iterator, - Literal, - Optional, - Sequence, - TypeVar, - Union, -) - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - - from litestar.response.sse import ServerSentEventMessage - - -T = TypeVar("T") - -__all__ = ("OptionalSequence", "SyncOrAsyncUnion", "AnyIOBackend", "StreamType", "MaybePartial", "SSEData") - -OptionalSequence: TypeAlias = Optional[Sequence[T]] -"""Types 'T' as union of Sequence[T] and None.""" - -SyncOrAsyncUnion: TypeAlias = Union[T, Awaitable[T]] -"""Types 'T' as a union of T and awaitable T.""" - - -AnyIOBackend: TypeAlias = Literal["asyncio", "trio"] -"""Anyio backend names.""" - -StreamType: TypeAlias = Union[Iterable[T], Iterator[T], AsyncIterable[T], AsyncIterator[T]] -"""A stream type.""" - -MaybePartial: TypeAlias = Union[T, partial] -"""A potentially partial callable.""" - -SSEData: TypeAlias = Union[int, str, bytes, Dict[str, Any], "ServerSentEventMessage"] -"""A type alias for SSE data.""" diff --git a/venv/lib/python3.11/site-packages/litestar/types/internal_types.py b/venv/lib/python3.11/site-packages/litestar/types/internal_types.py deleted file mode 100644 index d473c22..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/internal_types.py +++ /dev/null @@ -1,58 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any, Callable, Literal, NamedTuple - -from litestar.utils.deprecation import warn_deprecation - -__all__ = ( - "ControllerRouterHandler", - "PathParameterDefinition", - "PathParameterDefinition", - "ReservedKwargs", - "RouteHandlerMapItem", - "RouteHandlerType", -) - -if TYPE_CHECKING: - from typing_extensions import TypeAlias - - from litestar.app import Litestar - from litestar.controller import Controller - from litestar.handlers.asgi_handlers import ASGIRouteHandler - from litestar.handlers.http_handlers import HTTPRouteHandler - from litestar.handlers.websocket_handlers import WebsocketRouteHandler - from litestar.router import Router - from litestar.template import TemplateConfig - from litestar.template.config import EngineType - from litestar.types import Method - -ReservedKwargs: TypeAlias = Literal["request", "socket", "headers", "query", "cookies", "state", "data"] -RouteHandlerType: TypeAlias = "HTTPRouteHandler | WebsocketRouteHandler | ASGIRouteHandler" -ControllerRouterHandler: TypeAlias = "type[Controller] | RouteHandlerType | Router | Callable[..., Any]" -RouteHandlerMapItem: TypeAlias = 'dict[Method | Literal["websocket", "asgi"], RouteHandlerType]' -TemplateConfigType: TypeAlias = "TemplateConfig[EngineType]" - -# deprecated -_LitestarType: TypeAlias = "Litestar" - - -class PathParameterDefinition(NamedTuple): - """Path parameter tuple.""" - - name: str - full: str - type: type - parser: Callable[[str], Any] | None - - -def __getattr__(name: str) -> Any: - if name == "LitestarType": - warn_deprecation( - "2.2.1", - "LitestarType", - "import", - removal_in="3.0.0", - alternative="Litestar", - ) - return _LitestarType - raise AttributeError(f"module {__name__!r} has no attribute {name!r}") diff --git a/venv/lib/python3.11/site-packages/litestar/types/protocols.py b/venv/lib/python3.11/site-packages/litestar/types/protocols.py deleted file mode 100644 index 4e509ee..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/protocols.py +++ /dev/null @@ -1,113 +0,0 @@ -from __future__ import annotations - -from typing import Any, ClassVar, Collection, Iterable, Protocol, TypeVar, runtime_checkable - -__all__ = ( - "DataclassProtocol", - "InstantiableCollection", - "Logger", -) - - -class Logger(Protocol): - """Logger protocol.""" - - def debug(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'DEBUG' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def info(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'INFO' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def warning(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'WARNING' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def warn(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'WARN' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def error(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'ERROR' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def fatal(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'FATAL' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def exception(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Log a message with level 'ERROR' on this logger. The arguments are interpreted as for debug(). Exception info - is added to the logging message. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def critical(self, event: str, *args: Any, **kwargs: Any) -> Any: - """Output a log message at 'INFO' level. - - Args: - event: Log message. - *args: Any args. - **kwargs: Any kwargs. - """ - - def setLevel(self, level: int) -> None: # noqa: N802 - """Set the log level - - Args: - level: Log level to set as an integer - - Returns: - None - """ - - -@runtime_checkable -class DataclassProtocol(Protocol): - """Protocol for instance checking dataclasses""" - - __dataclass_fields__: ClassVar[dict[str, Any]] - - -T_co = TypeVar("T_co", covariant=True) - - -@runtime_checkable -class InstantiableCollection(Collection[T_co], Protocol[T_co]): # pyright: ignore - """A protocol for instantiable collection types.""" - - def __init__(self, iterable: Iterable[T_co], /) -> None: ... diff --git a/venv/lib/python3.11/site-packages/litestar/types/serialization.py b/venv/lib/python3.11/site-packages/litestar/types/serialization.py deleted file mode 100644 index 0f61e10..0000000 --- a/venv/lib/python3.11/site-packages/litestar/types/serialization.py +++ /dev/null @@ -1,59 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any - -if TYPE_CHECKING: - from collections import deque - from collections.abc import Collection - from datetime import date, datetime, time - from decimal import Decimal - from enum import Enum, IntEnum - from ipaddress import ( - IPv4Address, - IPv4Interface, - IPv4Network, - IPv6Address, - IPv6Interface, - IPv6Network, - ) - from pathlib import Path, PurePath - from re import Pattern - from uuid import UUID - - from msgspec import Raw, Struct - from msgspec.msgpack import Ext - from typing_extensions import TypeAlias - - from litestar.types import DataclassProtocol, TypedDictClass - - try: - from pydantic import BaseModel - except ImportError: - BaseModel = Any # type: ignore[assignment, misc] - - try: - from attrs import AttrsInstance - except ImportError: - AttrsInstance = Any # type: ignore[assignment, misc] - -__all__ = ( - "LitestarEncodableType", - "EncodableBuiltinType", - "EncodableBuiltinCollectionType", - "EncodableStdLibType", - "EncodableStdLibIPType", - "EncodableMsgSpecType", - "DataContainerType", -) - -EncodableBuiltinType: TypeAlias = "None | bool | int | float | str | bytes | bytearray" -EncodableBuiltinCollectionType: TypeAlias = "list | tuple | set | frozenset | dict | Collection" -EncodableStdLibType: TypeAlias = ( - "date | datetime | deque | time | UUID | Decimal | Enum | IntEnum | DataclassProtocol | Path | PurePath | Pattern" -) -EncodableStdLibIPType: TypeAlias = ( - "IPv4Address | IPv4Interface | IPv4Network | IPv6Address | IPv6Interface | IPv6Network" -) -EncodableMsgSpecType: TypeAlias = "Ext | Raw | Struct" -LitestarEncodableType: TypeAlias = "EncodableBuiltinType | EncodableBuiltinCollectionType | EncodableStdLibType | EncodableStdLibIPType | EncodableMsgSpecType | BaseModel | AttrsInstance" # pyright: ignore -DataContainerType: TypeAlias = "Struct | BaseModel | AttrsInstance | TypedDictClass | DataclassProtocol" # pyright: ignore diff --git a/venv/lib/python3.11/site-packages/litestar/typing.py b/venv/lib/python3.11/site-packages/litestar/typing.py deleted file mode 100644 index 3a27557..0000000 --- a/venv/lib/python3.11/site-packages/litestar/typing.py +++ /dev/null @@ -1,636 +0,0 @@ -from __future__ import annotations - -from collections import abc, deque -from copy import deepcopy -from dataclasses import dataclass, is_dataclass, replace -from inspect import Parameter, Signature -from typing import ( - Any, - AnyStr, - Callable, - Collection, - ForwardRef, - Literal, - Mapping, - Protocol, - Sequence, - TypeVar, - cast, -) - -from msgspec import UnsetType -from typing_extensions import NotRequired, Required, Self, get_args, get_origin, get_type_hints, is_typeddict - -from litestar.exceptions import ImproperlyConfiguredException -from litestar.openapi.spec import Example -from litestar.params import BodyKwarg, DependencyKwarg, KwargDefinition, ParameterKwarg -from litestar.types import Empty -from litestar.types.builtin_types import NoneType, UnionTypes -from litestar.utils.predicates import ( - is_annotated_type, - is_any, - is_class_and_subclass, - is_generic, - is_non_string_iterable, - is_non_string_sequence, - is_union, -) -from litestar.utils.typing import ( - get_instantiable_origin, - get_safe_generic_origin, - get_type_hints_with_generics_resolved, - make_non_optional_union, - unwrap_annotation, -) - -__all__ = ("FieldDefinition",) - -T = TypeVar("T", bound=KwargDefinition) - - -class _KwargMetaExtractor(Protocol): - @staticmethod - def matches(annotation: Any, name: str | None, default: Any) -> bool: ... - - @staticmethod - def extract(annotation: Any, default: Any) -> Any: ... - - -_KWARG_META_EXTRACTORS: set[_KwargMetaExtractor] = set() - - -def _unpack_predicate(value: Any) -> dict[str, Any]: - try: - from annotated_types import Predicate - - if isinstance(value, Predicate): - if value.func == str.islower: - return {"lower_case": True} - if value.func == str.isupper: - return {"upper_case": True} - if value.func == str.isascii: - return {"pattern": "[[:ascii:]]"} - if value.func == str.isdigit: - return {"pattern": "[[:digit:]]"} - except ImportError: - pass - - return {} - - -def _parse_metadata(value: Any, is_sequence_container: bool, extra: dict[str, Any] | None) -> dict[str, Any]: - """Parse metadata from a value. - - Args: - value: A metadata value from annotation, namely anything stored under Annotated[x, metadata...] - is_sequence_container: Whether the type is a sequence container (list, tuple etc...) - extra: Extra key values to parse. - - Returns: - A dictionary of constraints, which fulfill the kwargs of a KwargDefinition class. - """ - extra = { - **cast("dict[str, Any]", extra or getattr(value, "extra", None) or {}), - **(getattr(value, "json_schema_extra", None) or {}), - } - example_list: list[Any] | None - if example := extra.pop("example", None): - example_list = [Example(value=example)] - elif examples := getattr(value, "examples", None): - example_list = [Example(value=example) for example in cast("list[str]", examples)] - else: - example_list = None - - return { - k: v - for k, v in { - "gt": getattr(value, "gt", None), - "ge": getattr(value, "ge", None), - "lt": getattr(value, "lt", None), - "le": getattr(value, "le", None), - "multiple_of": getattr(value, "multiple_of", None), - "min_length": None if is_sequence_container else getattr(value, "min_length", None), - "max_length": None if is_sequence_container else getattr(value, "max_length", None), - "description": getattr(value, "description", None), - "examples": example_list, - "title": getattr(value, "title", None), - "lower_case": getattr(value, "to_lower", None), - "upper_case": getattr(value, "to_upper", None), - "pattern": getattr(value, "regex", getattr(value, "pattern", None)), - "min_items": getattr(value, "min_items", getattr(value, "min_length", None)) - if is_sequence_container - else None, - "max_items": getattr(value, "max_items", getattr(value, "max_length", None)) - if is_sequence_container - else None, - "const": getattr(value, "const", None) is not None, - **extra, - }.items() - if v is not None - } - - -def _traverse_metadata( - metadata: Sequence[Any], is_sequence_container: bool, extra: dict[str, Any] | None -) -> dict[str, Any]: - """Recursively traverse metadata from a value. - - Args: - metadata: A list of metadata values from annotation, namely anything stored under Annotated[x, metadata...] - is_sequence_container: Whether the container is a sequence container (list, tuple etc...) - extra: Extra key values to parse. - - Returns: - A dictionary of constraints, which fulfill the kwargs of a KwargDefinition class. - """ - constraints: dict[str, Any] = {} - for value in metadata: - if isinstance(value, (list, set, frozenset, deque)): - constraints.update( - _traverse_metadata( - metadata=cast("Sequence[Any]", value), is_sequence_container=is_sequence_container, extra=extra - ) - ) - elif is_annotated_type(value) and (type_args := [v for v in get_args(value) if v is not None]): - # annotated values can be nested inside other annotated values - # this behaviour is buggy in python 3.8, hence we need to guard here. - if len(type_args) > 1: - constraints.update( - _traverse_metadata(metadata=type_args[1:], is_sequence_container=is_sequence_container, extra=extra) - ) - elif unpacked_predicate := _unpack_predicate(value): - constraints.update(unpacked_predicate) - else: - constraints.update(_parse_metadata(value=value, is_sequence_container=is_sequence_container, extra=extra)) - return constraints - - -def _create_metadata_from_type( - metadata: Sequence[Any], model: type[T], annotation: Any, extra: dict[str, Any] | None -) -> tuple[T | None, dict[str, Any]]: - is_sequence_container = is_non_string_sequence(annotation) - result = _traverse_metadata(metadata=metadata, is_sequence_container=is_sequence_container, extra=extra) - - constraints = {k: v for k, v in result.items() if k in dir(model)} - extra = {k: v for k, v in result.items() if k not in constraints} - return model(**constraints) if constraints else None, extra - - -@dataclass(frozen=True) -class FieldDefinition: - """Represents a function parameter or type annotation.""" - - __slots__ = ( - "annotation", - "args", - "default", - "extra", - "inner_types", - "instantiable_origin", - "kwarg_definition", - "metadata", - "name", - "origin", - "raw", - "safe_generic_origin", - "type_wrappers", - ) - - raw: Any - """The annotation exactly as received.""" - annotation: Any - """The annotation with any "wrapper" types removed, e.g. Annotated.""" - type_wrappers: tuple[type, ...] - """A set of all "wrapper" types, e.g. Annotated.""" - origin: Any - """The result of calling ``get_origin(annotation)`` after unwrapping Annotated, e.g. list.""" - args: tuple[Any, ...] - """The result of calling ``get_args(annotation)`` after unwrapping Annotated, e.g. (int,).""" - metadata: tuple[Any, ...] - """Any metadata associated with the annotation via ``Annotated``.""" - instantiable_origin: Any - """An equivalent type to ``origin`` that can be safely instantiated. E.g., ``Sequence`` -> ``list``.""" - safe_generic_origin: Any - """An equivalent type to ``origin`` that can be safely used as a generic type across all supported Python versions. - - This is to serve safely rebuilding a generic outer type with different args at runtime. - """ - inner_types: tuple[FieldDefinition, ...] - """The type's generic args parsed as ``FieldDefinition``, if applicable.""" - default: Any - """Default value of the field.""" - extra: dict[str, Any] - """A mapping of extra values.""" - kwarg_definition: KwargDefinition | DependencyKwarg | None - """Kwarg Parameter.""" - name: str - """Field name.""" - - def __deepcopy__(self, memo: dict[str, Any]) -> Self: - return type(self)(**{attr: deepcopy(getattr(self, attr)) for attr in self.__slots__}) - - def __eq__(self, other: Any) -> bool: - if not isinstance(other, FieldDefinition): - return False - - if self.origin: - return self.origin == other.origin and self.inner_types == other.inner_types - - return self.annotation == other.annotation # type: ignore[no-any-return] - - def __hash__(self) -> int: - return hash((self.name, self.raw, self.annotation, self.origin, self.inner_types)) - - @classmethod - def _extract_metadata( - cls, annotation: Any, name: str | None, default: Any, metadata: tuple[Any, ...], extra: dict[str, Any] | None - ) -> tuple[KwargDefinition | None, dict[str, Any]]: - model = BodyKwarg if name == "data" else ParameterKwarg - - for extractor in _KWARG_META_EXTRACTORS: - if extractor.matches(annotation=annotation, name=name, default=default): - return _create_metadata_from_type( - extractor.extract(annotation=annotation, default=default), - model=model, - annotation=annotation, - extra=extra, - ) - - if any(isinstance(arg, KwargDefinition) for arg in get_args(annotation)): - return next(arg for arg in get_args(annotation) if isinstance(arg, KwargDefinition)), extra or {} - - if metadata: - return _create_metadata_from_type(metadata=metadata, model=model, annotation=annotation, extra=extra) - - return None, {} - - @property - def has_default(self) -> bool: - """Check if the field has a default value. - - Returns: - True if the default is not Empty or Ellipsis otherwise False. - """ - return self.default is not Empty and self.default is not Ellipsis - - @property - def is_non_string_iterable(self) -> bool: - """Check if the field type is an Iterable. - - If ``self.annotation`` is an optional union, only the non-optional members of the union are evaluated. - - See: https://github.com/litestar-org/litestar/issues/1106 - """ - annotation = self.annotation - if self.is_optional: - annotation = make_non_optional_union(annotation) - return is_non_string_iterable(annotation) - - @property - def is_non_string_sequence(self) -> bool: - """Check if the field type is a non-string Sequence. - - If ``self.annotation`` is an optional union, only the non-optional members of the union are evaluated. - - See: https://github.com/litestar-org/litestar/issues/1106 - """ - annotation = self.annotation - if self.is_optional: - annotation = make_non_optional_union(annotation) - return is_non_string_sequence(annotation) - - @property - def is_any(self) -> bool: - """Check if the field type is Any.""" - return is_any(self.annotation) - - @property - def is_generic(self) -> bool: - """Check if the field type is a custom class extending Generic.""" - return is_generic(self.annotation) - - @property - def is_simple_type(self) -> bool: - """Check if the field type is a singleton value (e.g. int, str etc.).""" - return not ( - self.is_generic or self.is_optional or self.is_union or self.is_mapping or self.is_non_string_iterable - ) - - @property - def is_parameter_field(self) -> bool: - """Check if the field type is a parameter kwarg value.""" - return isinstance(self.kwarg_definition, ParameterKwarg) - - @property - def is_const(self) -> bool: - """Check if the field is defined as constant value.""" - return bool(self.kwarg_definition and getattr(self.kwarg_definition, "const", False)) - - @property - def is_required(self) -> bool: - """Check if the field should be marked as a required parameter.""" - if Required in self.type_wrappers: # type: ignore[comparison-overlap] - return True - - if NotRequired in self.type_wrappers or UnsetType in self.args: # type: ignore[comparison-overlap] - return False - - if isinstance(self.kwarg_definition, ParameterKwarg) and self.kwarg_definition.required is not None: - return self.kwarg_definition.required - - return not self.is_optional and not self.is_any and (not self.has_default or self.default is None) - - @property - def is_annotated(self) -> bool: - """Check if the field type is Annotated.""" - return bool(self.metadata) - - @property - def is_literal(self) -> bool: - """Check if the field type is Literal.""" - return self.origin is Literal - - @property - def is_forward_ref(self) -> bool: - """Whether the annotation is a forward reference or not.""" - return isinstance(self.annotation, (str, ForwardRef)) - - @property - def is_mapping(self) -> bool: - """Whether the annotation is a mapping or not.""" - return self.is_subclass_of(Mapping) - - @property - def is_tuple(self) -> bool: - """Whether the annotation is a ``tuple`` or not.""" - return self.is_subclass_of(tuple) - - @property - def is_type_var(self) -> bool: - """Whether the annotation is a TypeVar or not.""" - return isinstance(self.annotation, TypeVar) - - @property - def is_union(self) -> bool: - """Whether the annotation is a union type or not.""" - return self.origin in UnionTypes - - @property - def is_optional(self) -> bool: - """Whether the annotation is Optional or not.""" - return bool(self.is_union and NoneType in self.args) - - @property - def is_none_type(self) -> bool: - """Whether the annotation is NoneType or not.""" - return self.annotation is NoneType - - @property - def is_collection(self) -> bool: - """Whether the annotation is a collection type or not.""" - return self.is_subclass_of(Collection) - - @property - def is_non_string_collection(self) -> bool: - """Whether the annotation is a non-string collection type or not.""" - return self.is_collection and not self.is_subclass_of((str, bytes)) - - @property - def bound_types(self) -> tuple[FieldDefinition, ...] | None: - """A tuple of bound types - if the annotation is a TypeVar with bound types, otherwise None.""" - if self.is_type_var and (bound := getattr(self.annotation, "__bound__", None)): - if is_union(bound): - return tuple(FieldDefinition.from_annotation(t) for t in get_args(bound)) - return (FieldDefinition.from_annotation(bound),) - return None - - @property - def generic_types(self) -> tuple[FieldDefinition, ...] | None: - """A tuple of generic types passed into the annotation - if its generic.""" - if not (bases := getattr(self.annotation, "__orig_bases__", None)): - return None - args: list[FieldDefinition] = [] - for base_args in [getattr(base, "__args__", ()) for base in bases]: - for arg in base_args: - field_definition = FieldDefinition.from_annotation(arg) - if field_definition.generic_types: - args.extend(field_definition.generic_types) - else: - args.append(field_definition) - return tuple(args) - - @property - def is_dataclass_type(self) -> bool: - """Whether the annotation is a dataclass type or not.""" - - return is_dataclass(cast("type", self.origin or self.annotation)) - - @property - def is_typeddict_type(self) -> bool: - """Whether the type is TypedDict or not.""" - - return is_typeddict(self.origin or self.annotation) - - @property - def type_(self) -> Any: - """The type of the annotation with all the wrappers removed, including the generic types.""" - - return self.origin or self.annotation - - def is_subclass_of(self, cl: type[Any] | tuple[type[Any], ...]) -> bool: - """Whether the annotation is a subclass of the given type. - - Where ``self.annotation`` is a union type, this method will return ``True`` when all members of the union are - a subtype of ``cl``, otherwise, ``False``. - - Args: - cl: The type to check, or tuple of types. Passed as 2nd argument to ``issubclass()``. - - Returns: - Whether the annotation is a subtype of the given type(s). - """ - if self.origin: - if self.origin in UnionTypes: - return all(t.is_subclass_of(cl) for t in self.inner_types) - - return self.origin not in UnionTypes and is_class_and_subclass(self.origin, cl) - - if self.annotation is AnyStr: - return is_class_and_subclass(str, cl) or is_class_and_subclass(bytes, cl) - - return self.annotation is not Any and not self.is_type_var and is_class_and_subclass(self.annotation, cl) - - def has_inner_subclass_of(self, cl: type[Any] | tuple[type[Any], ...]) -> bool: - """Whether any generic args are a subclass of the given type. - - Args: - cl: The type to check, or tuple of types. Passed as 2nd argument to ``issubclass()``. - - Returns: - Whether any of the type's generic args are a subclass of the given type. - """ - return any(t.is_subclass_of(cl) for t in self.inner_types) - - def get_type_hints(self, *, include_extras: bool = False, resolve_generics: bool = False) -> dict[str, Any]: - """Get the type hints for the annotation. - - Args: - include_extras: Flag to indicate whether to include ``Annotated[T, ...]`` or not. - resolve_generics: Flag to indicate whether to resolve the generic types in the type hints or not. - - Returns: - The type hints. - """ - - if self.origin is not None or self.is_generic: - if resolve_generics: - return get_type_hints_with_generics_resolved(self.annotation, include_extras=include_extras) - return get_type_hints(self.origin or self.annotation, include_extras=include_extras) - - return get_type_hints(self.annotation, include_extras=include_extras) - - @classmethod - def from_annotation(cls, annotation: Any, **kwargs: Any) -> FieldDefinition: - """Initialize FieldDefinition. - - Args: - annotation: The type annotation. This should be extracted from the return of - ``get_type_hints(..., include_extras=True)`` so that forward references are resolved and recursive - ``Annotated`` types are flattened. - **kwargs: Additional keyword arguments to pass to the ``FieldDefinition`` constructor. - - Returns: - FieldDefinition - """ - - unwrapped, metadata, wrappers = unwrap_annotation(annotation if annotation is not Empty else Any) - origin = get_origin(unwrapped) - - args = () if origin is abc.Callable else get_args(unwrapped) - - if not kwargs.get("kwarg_definition"): - if isinstance(kwargs.get("default"), (KwargDefinition, DependencyKwarg)): - kwargs["kwarg_definition"] = kwargs.pop("default") - elif any(isinstance(v, (KwargDefinition, DependencyKwarg)) for v in metadata): - kwargs["kwarg_definition"] = next( # pragma: no cover - # see https://github.com/nedbat/coveragepy/issues/475 - v - for v in metadata - if isinstance(v, (KwargDefinition, DependencyKwarg)) - ) - metadata = tuple(v for v in metadata if not isinstance(v, (KwargDefinition, DependencyKwarg))) - elif (extra := kwargs.get("extra", {})) and "kwarg_definition" in extra: - kwargs["kwarg_definition"] = extra.pop("kwarg_definition") - else: - kwargs["kwarg_definition"], kwargs["extra"] = cls._extract_metadata( - annotation=annotation, - name=kwargs.get("name", ""), - default=kwargs.get("default", Empty), - metadata=metadata, - extra=kwargs.get("extra"), - ) - - kwargs.setdefault("annotation", unwrapped) - kwargs.setdefault("args", args) - kwargs.setdefault("default", Empty) - kwargs.setdefault("extra", {}) - kwargs.setdefault("inner_types", tuple(FieldDefinition.from_annotation(arg) for arg in args)) - kwargs.setdefault("instantiable_origin", get_instantiable_origin(origin, unwrapped)) - kwargs.setdefault("kwarg_definition", None) - kwargs.setdefault("metadata", metadata) - kwargs.setdefault("name", "") - kwargs.setdefault("origin", origin) - kwargs.setdefault("raw", annotation) - kwargs.setdefault("safe_generic_origin", get_safe_generic_origin(origin, unwrapped)) - kwargs.setdefault("type_wrappers", wrappers) - - instance = FieldDefinition(**kwargs) - if not instance.has_default and instance.kwarg_definition: - return replace(instance, default=instance.kwarg_definition.default) - - return instance - - @classmethod - def from_kwarg( - cls, - annotation: Any, - name: str, - default: Any = Empty, - inner_types: tuple[FieldDefinition, ...] | None = None, - kwarg_definition: KwargDefinition | DependencyKwarg | None = None, - extra: dict[str, Any] | None = None, - ) -> FieldDefinition: - """Create a new FieldDefinition instance. - - Args: - annotation: The type of the kwarg. - name: Field name. - default: A default value. - inner_types: A tuple of FieldDefinition instances representing the inner types, if any. - kwarg_definition: Kwarg Parameter. - extra: A mapping of extra values. - - Returns: - FieldDefinition instance. - """ - - return cls.from_annotation( - annotation, - name=name, - default=default, - **{ - k: v - for k, v in { - "inner_types": inner_types, - "kwarg_definition": kwarg_definition, - "extra": extra, - }.items() - if v is not None - }, - ) - - @classmethod - def from_parameter(cls, parameter: Parameter, fn_type_hints: dict[str, Any]) -> FieldDefinition: - """Initialize ParsedSignatureParameter. - - Args: - parameter: inspect.Parameter - fn_type_hints: mapping of names to types. Should be result of ``get_type_hints()``, preferably via the - :attr:``get_fn_type_hints() <.utils.signature_parsing.get_fn_type_hints>`` helper. - - Returns: - ParsedSignatureParameter. - - """ - from litestar.datastructures import ImmutableState - - try: - annotation = fn_type_hints[parameter.name] - except KeyError as e: - raise ImproperlyConfiguredException( - f"'{parameter.name}' does not have a type annotation. If it should receive any value, use 'Any'." - ) from e - - if parameter.name == "state" and not issubclass(annotation, ImmutableState): - raise ImproperlyConfiguredException( - f"The type annotation `{annotation}` is an invalid type for the 'state' reserved kwarg. " - "It must be typed to a subclass of `litestar.datastructures.ImmutableState` or " - "`litestar.datastructures.State`." - ) - - return FieldDefinition.from_kwarg( - annotation=annotation, - name=parameter.name, - default=Empty if parameter.default is Signature.empty else parameter.default, - ) - - def match_predicate_recursively(self, predicate: Callable[[FieldDefinition], bool]) -> bool: - """Recursively test the passed in predicate against the field and any of its inner fields. - - Args: - predicate: A callable that receives a field definition instance as an arg and returns a boolean. - - Returns: - A boolean. - """ - return predicate(self) or any(t.match_predicate_recursively(predicate) for t in self.inner_types) diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__init__.py b/venv/lib/python3.11/site-packages/litestar/utils/__init__.py deleted file mode 100644 index 3f62792..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/__init__.py +++ /dev/null @@ -1,86 +0,0 @@ -from typing import Any - -from litestar.utils.deprecation import deprecated, warn_deprecation - -from .helpers import get_enum_string_value, get_name, unique_name_for_scope, url_quote -from .path import join_paths, normalize_path -from .predicates import ( - _is_sync_or_async_generator, - is_annotated_type, - is_any, - is_async_callable, - is_attrs_class, - is_class_and_subclass, - is_class_var, - is_dataclass_class, - is_dataclass_instance, - is_generic, - is_mapping, - is_non_string_iterable, - is_non_string_sequence, - is_optional_union, - is_undefined_sentinel, - is_union, -) -from .scope import ( # type: ignore[attr-defined] - _delete_litestar_scope_state, - _get_litestar_scope_state, - _set_litestar_scope_state, - get_serializer_from_scope, -) -from .sequence import find_index, unique -from .sync import AsyncIteratorWrapper, ensure_async_callable -from .typing import get_origin_or_inner_type, make_non_optional_union - -__all__ = ( - "ensure_async_callable", - "AsyncIteratorWrapper", - "deprecated", - "find_index", - "get_enum_string_value", - "get_name", - "get_origin_or_inner_type", - "get_serializer_from_scope", - "is_annotated_type", - "is_any", - "is_async_callable", - "is_attrs_class", - "is_class_and_subclass", - "is_class_var", - "is_dataclass_class", - "is_dataclass_instance", - "is_generic", - "is_mapping", - "is_non_string_iterable", - "is_non_string_sequence", - "is_optional_union", - "is_undefined_sentinel", - "is_union", - "join_paths", - "make_non_optional_union", - "normalize_path", - "unique", - "unique_name_for_scope", - "url_quote", - "warn_deprecation", -) - -_deprecated_names = { - "get_litestar_scope_state": _get_litestar_scope_state, - "set_litestar_scope_state": _set_litestar_scope_state, - "delete_litestar_scope_state": _delete_litestar_scope_state, - "is_sync_or_async_generator": _is_sync_or_async_generator, -} - - -def __getattr__(name: str) -> Any: - if name in _deprecated_names: - warn_deprecation( - deprecated_name=f"litestar.utils.{name}", - version="2.4", - kind="import", - removal_in="3.0", - info=f"'litestar.utils.{name}' is deprecated.", - ) - return globals()["_deprecated_names"][name] - raise AttributeError(f"module {__name__!r} has no attribute {name!r}") # pragma: no cover diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index da9ad02..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/compat.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/compat.cpython-311.pyc deleted file mode 100644 index 39d39d6..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/compat.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/dataclass.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/dataclass.cpython-311.pyc deleted file mode 100644 index addf140..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/dataclass.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/deprecation.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/deprecation.cpython-311.pyc deleted file mode 100644 index ddf3b7c..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/deprecation.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/empty.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/empty.cpython-311.pyc deleted file mode 100644 index 2b358ad..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/empty.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/helpers.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/helpers.cpython-311.pyc deleted file mode 100644 index 9db59c4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/helpers.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/module_loader.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/module_loader.cpython-311.pyc deleted file mode 100644 index f32ca7e..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/module_loader.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/path.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/path.cpython-311.pyc deleted file mode 100644 index 6602b02..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/path.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/predicates.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/predicates.cpython-311.pyc deleted file mode 100644 index 983250b..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/predicates.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sequence.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sequence.cpython-311.pyc deleted file mode 100644 index b2f8c1a..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sequence.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/signature.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/signature.cpython-311.pyc deleted file mode 100644 index d81050f..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/signature.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sync.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sync.cpython-311.pyc deleted file mode 100644 index 8a18dfb..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/sync.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/typing.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/typing.cpython-311.pyc deleted file mode 100644 index 53db129..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/typing.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/version.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/version.cpython-311.pyc deleted file mode 100644 index f656ef4..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/version.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/warnings.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/warnings.cpython-311.pyc deleted file mode 100644 index 3fa1cf1..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/__pycache__/warnings.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/compat.py b/venv/lib/python3.11/site-packages/litestar/utils/compat.py deleted file mode 100644 index 384db76..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/compat.py +++ /dev/null @@ -1,27 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, TypeVar - -from litestar.types import Empty, EmptyType - -__all__ = ("async_next",) - - -if TYPE_CHECKING: - from typing import Any, AsyncGenerator - -T = TypeVar("T") -D = TypeVar("D") - -try: - async_next = anext # type: ignore[name-defined] -except NameError: - - async def async_next(gen: AsyncGenerator[T, Any], default: D | EmptyType = Empty) -> T | D: - """Backwards compatibility shim for Python<3.10.""" - try: - return await gen.__anext__() - except StopAsyncIteration as exc: - if default is not Empty: - return default - raise exc diff --git a/venv/lib/python3.11/site-packages/litestar/utils/dataclass.py b/venv/lib/python3.11/site-packages/litestar/utils/dataclass.py deleted file mode 100644 index 597465d..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/dataclass.py +++ /dev/null @@ -1,115 +0,0 @@ -from __future__ import annotations - -from dataclasses import Field, fields -from typing import TYPE_CHECKING - -from litestar.types import Empty -from litestar.utils.predicates import is_dataclass_instance - -if TYPE_CHECKING: - from typing import AbstractSet, Any, Iterable - - from litestar.types.protocols import DataclassProtocol - -__all__ = ( - "extract_dataclass_fields", - "extract_dataclass_items", - "simple_asdict", -) - - -def extract_dataclass_fields( - dt: DataclassProtocol, - exclude_none: bool = False, - exclude_empty: bool = False, - include: AbstractSet[str] | None = None, - exclude: AbstractSet[str] | None = None, -) -> tuple[Field[Any], ...]: - """Extract dataclass fields. - - Args: - dt: A dataclass instance. - exclude_none: Whether to exclude None values. - exclude_empty: Whether to exclude Empty values. - include: An iterable of fields to include. - exclude: An iterable of fields to exclude. - - - Returns: - A tuple of dataclass fields. - """ - include = include or set() - exclude = exclude or set() - - if common := (include & exclude): - raise ValueError(f"Fields {common} are both included and excluded.") - - dataclass_fields: Iterable[Field[Any]] = fields(dt) - if exclude_none: - dataclass_fields = (field for field in dataclass_fields if getattr(dt, field.name) is not None) - if exclude_empty: - dataclass_fields = (field for field in dataclass_fields if getattr(dt, field.name) is not Empty) - if include: - dataclass_fields = (field for field in dataclass_fields if field.name in include) - if exclude: - dataclass_fields = (field for field in dataclass_fields if field.name not in exclude) - - return tuple(dataclass_fields) - - -def extract_dataclass_items( - dt: DataclassProtocol, - exclude_none: bool = False, - exclude_empty: bool = False, - include: AbstractSet[str] | None = None, - exclude: AbstractSet[str] | None = None, -) -> tuple[tuple[str, Any], ...]: - """Extract dataclass name, value pairs. - - Unlike the 'asdict' method exports by the stlib, this function does not pickle values. - - Args: - dt: A dataclass instance. - exclude_none: Whether to exclude None values. - exclude_empty: Whether to exclude Empty values. - include: An iterable of fields to include. - exclude: An iterable of fields to exclude. - - Returns: - A tuple of key/value pairs. - """ - dataclass_fields = extract_dataclass_fields(dt, exclude_none, exclude_empty, include, exclude) - return tuple((field.name, getattr(dt, field.name)) for field in dataclass_fields) - - -def simple_asdict( - obj: DataclassProtocol, - exclude_none: bool = False, - exclude_empty: bool = False, - convert_nested: bool = True, - exclude: set[str] | None = None, -) -> dict[str, Any]: - """Convert a dataclass to a dictionary. - - This method has important differences to the standard library version: - - it does not deepcopy values - - it does not recurse into collections - - Args: - obj: A dataclass instance. - exclude_none: Whether to exclude None values. - exclude_empty: Whether to exclude Empty values. - convert_nested: Whether to recursively convert nested dataclasses. - exclude: An iterable of fields to exclude. - - Returns: - A dictionary of key/value pairs. - """ - ret = {} - for field in extract_dataclass_fields(obj, exclude_none, exclude_empty, exclude=exclude): - value = getattr(obj, field.name) - if is_dataclass_instance(value) and convert_nested: - ret[field.name] = simple_asdict(value, exclude_none, exclude_empty) - else: - ret[field.name] = getattr(obj, field.name) - return ret diff --git a/venv/lib/python3.11/site-packages/litestar/utils/deprecation.py b/venv/lib/python3.11/site-packages/litestar/utils/deprecation.py deleted file mode 100644 index b1b8725..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/deprecation.py +++ /dev/null @@ -1,111 +0,0 @@ -from __future__ import annotations - -import inspect -from functools import wraps -from typing import Callable, Literal, TypeVar -from warnings import warn - -from typing_extensions import ParamSpec - -__all__ = ("deprecated", "warn_deprecation") - - -T = TypeVar("T") -P = ParamSpec("P") -DeprecatedKind = Literal["function", "method", "classmethod", "attribute", "property", "class", "parameter", "import"] - - -def warn_deprecation( - version: str, - deprecated_name: str, - kind: DeprecatedKind, - *, - removal_in: str | None = None, - alternative: str | None = None, - info: str | None = None, - pending: bool = False, -) -> None: - """Warn about a call to a (soon to be) deprecated function. - - Args: - version: Litestar version where the deprecation will occur - deprecated_name: Name of the deprecated function - removal_in: Litestar version where the deprecated function will be removed - alternative: Name of a function that should be used instead - info: Additional information - pending: Use ``PendingDeprecationWarning`` instead of ``DeprecationWarning`` - kind: Type of the deprecated thing - """ - parts = [] - - if kind == "import": - access_type = "Import of" - elif kind in {"function", "method"}: - access_type = "Call to" - else: - access_type = "Use of" - - if pending: - parts.append(f"{access_type} {kind} awaiting deprecation {deprecated_name!r}") - else: - parts.append(f"{access_type} deprecated {kind} {deprecated_name!r}") - - parts.extend( - ( - f"Deprecated in litestar {version}", - f"This {kind} will be removed in {removal_in or 'the next major version'}", - ) - ) - if alternative: - parts.append(f"Use {alternative!r} instead") - - if info: - parts.append(info) - - text = ". ".join(parts) - warning_class = PendingDeprecationWarning if pending else DeprecationWarning - - warn(text, warning_class, stacklevel=2) - - -def deprecated( - version: str, - *, - removal_in: str | None = None, - alternative: str | None = None, - info: str | None = None, - pending: bool = False, - kind: Literal["function", "method", "classmethod", "property"] | None = None, -) -> Callable[[Callable[P, T]], Callable[P, T]]: - """Create a decorator wrapping a function, method or property with a warning call about a (pending) deprecation. - - Args: - version: Litestar version where the deprecation will occur - removal_in: Litestar version where the deprecated function will be removed - alternative: Name of a function that should be used instead - info: Additional information - pending: Use ``PendingDeprecationWarning`` instead of ``DeprecationWarning`` - kind: Type of the deprecated callable. If ``None``, will use ``inspect`` to figure - out if it's a function or method - - Returns: - A decorator wrapping the function call with a warning - """ - - def decorator(func: Callable[P, T]) -> Callable[P, T]: - @wraps(func) - def wrapped(*args: P.args, **kwargs: P.kwargs) -> T: - warn_deprecation( - version=version, - deprecated_name=func.__name__, - info=info, - alternative=alternative, - pending=pending, - removal_in=removal_in, - kind=kind or ("method" if inspect.ismethod(func) else "function"), - ) - return func(*args, **kwargs) - - return wrapped - - return decorator diff --git a/venv/lib/python3.11/site-packages/litestar/utils/empty.py b/venv/lib/python3.11/site-packages/litestar/utils/empty.py deleted file mode 100644 index cdde871..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/empty.py +++ /dev/null @@ -1,26 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, TypeVar - -from litestar.types.empty import Empty - -if TYPE_CHECKING: - from litestar.types.empty import EmptyType - -ValueT = TypeVar("ValueT") -DefaultT = TypeVar("DefaultT") - - -def value_or_default(value: ValueT | EmptyType, default: DefaultT) -> ValueT | DefaultT: - """Return `value` handling the case where it is empty. - - If `value` is `Empty`, `default` is returned. - - Args: - value: The value to check. - default: The default value to return if `value` is `Empty`. - - Returns: - The value or default value. - """ - return default if value is Empty else value diff --git a/venv/lib/python3.11/site-packages/litestar/utils/helpers.py b/venv/lib/python3.11/site-packages/litestar/utils/helpers.py deleted file mode 100644 index c25fe35..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/helpers.py +++ /dev/null @@ -1,103 +0,0 @@ -from __future__ import annotations - -from enum import Enum -from functools import partial -from typing import TYPE_CHECKING, TypeVar, cast -from urllib.parse import quote - -from litestar.utils.typing import get_origin_or_inner_type - -if TYPE_CHECKING: - from collections.abc import Container - - from litestar.types import MaybePartial - -__all__ = ( - "get_enum_string_value", - "get_name", - "unwrap_partial", - "url_quote", - "unique_name_for_scope", -) - -T = TypeVar("T") - - -def get_name(value: object) -> str: - """Get the ``__name__`` of an object. - - Args: - value: An arbitrary object. - - Returns: - A name string. - """ - - name = getattr(value, "__name__", None) - if name is not None: - return cast("str", name) - - # On Python 3.8 and 3.9, Foo[int] does not have the __name__ attribute. - if origin := get_origin_or_inner_type(value): - return cast("str", origin.__name__) - - return type(value).__name__ - - -def get_enum_string_value(value: Enum | str) -> str: - """Return the string value of a string enum. - - See: https://github.com/litestar-org/litestar/pull/633#issuecomment-1286519267 - - Args: - value: An enum or string. - - Returns: - A string. - """ - return value.value if isinstance(value, Enum) else value # type: ignore[no-any-return] - - -def unwrap_partial(value: MaybePartial[T]) -> T: - """Unwraps a partial, returning the underlying callable. - - Args: - value: A partial function. - - Returns: - Callable - """ - from litestar.utils.sync import AsyncCallable - - return cast("T", value.func if isinstance(value, (partial, AsyncCallable)) else value) - - -def url_quote(value: str | bytes) -> str: - """Quote a URL. - - Args: - value: A URL. - - Returns: - A quoted URL. - """ - return quote(value, safe="/#%[]=:;$&()+,!?*@'~") - - -def unique_name_for_scope(base_name: str, scope: Container[str]) -> str: - """Create a name derived from ``base_name`` that's unique within ``scope``""" - i = 0 - while True: - if (unique_name := f"{base_name}_{i}") not in scope: - return unique_name - i += 1 - - -def get_exception_group() -> type[BaseException]: - """Get the exception group class with version compatibility.""" - try: - return cast("type[BaseException]", ExceptionGroup) # type:ignore[name-defined] - except NameError: - from exceptiongroup import ExceptionGroup as _ExceptionGroup # pyright: ignore - - return cast("type[BaseException]", _ExceptionGroup) diff --git a/venv/lib/python3.11/site-packages/litestar/utils/module_loader.py b/venv/lib/python3.11/site-packages/litestar/utils/module_loader.py deleted file mode 100644 index 09dbf9f..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/module_loader.py +++ /dev/null @@ -1,92 +0,0 @@ -"""General utility functions.""" - -from __future__ import annotations - -import os.path -import sys -from importlib import import_module -from importlib.util import find_spec -from pathlib import Path -from typing import TYPE_CHECKING, Any - -if TYPE_CHECKING: - from types import ModuleType - -__all__ = ( - "import_string", - "module_to_os_path", -) - - -def module_to_os_path(dotted_path: str = "app") -> Path: - """Find Module to OS Path. - - Return a path to the base directory of the project or the module - specified by `dotted_path`. - - Args: - dotted_path: The path to the module. Defaults to "app". - - Raises: - TypeError: The module could not be found. - - Returns: - Path: The path to the module. - """ - try: - if (src := find_spec(dotted_path)) is None: # pragma: no cover - raise TypeError(f"Couldn't find the path for {dotted_path}") - except ModuleNotFoundError as e: - raise TypeError(f"Couldn't find the path for {dotted_path}") from e - - return Path(str(src.origin).rsplit(os.path.sep + "__init__.py", maxsplit=1)[0]) - - -def import_string(dotted_path: str) -> Any: - """Dotted Path Import. - - Import a dotted module path and return the attribute/class designated by the - last name in the path. Raise ImportError if the import failed. - - Args: - dotted_path: The path of the module to import. - - Raises: - ImportError: Could not import the module. - - Returns: - object: The imported object. - """ - - def _is_loaded(module: ModuleType | None) -> bool: - spec = getattr(module, "__spec__", None) - initializing = getattr(spec, "_initializing", False) - return bool(module and spec and not initializing) - - def _cached_import(module_path: str, class_name: str) -> Any: - """Import and cache a class from a module. - - Args: - module_path: dotted path to module. - class_name: Class or function name. - - Returns: - object: The imported class or function - """ - # Check whether module is loaded and fully initialized. - module = sys.modules.get(module_path) - if not _is_loaded(module): - module = import_module(module_path) - return getattr(module, class_name) - - try: - module_path, class_name = dotted_path.rsplit(".", 1) - except ValueError as e: - msg = "%s doesn't look like a module path" - raise ImportError(msg, dotted_path) from e - - try: - return _cached_import(module_path, class_name) - except AttributeError as e: - msg = "Module '%s' does not define a '%s' attribute/class" - raise ImportError(msg, module_path, class_name) from e diff --git a/venv/lib/python3.11/site-packages/litestar/utils/path.py b/venv/lib/python3.11/site-packages/litestar/utils/path.py deleted file mode 100644 index 76b43af..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/path.py +++ /dev/null @@ -1,35 +0,0 @@ -from __future__ import annotations - -import re -from typing import Iterable - -__all__ = ("join_paths", "normalize_path") - - -multi_slash_pattern = re.compile("//+") - - -def normalize_path(path: str) -> str: - """Normalize a given path by ensuring it starts with a slash and does not end with a slash. - - Args: - path: Path string - - Returns: - Path string - """ - path = path.strip("/") - path = f"/{path}" - return multi_slash_pattern.sub("/", path) - - -def join_paths(paths: Iterable[str]) -> str: - """Normalize and joins path fragments. - - Args: - paths: An iterable of path fragments. - - Returns: - A normalized joined path string. - """ - return normalize_path("/".join(paths)) diff --git a/venv/lib/python3.11/site-packages/litestar/utils/predicates.py b/venv/lib/python3.11/site-packages/litestar/utils/predicates.py deleted file mode 100644 index 11d5f79..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/predicates.py +++ /dev/null @@ -1,339 +0,0 @@ -from __future__ import annotations - -from asyncio import iscoroutinefunction -from collections import defaultdict, deque -from collections.abc import Iterable as CollectionsIterable -from dataclasses import is_dataclass -from inspect import isasyncgenfunction, isclass, isgeneratorfunction -from typing import ( - TYPE_CHECKING, - Any, - Awaitable, - Callable, - ClassVar, - DefaultDict, - Deque, - Dict, - FrozenSet, - Generic, - Iterable, - List, - Mapping, - Optional, - Sequence, - Set, - Tuple, - TypeVar, -) - -from typing_extensions import ( - ParamSpec, - TypeGuard, - _AnnotatedAlias, - get_args, -) - -from litestar.constants import UNDEFINED_SENTINELS -from litestar.types import Empty -from litestar.types.builtin_types import NoneType, UnionTypes -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.helpers import unwrap_partial -from litestar.utils.typing import get_origin_or_inner_type - -if TYPE_CHECKING: - from litestar.types.callable_types import AnyGenerator - from litestar.types.protocols import DataclassProtocol - -try: - import attrs -except ImportError: - attrs = Empty # type: ignore[assignment] - -__all__ = ( - "is_annotated_type", - "is_any", - "is_async_callable", - "is_attrs_class", - "is_class_and_subclass", - "is_class_var", - "is_dataclass_class", - "is_dataclass_instance", - "is_generic", - "is_mapping", - "is_non_string_iterable", - "is_non_string_sequence", - "is_optional_union", - "is_undefined_sentinel", - "is_union", -) - -P = ParamSpec("P") -T = TypeVar("T") - - -def is_async_callable(value: Callable[P, T]) -> TypeGuard[Callable[P, Awaitable[T]]]: - """Extend :func:`asyncio.iscoroutinefunction` to additionally detect async :func:`functools.partial` objects and - class instances with ``async def __call__()`` defined. - - Args: - value: Any - - Returns: - Bool determining if type of ``value`` is an awaitable. - """ - value = unwrap_partial(value) - - return iscoroutinefunction(value) or ( - callable(value) and iscoroutinefunction(value.__call__) # type: ignore[operator] - ) - - -def is_dataclass_instance(obj: Any) -> TypeGuard[DataclassProtocol]: - """Check if an object is a dataclass instance. - - Args: - obj: An object to check. - - Returns: - True if the object is a dataclass instance. - """ - return hasattr(type(obj), "__dataclass_fields__") - - -def is_dataclass_class(annotation: Any) -> TypeGuard[type[DataclassProtocol]]: - """Wrap :func:`is_dataclass ` in a :data:`typing.TypeGuard`. - - Args: - annotation: tested to determine if instance or type of :class:`dataclasses.dataclass`. - - Returns: - ``True`` if instance or type of ``dataclass``. - """ - try: - origin = get_origin_or_inner_type(annotation) - annotation = origin or annotation - - return isclass(annotation) and is_dataclass(annotation) - except TypeError: # pragma: no cover - return False - - -def is_class_and_subclass(annotation: Any, type_or_type_tuple: type[T] | tuple[type[T], ...]) -> TypeGuard[type[T]]: - """Return ``True`` if ``value`` is a ``class`` and is a subtype of ``t_type``. - - See https://github.com/litestar-org/litestar/issues/367 - - Args: - annotation: The value to check if is class and subclass of ``t_type``. - type_or_type_tuple: Type used for :func:`issubclass` check of ``value`` - - Returns: - bool - """ - origin = get_origin_or_inner_type(annotation) - if not origin and not isclass(annotation): - return False - try: - return issubclass(origin or annotation, type_or_type_tuple) - except TypeError: # pragma: no cover - return False - - -def is_generic(annotation: Any) -> bool: - """Given a type annotation determine if the annotation is a generic class. - - Args: - annotation: A type. - - Returns: - True if the annotation is a subclass of :data:`Generic ` otherwise ``False``. - """ - return is_class_and_subclass(annotation, Generic) # type: ignore[arg-type] - - -def is_mapping(annotation: Any) -> TypeGuard[Mapping[Any, Any]]: - """Given a type annotation determine if the annotation is a mapping type. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type can be cast as :class:`Mapping `. - """ - _type = get_origin_or_inner_type(annotation) or annotation - return isclass(_type) and issubclass(_type, (dict, defaultdict, DefaultDict, Mapping)) - - -def is_non_string_iterable(annotation: Any) -> TypeGuard[Iterable[Any]]: - """Given a type annotation determine if the annotation is an iterable. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type can be cast as :class:`Iterable ` that is not a string. - """ - origin = get_origin_or_inner_type(annotation) - if not origin and not isclass(annotation): - return False - try: - return not issubclass(origin or annotation, (str, bytes)) and ( - issubclass(origin or annotation, (Iterable, CollectionsIterable, Dict, dict, Mapping)) - or is_non_string_sequence(annotation) - ) - except TypeError: # pragma: no cover - return False - - -def is_non_string_sequence(annotation: Any) -> TypeGuard[Sequence[Any]]: - """Given a type annotation determine if the annotation is a sequence. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type can be cast as :class`Sequence ` that is not a string. - """ - origin = get_origin_or_inner_type(annotation) - if not origin and not isclass(annotation): - return False - try: - return not issubclass(origin or annotation, (str, bytes)) and issubclass( - origin or annotation, - ( # type: ignore[arg-type] - Tuple, - List, - Set, - FrozenSet, - Deque, - Sequence, - list, - tuple, - deque, - set, - frozenset, - ), - ) - except TypeError: # pragma: no cover - return False - - -def is_any(annotation: Any) -> TypeGuard[Any]: - """Given a type annotation determine if the annotation is Any. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type is :data:`Any `. - """ - return ( - annotation is Any - or getattr(annotation, "_name", "") == "typing.Any" - or (get_origin_or_inner_type(annotation) in UnionTypes and Any in get_args(annotation)) - ) - - -def is_union(annotation: Any) -> bool: - """Given a type annotation determine if the annotation infers an optional union. - - Args: - annotation: A type. - - Returns: - A boolean determining whether the type is :data:`Union typing.Union>`. - """ - return get_origin_or_inner_type(annotation) in UnionTypes - - -def is_optional_union(annotation: Any) -> TypeGuard[Any | None]: - """Given a type annotation determine if the annotation infers an optional union. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type is :data:`Union typing.Union>` with a - None value or :data:`Optional ` which is equivalent. - """ - origin = get_origin_or_inner_type(annotation) - return origin is Optional or ( - get_origin_or_inner_type(annotation) in UnionTypes and NoneType in get_args(annotation) - ) - - -def is_attrs_class(annotation: Any) -> TypeGuard[type[attrs.AttrsInstance]]: # pyright: ignore - """Given a type annotation determine if the annotation is a class that includes an attrs attribute. - - Args: - annotation: A type. - - Returns: - A typeguard determining whether the type is an attrs class. - """ - return attrs.has(annotation) if attrs is not Empty else False # type: ignore[comparison-overlap] - - -def is_class_var(annotation: Any) -> bool: - """Check if the given annotation is a ClassVar. - - Args: - annotation: A type annotation - - Returns: - A boolean. - """ - annotation = get_origin_or_inner_type(annotation) or annotation - return annotation is ClassVar - - -def _is_sync_or_async_generator(obj: Any) -> TypeGuard[AnyGenerator]: - """Check if the given annotation is a sync or async generator. - - Args: - obj: type to be tested for sync or async generator. - - Returns: - A boolean. - """ - return isgeneratorfunction(obj) or isasyncgenfunction(obj) - - -def is_annotated_type(annotation: Any) -> bool: - """Check if the given annotation is an Annotated. - - Args: - annotation: A type annotation - - Returns: - A boolean. - """ - return isinstance(annotation, _AnnotatedAlias) and getattr(annotation, "__args__", None) is not None - - -def is_undefined_sentinel(value: Any) -> bool: - """Check if the given value is the undefined sentinel. - - Args: - value: A value to be tested for undefined sentinel. - - Returns: - A boolean. - """ - return any(v is value for v in UNDEFINED_SENTINELS) - - -_deprecated_names = {"is_sync_or_async_generator": _is_sync_or_async_generator} - - -def __getattr__(name: str) -> Any: - if name in _deprecated_names: - warn_deprecation( - deprecated_name=f"litestar.utils.scope.{name}", - version="2.4", - kind="import", - removal_in="3.0", - info=f"'litestar.utils.predicates.{name}' is deprecated.", - ) - return globals()["_deprecated_names"][name] - raise AttributeError(f"module {__name__!r} has no attribute {name!r}") # pragma: no cover diff --git a/venv/lib/python3.11/site-packages/litestar/utils/scope/__init__.py b/venv/lib/python3.11/site-packages/litestar/utils/scope/__init__.py deleted file mode 100644 index e5757d3..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/scope/__init__.py +++ /dev/null @@ -1,62 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING, Any - -from litestar.serialization import get_serializer -from litestar.utils.deprecation import warn_deprecation -from litestar.utils.scope.state import delete_litestar_scope_state as _delete_litestar_scope_state -from litestar.utils.scope.state import get_litestar_scope_state as _get_litestar_scope_state -from litestar.utils.scope.state import set_litestar_scope_state as _set_litestar_scope_state - -if TYPE_CHECKING: - from litestar.types import Scope, Serializer - -__all__ = ("get_serializer_from_scope",) - - -def get_serializer_from_scope(scope: Scope) -> Serializer: - """Return a serializer given a scope object. - - Args: - scope: The ASGI connection scope. - - Returns: - A serializer function - """ - route_handler = scope["route_handler"] - app = scope["app"] - - if hasattr(route_handler, "resolve_type_encoders"): - type_encoders = route_handler.resolve_type_encoders() - else: - type_encoders = app.type_encoders or {} - - if response_class := ( - route_handler.resolve_response_class() # pyright: ignore - if hasattr(route_handler, "resolve_response_class") - else app.response_class - ): - type_encoders = {**type_encoders, **(response_class.type_encoders or {})} - - return get_serializer(type_encoders) - - -_deprecated_names = { - "get_litestar_scope_state": _get_litestar_scope_state, - "set_litestar_scope_state": _set_litestar_scope_state, - "delete_litestar_scope_state": _delete_litestar_scope_state, -} - - -def __getattr__(name: str) -> Any: - if name in _deprecated_names: - warn_deprecation( - deprecated_name=f"litestar.utils.scope.{name}", - version="2.4", - kind="import", - removal_in="3.0", - info=f"'litestar.utils.scope.{name}' is deprecated. The Litestar scope state is private and should not be " - f"used. Plugin authors should maintain their own scope state namespace.", - ) - return globals()["_deprecated_names"][name] - raise AttributeError(f"module {__name__!r} has no attribute {name!r}") # pragma: no cover diff --git a/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/__init__.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/__init__.cpython-311.pyc deleted file mode 100644 index ee218d5..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/__init__.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/state.cpython-311.pyc b/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/state.cpython-311.pyc deleted file mode 100644 index 4615004..0000000 Binary files a/venv/lib/python3.11/site-packages/litestar/utils/scope/__pycache__/state.cpython-311.pyc and /dev/null differ diff --git a/venv/lib/python3.11/site-packages/litestar/utils/scope/state.py b/venv/lib/python3.11/site-packages/litestar/utils/scope/state.py deleted file mode 100644 index bed4394..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/scope/state.py +++ /dev/null @@ -1,158 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass -from typing import TYPE_CHECKING, Any, Final - -from litestar.types import Empty, EmptyType -from litestar.utils.empty import value_or_default - -if TYPE_CHECKING: - from typing_extensions import Self - - from litestar.datastructures import URL, Accept, Headers - from litestar.types.asgi_types import Scope - -CONNECTION_STATE_KEY: Final = "_ls_connection_state" - - -@dataclass -class ScopeState: - """An object for storing connection state. - - This is an internal API, and subject to change without notice. - - All types are a union with `EmptyType` and are seeded with the `Empty` value. - """ - - __slots__ = ( - "accept", - "base_url", - "body", - "content_type", - "cookies", - "csrf_token", - "dependency_cache", - "do_cache", - "form", - "headers", - "is_cached", - "json", - "log_context", - "msgpack", - "parsed_query", - "response_compressed", - "session_id", - "url", - "_compat_ns", - ) - - def __init__(self) -> None: - self.accept = Empty - self.base_url = Empty - self.body = Empty - self.content_type = Empty - self.cookies = Empty - self.csrf_token = Empty - self.dependency_cache = Empty - self.do_cache = Empty - self.form = Empty - self.headers = Empty - self.is_cached = Empty - self.json = Empty - self.log_context: dict[str, Any] = {} - self.msgpack = Empty - self.parsed_query = Empty - self.response_compressed = Empty - self.session_id = Empty - self.url = Empty - self._compat_ns: dict[str, Any] = {} - - accept: Accept | EmptyType - base_url: URL | EmptyType - body: bytes | EmptyType - content_type: tuple[str, dict[str, str]] | EmptyType - cookies: dict[str, str] | EmptyType - csrf_token: str | EmptyType - dependency_cache: dict[str, Any] | EmptyType - do_cache: bool | EmptyType - form: dict[str, str | list[str]] | EmptyType - headers: Headers | EmptyType - is_cached: bool | EmptyType - json: Any | EmptyType - log_context: dict[str, Any] - msgpack: Any | EmptyType - parsed_query: tuple[tuple[str, str], ...] | EmptyType - response_compressed: bool | EmptyType - session_id: str | None | EmptyType - url: URL | EmptyType - _compat_ns: dict[str, Any] - - @classmethod - def from_scope(cls, scope: Scope) -> Self: - """Create a new `ConnectionState` object from a scope. - - Object is cached in the scope's state under the `SCOPE_STATE_NAMESPACE` key. - - Args: - scope: The ASGI connection scope. - - Returns: - A `ConnectionState` object. - """ - base_scope_state = scope.setdefault("state", {}) - if (state := base_scope_state.get(CONNECTION_STATE_KEY)) is None: - state = base_scope_state[CONNECTION_STATE_KEY] = cls() - return state - - -def get_litestar_scope_state(scope: Scope, key: str, default: Any = None, pop: bool = False) -> Any: - """Get an internal value from connection scope state. - - Args: - scope: The connection scope. - key: Key to get from internal namespace in scope state. - default: Default value to return. - pop: Boolean flag dictating whether the value should be deleted from the state. - - Returns: - Value mapped to ``key`` in internal connection scope namespace. - """ - scope_state = ScopeState.from_scope(scope) - try: - val = value_or_default(getattr(scope_state, key), default) - if pop: - setattr(scope_state, key, Empty) - return val - except AttributeError: - if pop: - return scope_state._compat_ns.pop(key, default) - return scope_state._compat_ns.get(key, default) - - -def set_litestar_scope_state(scope: Scope, key: str, value: Any) -> None: - """Set an internal value in connection scope state. - - Args: - scope: The connection scope. - key: Key to set under internal namespace in scope state. - value: Value for key. - """ - scope_state = ScopeState.from_scope(scope) - if hasattr(scope_state, key): - setattr(scope_state, key, value) - else: - scope_state._compat_ns[key] = value - - -def delete_litestar_scope_state(scope: Scope, key: str) -> None: - """Delete an internal value from connection scope state. - - Args: - scope: The connection scope. - key: Key to set under internal namespace in scope state. - """ - scope_state = ScopeState.from_scope(scope) - if hasattr(scope_state, key): - setattr(scope_state, key, Empty) - else: - del scope_state._compat_ns[key] diff --git a/venv/lib/python3.11/site-packages/litestar/utils/sequence.py b/venv/lib/python3.11/site-packages/litestar/utils/sequence.py deleted file mode 100644 index 01ef1a8..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/sequence.py +++ /dev/null @@ -1,28 +0,0 @@ -from __future__ import annotations - -from typing import Callable, Sequence, TypeVar - -__all__ = ("find_index", "unique") - - -T = TypeVar("T") - - -def find_index(target_list: Sequence[T], predicate: Callable[[T], bool]) -> int: - """Find element in list given a key and value. - - List elements can be dicts or classes - """ - return next((i for i, element in enumerate(target_list) if predicate(element)), -1) - - -def unique(value: Sequence[T]) -> list[T]: - """Return all unique values in a given sequence or iterator.""" - try: - return list(set(value)) - except TypeError: - output: list[T] = [] - for element in value: - if element not in output: - output.append(element) - return output diff --git a/venv/lib/python3.11/site-packages/litestar/utils/signature.py b/venv/lib/python3.11/site-packages/litestar/utils/signature.py deleted file mode 100644 index eb58599..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/signature.py +++ /dev/null @@ -1,267 +0,0 @@ -from __future__ import annotations - -import sys -import typing -from copy import deepcopy -from dataclasses import dataclass, replace -from inspect import Signature, getmembers, isclass, ismethod -from itertools import chain -from typing import TYPE_CHECKING, Any, Union - -from typing_extensions import Annotated, Self, get_args, get_origin, get_type_hints - -from litestar import connection, datastructures, types -from litestar.exceptions import ImproperlyConfiguredException -from litestar.types import Empty -from litestar.typing import FieldDefinition -from litestar.utils.typing import unwrap_annotation - -if TYPE_CHECKING: - from typing import Sequence - - from litestar.types import AnyCallable - -if sys.version_info < (3, 11): - from typing import _get_defaults # type: ignore[attr-defined] -else: - - def _get_defaults(_: Any) -> Any: ... - - -__all__ = ( - "add_types_to_signature_namespace", - "get_fn_type_hints", - "ParsedSignature", -) - -_GLOBAL_NAMES = { - namespace: export - for namespace, export in chain( - tuple(getmembers(types)), tuple(getmembers(connection)), tuple(getmembers(datastructures)) - ) - if namespace[0].isupper() and namespace in chain(types.__all__, connection.__all__, datastructures.__all__) # pyright: ignore -} -"""A mapping of names used for handler signature forward-ref resolution. - -This allows users to include these names within an `if TYPE_CHECKING:` block in their handler module. -""" - - -def _unwrap_implicit_optional_hints(defaults: dict[str, Any], hints: dict[str, Any]) -> dict[str, Any]: - """Unwrap implicit optional hints. - - On Python<3.11, if a function parameter annotation has a ``None`` default, it is unconditionally wrapped in an - ``Optional`` type. - - If the annotation is not annotated, then any nested unions are flattened, e.g.,: - - .. code-block:: python - - def foo(a: Optional[Union[str, int]] = None): ... - - ...will become `Union[str, int, NoneType]`. - - However, if the annotation is annotated, then we end up with an optional union around the annotated type, e.g.,: - - .. code-block:: python - - def foo(a: Annotated[Optional[Union[str, int]], ...] = None): ... - - ... becomes `Union[Annotated[Union[str, int, NoneType], ...], NoneType]` - - This function makes the latter case consistent with the former by either removing the outer union if it is redundant - or flattening the union if it is not. The latter case would become `Annotated[Union[str, int, NoneType], ...]`. - - Args: - defaults: Mapping of names to default values. - hints: Mapping of names to types. - - Returns: - Mapping of names to types. - """ - - def _is_two_arg_optional(origin_: Any, args_: Any) -> bool: - """Check if a type is a two-argument optional type. - - If the type has been wrapped in `Optional` by `get_type_hints()` it will always be a union of a type and - `NoneType`. - - See: https://github.com/litestar-org/litestar/pull/2516 - """ - return origin_ is Union and len(args_) == 2 and args_[1] is type(None) - - def _is_any_optional(origin_: Any, args_: tuple[Any, ...]) -> bool: - """Detect if a type is a union with `NoneType`. - - After detecting that a type is a two-argument optional type, this function can be used to detect if the - inner type is a union with `NoneType` at all. - - We only want to perform the unwrapping of the optional union if the inner type is optional as well. - """ - return origin_ is Union and any(arg is type(None) for arg in args_) - - for name, default in defaults.items(): - if default is not None: - continue - - hint = hints[name] - origin = get_origin(hint) - args = get_args(hint) - - if _is_two_arg_optional(origin, args): - unwrapped_inner, meta, wrappers = unwrap_annotation(args[0]) - - if Annotated not in wrappers: - continue - - inner_args = get_args(unwrapped_inner) - - if not _is_any_optional(get_origin(unwrapped_inner), inner_args): - # this is where hint is like `Union[Annotated[Union[str, int], ...], NoneType]`, we add the outer union - # into the inner one, and re-wrap with Annotated - union_args = (*(inner_args or (unwrapped_inner,)), type(None)) - # calling `__class_getitem__` directly as in earlier py vers it is a syntax error to unpack into - # the getitem brackets, e.g., Annotated[T, *meta]. - hints[name] = Annotated.__class_getitem__((Union[union_args], *meta)) # type: ignore[attr-defined] - continue - - # this is where hint is like `Union[Annotated[Union[str, NoneType], ...], NoneType]`, we remove the - # redundant outer union - hints[name] = args[0] - return hints - - -def get_fn_type_hints(fn: Any, namespace: dict[str, Any] | None = None) -> dict[str, Any]: - """Resolve type hints for ``fn``. - - Args: - fn: Callable that is being inspected - namespace: Extra names for resolution of forward references. - - Returns: - Mapping of names to types. - """ - fn_to_inspect: Any = fn - - module_name = fn_to_inspect.__module__ - - if isclass(fn_to_inspect): - fn_to_inspect = fn_to_inspect.__init__ - - # detect objects that are not functions and that have a `__call__` method - if callable(fn_to_inspect) and ismethod(fn_to_inspect.__call__): - fn_to_inspect = fn_to_inspect.__call__ - - # inspect the underlying function for methods - if hasattr(fn_to_inspect, "__func__"): - fn_to_inspect = fn_to_inspect.__func__ - - # Order important. If a litestar name has been overridden in the function module, we want - # to use that instead of the litestar one. - namespace = { - **_GLOBAL_NAMES, - **vars(typing), - **vars(sys.modules[module_name]), - **(namespace or {}), - } - hints = get_type_hints(fn_to_inspect, globalns=namespace, include_extras=True) - - if sys.version_info < (3, 11): - # see https://github.com/litestar-org/litestar/pull/2516 - defaults = _get_defaults(fn_to_inspect) - hints = _unwrap_implicit_optional_hints(defaults, hints) - - return hints - - -@dataclass(frozen=True) -class ParsedSignature: - """Parsed signature. - - This object is the primary source of handler/dependency signature information. - - The only post-processing that occurs is the conversion of any forward referenced type annotations. - """ - - __slots__ = ("parameters", "return_type", "original_signature") - - parameters: dict[str, FieldDefinition] - """A mapping of parameter names to ParsedSignatureParameter instances.""" - return_type: FieldDefinition - """The return annotation of the callable.""" - original_signature: Signature - """The raw signature as returned by :func:`inspect.signature`""" - - def __deepcopy__(self, memo: dict[str, Any]) -> Self: - return type(self)( - parameters={k: deepcopy(v) for k, v in self.parameters.items()}, - return_type=deepcopy(self.return_type), - original_signature=deepcopy(self.original_signature), - ) - - @classmethod - def from_fn(cls, fn: AnyCallable, signature_namespace: dict[str, Any]) -> Self: - """Parse a function signature. - - Args: - fn: Any callable. - signature_namespace: mapping of names to types for forward reference resolution - - Returns: - ParsedSignature - """ - signature = Signature.from_callable(fn) - fn_type_hints = get_fn_type_hints(fn, namespace=signature_namespace) - - return cls.from_signature(signature, fn_type_hints) - - @classmethod - def from_signature(cls, signature: Signature, fn_type_hints: dict[str, type]) -> Self: - """Parse an :class:`inspect.Signature` instance. - - Args: - signature: An :class:`inspect.Signature` instance. - fn_type_hints: mapping of types - - Returns: - ParsedSignature - """ - - parameters = tuple( - FieldDefinition.from_parameter(parameter=parameter, fn_type_hints=fn_type_hints) - for name, parameter in signature.parameters.items() - if name not in ("self", "cls") - ) - - return_type = FieldDefinition.from_annotation(fn_type_hints.get("return", Any)) - - return cls( - parameters={p.name: p for p in parameters}, - return_type=return_type if "return" in fn_type_hints else replace(return_type, annotation=Empty), - original_signature=signature, - ) - - -def add_types_to_signature_namespace( - signature_types: Sequence[Any], signature_namespace: dict[str, Any] -) -> dict[str, Any]: - """Add types to ith signature namespace mapping. - - Types are added mapped to their `__name__` attribute. - - Args: - signature_types: A list of types to add to the signature namespace. - signature_namespace: The signature namespace to add types to. - - Raises: - ImproperlyConfiguredException: If a type is already defined in the signature namespace. - AttributeError: If a type does not have a `__name__` attribute. - - Returns: - The updated signature namespace. - """ - for typ in signature_types: - if (name := typ.__name__) in signature_namespace: - raise ImproperlyConfiguredException(f"Type '{name}' is already defined in the signature namespace") - signature_namespace[name] = typ - return signature_namespace diff --git a/venv/lib/python3.11/site-packages/litestar/utils/sync.py b/venv/lib/python3.11/site-packages/litestar/utils/sync.py deleted file mode 100644 index 02acabf..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/sync.py +++ /dev/null @@ -1,79 +0,0 @@ -from __future__ import annotations - -from typing import ( - AsyncGenerator, - Awaitable, - Callable, - Generic, - Iterable, - Iterator, - TypeVar, -) - -from typing_extensions import ParamSpec - -from litestar.concurrency import sync_to_thread -from litestar.utils.predicates import is_async_callable - -__all__ = ("ensure_async_callable", "AsyncIteratorWrapper", "AsyncCallable", "is_async_callable") - - -P = ParamSpec("P") -T = TypeVar("T") - - -def ensure_async_callable(fn: Callable[P, T]) -> Callable[P, Awaitable[T]]: - """Ensure that ``fn`` is an asynchronous callable. - If it is an asynchronous, return the original object, else wrap it in an - ``AsyncCallable`` - """ - if is_async_callable(fn): - return fn - return AsyncCallable(fn) # pyright: ignore - - -class AsyncCallable: - """Wrap a given callable to be called in a thread pool using - ``anyio.to_thread.run_sync``, keeping a reference to the original callable as - :attr:`func` - """ - - def __init__(self, fn: Callable[P, T]) -> None: # pyright: ignore - self.func = fn - - def __call__(self, *args: P.args, **kwargs: P.kwargs) -> Awaitable[T]: # pyright: ignore - return sync_to_thread(self.func, *args, **kwargs) # pyright: ignore - - -class AsyncIteratorWrapper(Generic[T]): - """Asynchronous generator, wrapping an iterable or iterator.""" - - __slots__ = ("iterator", "generator") - - def __init__(self, iterator: Iterator[T] | Iterable[T]) -> None: - """Take a sync iterator or iterable and yields values from it asynchronously. - - Args: - iterator: A sync iterator or iterable. - """ - self.iterator = iterator if isinstance(iterator, Iterator) else iter(iterator) - self.generator = self._async_generator() - - def _call_next(self) -> T: - try: - return next(self.iterator) - except StopIteration as e: - raise ValueError from e - - async def _async_generator(self) -> AsyncGenerator[T, None]: - while True: - try: - yield await sync_to_thread(self._call_next) - except ValueError: - return - - def __aiter__(self) -> AsyncIteratorWrapper[T]: - return self - - async def __anext__(self) -> T: - return await self.generator.__anext__() diff --git a/venv/lib/python3.11/site-packages/litestar/utils/typing.py b/venv/lib/python3.11/site-packages/litestar/utils/typing.py deleted file mode 100644 index 9da6c2a..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/typing.py +++ /dev/null @@ -1,284 +0,0 @@ -from __future__ import annotations - -import re -from collections import abc, defaultdict, deque -from typing import ( - AbstractSet, - Any, - AsyncGenerator, - AsyncIterable, - AsyncIterator, - Awaitable, - Collection, - Container, - Coroutine, - DefaultDict, - Deque, - Dict, - FrozenSet, - Generator, - ItemsView, - Iterable, - Iterator, - KeysView, - List, - Mapping, - MappingView, - MutableMapping, - MutableSequence, - MutableSet, - Reversible, - Sequence, - Set, - Tuple, - TypeVar, - Union, - ValuesView, - cast, -) - -from typing_extensions import Annotated, NotRequired, Required, get_args, get_origin, get_type_hints - -from litestar.types.builtin_types import NoneType, UnionTypes - -__all__ = ( - "get_instantiable_origin", - "get_origin_or_inner_type", - "get_safe_generic_origin", - "instantiable_type_mapping", - "make_non_optional_union", - "safe_generic_origin_map", - "unwrap_annotation", -) - - -T = TypeVar("T") -UnionT = TypeVar("UnionT", bound="Union") - -tuple_types_regex = re.compile( - "^" - + "|".join( - [*[repr(x) for x in (List, Sequence, Iterable, Iterator, Tuple, Deque)], "tuple", "list", "collections.deque"] - ) -) - -instantiable_type_mapping = { - AbstractSet: set, - DefaultDict: defaultdict, - Deque: deque, - Dict: dict, - FrozenSet: frozenset, - List: list, - Mapping: dict, - MutableMapping: dict, - MutableSequence: list, - MutableSet: set, - Sequence: list, - Set: set, - Tuple: tuple, - abc.Mapping: dict, - abc.MutableMapping: dict, - abc.MutableSequence: list, - abc.MutableSet: set, - abc.Sequence: list, - abc.Set: set, - defaultdict: defaultdict, - deque: deque, - dict: dict, - frozenset: frozenset, - list: list, - set: set, - tuple: tuple, -} - -safe_generic_origin_map = { - set: AbstractSet, - defaultdict: DefaultDict, - deque: Deque, - dict: Dict, - frozenset: FrozenSet, - list: List, - tuple: Tuple, - abc.Mapping: Mapping, - abc.MutableMapping: MutableMapping, - abc.MutableSequence: MutableSequence, - abc.MutableSet: MutableSet, - abc.Sequence: Sequence, - abc.Set: AbstractSet, - abc.Collection: Collection, - abc.Container: Container, - abc.ItemsView: ItemsView, - abc.KeysView: KeysView, - abc.MappingView: MappingView, - abc.ValuesView: ValuesView, - abc.Iterable: Iterable, - abc.Iterator: Iterator, - abc.Generator: Generator, - abc.Reversible: Reversible, - abc.Coroutine: Coroutine, - abc.AsyncGenerator: AsyncGenerator, - abc.AsyncIterable: AsyncIterable, - abc.AsyncIterator: AsyncIterator, - abc.Awaitable: Awaitable, - **{union_t: Union for union_t in UnionTypes}, -} -"""A mapping of types to equivalent types that are safe to be used as generics across all Python versions. - -This is necessary because occasionally we want to rebuild a generic outer type with different args, and types such as -``collections.abc.Mapping``, are not valid generic types in Python 3.8. -""" - -wrapper_type_set = {Annotated, Required, NotRequired} -"""Types that always contain a wrapped type annotation as their first arg.""" - - -def normalize_type_annotation(annotation: Any) -> Any: - """Normalize a type annotation to a standard form.""" - return instantiable_type_mapping.get(annotation, annotation) - - -def make_non_optional_union(annotation: UnionT | None) -> UnionT: - """Make a :data:`Union ` type that excludes ``NoneType``. - - Args: - annotation: A type annotation. - - Returns: - The union with all original members, except ``NoneType``. - """ - args = tuple(tp for tp in get_args(annotation) if tp is not NoneType) - return cast("UnionT", Union[args]) # pyright: ignore - - -def unwrap_annotation(annotation: Any) -> tuple[Any, tuple[Any, ...], set[Any]]: - """Remove "wrapper" annotation types, such as ``Annotated``, ``Required``, and ``NotRequired``. - - Note: - ``annotation`` should have been retrieved from :func:`get_type_hints()` with ``include_extras=True``. This - ensures that any nested ``Annotated`` types are flattened according to the PEP 593 specification. - - Args: - annotation: A type annotation. - - Returns: - A tuple of the unwrapped annotation and any ``Annotated`` metadata, and a set of any wrapper types encountered. - """ - origin = get_origin(annotation) - wrappers = set() - metadata = [] - while origin in wrapper_type_set: - wrappers.add(origin) - annotation, *meta = get_args(annotation) - metadata.extend(meta) - origin = get_origin(annotation) - return annotation, tuple(metadata), wrappers - - -def get_origin_or_inner_type(annotation: Any) -> Any: - """Get origin or unwrap it. Returns None for non-generic types. - - Args: - annotation: A type annotation. - - Returns: - Any type. - """ - origin = get_origin(annotation) - if origin in wrapper_type_set: - inner, _, _ = unwrap_annotation(annotation) - # we need to recursively call here 'get_origin_or_inner_type' because we might be dealing - # with a generic type alias e.g. Annotated[dict[str, list[int]] - origin = get_origin_or_inner_type(inner) - return instantiable_type_mapping.get(origin, origin) - - -def get_safe_generic_origin(origin_type: Any, annotation: Any) -> Any: - """Get a type that is safe to use as a generic type across all supported Python versions. - - If a builtin collection type is annotated without generic args, e.g, ``a: dict``, then the origin type will be - ``None``. In this case, we can use the annotation to determine the correct generic type, if one exists. - - Args: - origin_type: A type - would be the return value of :func:`get_origin()`. - annotation: Type annotation associated with the origin type. Should be unwrapped from any wrapper types, such - as ``Annotated``. - - Returns: - The ``typing`` module equivalent of the given type, if it exists. Otherwise, the original type is returned. - """ - if origin_type is None: - return safe_generic_origin_map.get(annotation) - return safe_generic_origin_map.get(origin_type, origin_type) - - -def get_instantiable_origin(origin_type: Any, annotation: Any) -> Any: - """Get a type that is safe to instantiate for the given origin type. - - If a builtin collection type is annotated without generic args, e.g, ``a: dict``, then the origin type will be - ``None``. In this case, we can use the annotation to determine the correct instantiable type, if one exists. - - Args: - origin_type: A type - would be the return value of :func:`get_origin()`. - annotation: Type annotation associated with the origin type. Should be unwrapped from any wrapper types, such - as ``Annotated``. - - Returns: - A builtin type that is safe to instantiate for the given origin type. - """ - if origin_type is None: - return instantiable_type_mapping.get(annotation) - return instantiable_type_mapping.get(origin_type, origin_type) - - -def get_type_hints_with_generics_resolved( - annotation: Any, - globalns: dict[str, Any] | None = None, - localns: dict[str, Any] | None = None, - include_extras: bool = False, - type_hints: dict[str, Any] | None = None, -) -> dict[str, Any]: - """Get the type hints for the given object after resolving the generic types as much as possible. - - Args: - annotation: A type annotation. - globalns: The global namespace. - localns: The local namespace. - include_extras: A flag indicating whether to include the ``Annotated[T, ...]`` or not. - type_hints: Already resolved type hints - """ - origin = get_origin(annotation) - - if origin is None: - # Implies the generic types have not been specified in the annotation - if type_hints is None: # pragma: no cover - type_hints = get_type_hints(annotation, globalns=globalns, localns=localns, include_extras=include_extras) - typevar_map = {p: p for p in annotation.__parameters__} - else: - if type_hints is None: # pragma: no cover - type_hints = get_type_hints(origin, globalns=globalns, localns=localns, include_extras=include_extras) - # the __parameters__ is only available on the origin itself and not the annotation - typevar_map = dict(zip(origin.__parameters__, get_args(annotation))) - - return {n: _substitute_typevars(type_, typevar_map) for n, type_ in type_hints.items()} - - -def _substitute_typevars(obj: Any, typevar_map: Mapping[Any, Any]) -> Any: - if params := getattr(obj, "__parameters__", None): - args = tuple(_substitute_typevars(typevar_map.get(p, p), typevar_map) for p in params) - return obj[args] - - if isinstance(obj, TypeVar): - # If there's a mapped type for the TypeVar already, then it should be returned instead - # of considering __constraints__ or __bound__. For a generic `Foo[T]`, if Foo[int] is given - # then int should be returned and if `Foo` is given then the __bounds__ and __constraints__ - # should be considered. - if (type_ := typevar_map.get(obj, None)) is not None and not isinstance(type_, TypeVar): - return type_ - - if obj.__bound__ is not None: - return obj.__bound__ - - if obj.__constraints__: - return Union[obj.__constraints__] # pyright: ignore - - return obj diff --git a/venv/lib/python3.11/site-packages/litestar/utils/version.py b/venv/lib/python3.11/site-packages/litestar/utils/version.py deleted file mode 100644 index d7974eb..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/version.py +++ /dev/null @@ -1,62 +0,0 @@ -from __future__ import annotations - -import re -import sys -from typing import Literal, NamedTuple - -__all__ = ("Version", "get_version", "parse_version") - - -if sys.version_info >= (3, 10): - import importlib.metadata as importlib_metadata -else: - import importlib_metadata - - -_ReleaseLevel = Literal["alpha", "beta", "rc", "final"] -_PRE_RELEASE_TAGS = {"alpha", "a", "beta", "b", "rc"} -_PRE_RELEASE_TAGS_CONVERSIONS: dict[str, _ReleaseLevel] = {"a": "alpha", "b": "beta"} - -_VERSION_PARTS_RE = re.compile(r"(\d+|[a-z]+|\.)") - - -class Version(NamedTuple): - """Litestar version information""" - - major: int - minor: int - patch: int - release_level: _ReleaseLevel - serial: int - - def formatted(self, short: bool = False) -> str: - version = f"{self.major}.{self.minor}.{self.patch}" - if not short: - version += f"{self.release_level}{self.serial}" - return version - - -def parse_version(raw_version: str) -> Version: - """Parse a version string into a :class:`Version`""" - parts = [p for p in _VERSION_PARTS_RE.split(raw_version) if p and p != "."] - release_level: _ReleaseLevel = "final" - serial = "0" - - if len(parts) == 3: - major, minor, patch = parts - elif len(parts) == 5: - major, minor, patch, release_level, serial = parts # type: ignore[assignment] - if release_level not in _PRE_RELEASE_TAGS: - raise ValueError(f"Invalid release level: {release_level}") - release_level = _PRE_RELEASE_TAGS_CONVERSIONS.get(release_level, release_level) - else: - raise ValueError(f"Invalid version: {raw_version}") - - return Version( - major=int(major), minor=int(minor), patch=int(patch), release_level=release_level, serial=int(serial) - ) - - -def get_version() -> Version: - """Get the version of the installed litestar package""" - return parse_version(importlib_metadata.version("litestar")) diff --git a/venv/lib/python3.11/site-packages/litestar/utils/warnings.py b/venv/lib/python3.11/site-packages/litestar/utils/warnings.py deleted file mode 100644 index e20484b..0000000 --- a/venv/lib/python3.11/site-packages/litestar/utils/warnings.py +++ /dev/null @@ -1,51 +0,0 @@ -import os -import warnings - -from litestar.exceptions import LitestarWarning -from litestar.types import AnyCallable, AnyGenerator - - -def warn_implicit_sync_to_thread(source: AnyCallable, stacklevel: int = 2) -> None: - if os.getenv("LITESTAR_WARN_IMPLICIT_SYNC_TO_THREAD") == "0": - return - - warnings.warn( - f"Use of a synchronous callable {source} without setting sync_to_thread is " - "discouraged since synchronous callables can block the main thread if they " - "perform blocking operations. If the callable is guaranteed to be non-blocking, " - "you can set sync_to_thread=False to skip this warning, or set the environment" - "variable LITESTAR_WARN_IMPLICIT_SYNC_TO_THREAD=0 to disable warnings of this " - "type entirely.", - category=LitestarWarning, - stacklevel=stacklevel, - ) - - -def warn_sync_to_thread_with_async_callable(source: AnyCallable, stacklevel: int = 2) -> None: - if os.getenv("LITESTAR_WARN_SYNC_TO_THREAD_WITH_ASYNC") == "0": - return - - warnings.warn( - f"Use of an asynchronous callable {source} with sync_to_thread; sync_to_thread " - "has no effect on async callable. You can disable this warning by setting " - "LITESTAR_WARN_SYNC_TO_THREAD_WITH_ASYNC=0", - category=LitestarWarning, - stacklevel=stacklevel, - ) - - -def warn_sync_to_thread_with_generator(source: AnyGenerator, stacklevel: int = 2) -> None: - if os.getenv("LITESTAR_WARN_SYNC_TO_THREAD_WITH_GENERATOR") == "0": - return - - warnings.warn( - f"Use of generator {source} with sync_to_thread; sync_to_thread has no effect " - "on generators. You can disable this warning by setting " - "LITESTAR_WARN_SYNC_TO_THREAD_WITH_GENERATOR=0", - category=LitestarWarning, - stacklevel=stacklevel, - ) - - -def warn_pdb_on_exception(stacklevel: int = 2) -> None: - warnings.warn("Python Debugger on exception enabled", category=LitestarWarning, stacklevel=stacklevel) -- cgit v1.2.3

The above exception was caused by

{escape(str(cause))}

{escape(cause.class.name)}

{error}

{error_description}

Error 404

The above exception was caused by

{escape(str(cause))}

{escape(cause.__class__.__name__)}

{error}

{error_description}

Error 404

{escape(cause.class.name)}