cadwyn 4.2.2__tar.gz → 4.2.4__tar.gz

{cadwyn-4.2.2 → cadwyn-4.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 4.2.2
+Version: 4.2.4
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
@@ -31,14 +31,13 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Provides-Extra: cli
 Requires-Dist: backports-strenum (>=1.3.1,<2.0.0) ; python_version < "3.11"
-Requires-Dist: fastapi (>=0.110.0)
+Requires-Dist: fastapi[standard] (>=0.112.3)
 Requires-Dist: issubclass (>=0.1.2,<0.2.0)
 Requires-Dist: jinja2 (>=3.1.2)
 Requires-Dist: pydantic (>=2.0.0)
 Requires-Dist: starlette (>=0.30.0)
-Requires-Dist: typer (>=0.7.0) ; extra == "cli"
+Requires-Dist: typer (>=0.7.0)
 Requires-Dist: typing-extensions
 Project-URL: Documentation, https://docs.cadwyn.dev
 Project-URL: Repository, https://github.com/zmievsa/cadwyn

{cadwyn-4.2.2 → cadwyn-4.2.4}/cadwyn/middleware.py

@@ -64,11 +64,11 @@ class HeaderVersioningMiddleware(BaseHTTPMiddleware):
                     request=request,
                     dependant=self.version_header_validation_dependant,
                     async_exit_stack=async_exit_stack,
+                    embed_body_fields=False,
                 )
-                values, errors, *_ = solved_result
-                if errors:
-                    return self.default_response_class(status_code=422, content=_normalize_errors(errors))
-                api_version = cast(date, values[self.api_version_header_name.replace("-", "_")])
+                if solved_result.errors:
+                    return self.default_response_class(status_code=422, content=_normalize_errors(solved_result.errors))
+                api_version = cast(date, solved_result.values[self.api_version_header_name.replace("-", "_")])
                 self.api_version_var.set(api_version)
 
         response = await call_next(request)

{cadwyn-4.2.2 → cadwyn-4.2.4}/cadwyn/route_generation.py

@@ -376,6 +376,7 @@ def _add_data_migrations_to_route(
         head_route,
         dependant_for_request_migrations,
         request_param_name=route.dependant.request_param_name,
+        background_tasks_param_name=route.dependant.background_tasks_param_name,
         response_param_name=route.dependant.response_param_name,
     )(route.endpoint)
     route.dependant.call = route.endpoint

{cadwyn-4.2.2 → cadwyn-4.2.4}/cadwyn/schema_generation.py

@@ -441,7 +441,7 @@ class _AnnotationTransformer:
     def migrate_route_to_version(self, route: fastapi.routing.APIRoute, *, ignore_response_model: bool = False):
         if route.response_model is not None and not ignore_response_model:
             route.response_model = self.change_version_of_annotation(route.response_model)
-            route.response_field = fastapi.utils.create_response_field(
+            route.response_field = fastapi.utils.create_model_field(
                 name="Response_" + route.unique_id,
                 type_=route.response_model,
                 mode="serialization",

{cadwyn-4.2.2 → cadwyn-4.2.4}/cadwyn/structure/versions.py

@@ -10,7 +10,7 @@ from datetime import date
 from enum import Enum
 from typing import Any, ClassVar, ParamSpec, TypeAlias, TypeVar
 
-from fastapi import HTTPException, params
+from fastapi import BackgroundTasks, HTTPException, params
 from fastapi import Request as FastapiRequest
 from fastapi import Response as FastapiResponse
 from fastapi._compat import ModelField, _normalize_errors
@@ -350,7 +350,10 @@ class VersionBundle:
         request_info: RequestInfo,
         current_version: VersionDate,
         head_route: APIRoute,
+        *,
         exit_stack: AsyncExitStack,
+        embed_body_fields: bool,
+        background_tasks: BackgroundTasks | None,
     ) -> dict[str, Any]:
         method = request.method
         for v in reversed(self.versions):
@@ -367,19 +370,21 @@ class VersionBundle:
         request.scope["headers"] = tuple((key.encode(), value.encode()) for key, value in request_info.headers.items())
         del request._headers
         # Remember this: if len(body_params) == 1, then route.body_schema == route.dependant.body_params[0]
-        dependencies, errors, _, _, _ = await solve_dependencies(
+        result = await solve_dependencies(
             request=request,
             response=response,
             dependant=head_dependant,
             body=request_info.body,
             dependency_overrides_provider=head_route.dependency_overrides_provider,
             async_exit_stack=exit_stack,
+            embed_body_fields=embed_body_fields,
+            background_tasks=background_tasks,
         )
-        if errors:
+        if result.errors:
             raise CadwynHeadRequestValidationError(
-                _normalize_errors(errors), body=request_info.body, version=current_version
+                _normalize_errors(result.errors), body=request_info.body, version=current_version
             )
-        return dependencies
+        return result.values
 
     def _migrate_response(
         self,
@@ -431,6 +436,7 @@ class VersionBundle:
         dependant_for_request_migrations: Dependant,
         *,
         request_param_name: str,
+        background_tasks_param_name: str | None,
         response_param_name: str,
     ) -> Callable[[Endpoint[_P, _R]], Endpoint[_P, _R]]:
         def wrapper(endpoint: Endpoint[_P, _R]) -> Endpoint[_P, _R]:
@@ -438,6 +444,10 @@ class VersionBundle:
             async def decorator(*args: Any, **kwargs: Any) -> _R:
                 request_param: FastapiRequest = kwargs[request_param_name]
                 response_param: FastapiResponse = kwargs[response_param_name]
+                background_tasks: BackgroundTasks | None = kwargs.get(
+                    background_tasks_param_name,  # pyright: ignore[reportArgumentType, reportCallIssue]
+                    None,
+                )
                 method = request_param.method
                 response = Sentinel
                 async with AsyncExitStack() as exit_stack:
@@ -452,7 +462,9 @@ class VersionBundle:
                         response_param,
                         route,
                         head_route,
-                        exit_stack,
+                        exit_stack=exit_stack,
+                        embed_body_fields=route._embed_body_fields,
+                        background_tasks=background_tasks,
                     )
 
                     response = await self._convert_endpoint_response_to_version(
@@ -524,10 +536,14 @@ class VersionBundle:
             if isinstance(response_or_response_body, StreamingResponse | FileResponse):
                 body = None
             elif response_or_response_body.body:
-                if isinstance(response_or_response_body, JSONResponse) or raised_exception is not None:
+                if (isinstance(response_or_response_body, JSONResponse) or raised_exception is not None) and isinstance(
+                    response_or_response_body.body, str | bytes
+                ):
                     body = json.loads(response_or_response_body.body)
-                else:
+                elif isinstance(response_or_response_body.body, bytes):
                     body = response_or_response_body.body.decode(response_or_response_body.charset)
+                else:  # pragma: no cover # I don't see a good use case here yet
+                    body = response_or_response_body.body
             else:
                 body = None
                 # TODO (https://github.com/zmievsa/cadwyn/issues/51): Only do this if there are migrations
@@ -614,7 +630,10 @@ class VersionBundle:
         response: FastapiResponse,
         route: APIRoute,
         head_route: APIRoute,
+        *,
         exit_stack: AsyncExitStack,
+        embed_body_fields: bool,
+        background_tasks: BackgroundTasks | None,
     ) -> dict[str, Any]:
         request: FastapiRequest = kwargs[request_param_name]
         if request_param_name == _CADWYN_REQUEST_PARAM_NAME:
@@ -655,6 +674,8 @@ class VersionBundle:
             api_version,
             head_route,
             exit_stack=exit_stack,
+            embed_body_fields=embed_body_fields,
+            background_tasks=background_tasks,
         )
         # Because we re-added it into our kwargs when we did solve_dependencies
         if _CADWYN_REQUEST_PARAM_NAME in new_kwargs:

{cadwyn-4.2.2 → cadwyn-4.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "4.2.2"
+version = "4.2.4"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
@@ -50,40 +50,45 @@ classifiers = [
 
 
 [tool.poetry.dependencies]
+fastapi = { version = ">=0.112.3", extras = ["standard"] }
 python = "^3.10"
 typing-extensions = "*"
-fastapi = ">=0.110.0"
-starlette = ">=0.30.0"                                       # Because of this: https://github.com/encode/starlette/pull/2191
+starlette = ">=0.30.0"
 pydantic = ">=2.0.0"
-typer = { version = ">=0.7.0", optional = true }
+typer = ">=0.7.0"
 jinja2 = ">=3.1.2"
 issubclass = "^0.1.2"
 backports-strenum = { version = "^1.3.1", python = "<3.11" }
 
-[tool.poetry.extras]
-cli = ["typer"]
-
-
 [tool.poetry.group.dev.dependencies]
-pytest = ">=7.2.1"
-pytest-cov = ">=4.0.0"
-uvicorn = "*"
 pdbpp = "^0.10.3"
+python-multipart = ">=0.0.6"
+better-devtools = "^0.13.3"
+pytest-sugar = "^1.0.0"
+
+[tool.poetry.group.tests.dependencies]
+svcs = "^24.1.0"
 httpx = "*"
 pytest-fixture-classes = ">=1.0.3"
+pytest = ">=7.2.1"
+pytest-cov = ">=4.0.0"
 dirty-equals = ">=0.6.0"
+
+[tool.poetry.group.docs.dependencies]
 mkdocs = ">=1.5.2"
 mkdocs-material = ">=9.3.1"
-python-multipart = ">=0.0.6"
 mkdocs-simple-hooks = ">=0.1.5"
-pytest-sugar = "^1.0.0"
-better-devtools = "^0.13.3"
-svcs = "^24.1.0"
+mdx-include = "^1.4.2"
 mike = "^2.1.2"
 
 [tool.poetry.scripts]
 cadwyn = "cadwyn.__main__:app"
 
+[tool.coverage.run]
+data_file = "coverage/coverage"
+parallel = true
+branch = true
+
 [tool.coverage.report]
 skip_covered = true
 skip_empty = true
@@ -106,13 +111,7 @@ exclude_lines = [
     "__rich_repr__",
     "__repr__",
 ]
-omit = [
-    "./docs/plugin.py",
-    "./site/plugin.py",
-    "./tests/_data/_temp/**/*",
-    "tests/tutorial/data/**/*",
-    "scripts/*.py",
-]
+omit = ["./docs/plugin.py", "./site/plugin.py", "scripts/*.py"]
 
 [tool.pyright]
 reportMissingImports = true