cadwyn 5.1.4__tar.gz → 5.2.1__tar.gz

{cadwyn-5.1.4 → cadwyn-5.2.1}/CHANGELOG.md

@@ -5,6 +5,18 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [5.2.1]
+
+### Fixed
+
+* [#268](https://github.com/zmievsa/cadwyn/issues/268) A bug where we received 404 for all unversioned routes when a default api version was passed to Cadwyn at initialization
+
+## [5.2.0]
+
+### Removed
+
+* `issubclass` dependency
+
 ## [5.1.4]
 
 ### Fixed

{cadwyn-5.1.4 → cadwyn-5.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cadwyn
-Version: 5.1.4
+Version: 5.2.1
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Project-URL: Source code, https://github.com/zmievsa/cadwyn
 Project-URL: Documentation, https://docs.cadwyn.dev
@@ -36,7 +36,6 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Requires-Dist: backports-strenum<2,>=1.3.1; python_version < '3.11'
 Requires-Dist: fastapi>=0.112.4
-Requires-Dist: issubclass>=0.1.2
 Requires-Dist: jinja2>=3.1.2
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: starlette>=0.30.0

cadwyn-5.2.1/cadwyn/_internal/context_vars.py

@@ -0,0 +1,9 @@
+from contextvars import ContextVar
+
+from typing_extensions import Literal
+
+DEFAULT_API_VERSION_VAR: "ContextVar[str | None]" = ContextVar("cadwyn_default_api_version")
+CURRENT_DEPENDENCY_SOLVER_OPTIONS = Literal["cadwyn", "fastapi"]
+CURRENT_DEPENDENCY_SOLVER_VAR: ContextVar[CURRENT_DEPENDENCY_SOLVER_OPTIONS] = ContextVar(
+    "cadwyn_dependencies_current_dependency_solver"
+)

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/_render.py

@@ -5,10 +5,10 @@ from enum import Enum
 from typing import TYPE_CHECKING, Union
 
 import typer
-from issubclass import issubclass as lenient_issubclass
 from pydantic import BaseModel
 
 from cadwyn._asts import get_fancy_repr, pop_docstring_from_cls_body
+from cadwyn._utils import lenient_issubclass
 from cadwyn.exceptions import CadwynRenderError
 from cadwyn.schema_generation import (
     PydanticFieldWrapper,

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/applications.py

@@ -133,6 +133,12 @@ class Cadwyn(FastAPI):
                 stacklevel=2,
             )
             api_version_parameter_name = api_version_header_name
+        if api_version_default_value is not None and api_version_location == "path":
+            raise CadwynStructureError(
+                "You tried to pass an api_version_default_value while putting the API version in Path. "
+                "This is not currently supported by Cadwyn. "
+                "Please, open an issue on our github if you'd like to have it."
+            )
 
         super().__init__(
             debug=debug,
@@ -231,8 +237,8 @@ class Cadwyn(FastAPI):
             versioning_middleware_class,
             api_version_parameter_name=api_version_parameter_name,
             api_version_manager=self._api_version_manager,
-            api_version_default_value=api_version_default_value,
             api_version_var=self.versions.api_version_var,
+            api_version_default_value=api_version_default_value,
         )
         if self.api_version_format == "date" and (
             sorted(self.versions.versions, key=lambda v: v.value, reverse=True) != list(self.versions.versions)

cadwyn-5.2.1/cadwyn/dependencies.py

@@ -0,0 +1,5 @@
+from cadwyn._internal.context_vars import CURRENT_DEPENDENCY_SOLVER_OPTIONS, CURRENT_DEPENDENCY_SOLVER_VAR
+
+
+async def current_dependency_solver() -> CURRENT_DEPENDENCY_SOLVER_OPTIONS:
+    return CURRENT_DEPENDENCY_SOLVER_VAR.get("fastapi")

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/middleware.py

@@ -7,10 +7,12 @@ from collections.abc import Awaitable, Callable
 from contextvars import ContextVar
 from typing import Annotated, Any, Literal, Protocol, Union
 
+import fastapi
 from fastapi import Request
 from starlette.middleware.base import BaseHTTPMiddleware, DispatchFunction, RequestResponseEndpoint
 from starlette.types import ASGIApp
 
+from cadwyn._internal.context_vars import DEFAULT_API_VERSION_VAR
 from cadwyn.structure.common import VersionType
 
 
@@ -69,6 +71,8 @@ def _generate_api_version_dependency(
                 annotation=Annotated[
                     validation_data_type, fastapi_depends_class(openapi_examples={"default": {"value": default_value}})
                 ],
+                # Path-based parameters do not support a default value in FastAPI :(
+                default=default_value if fastapi_depends_class != fastapi.Path else inspect.Signature.empty,
             ),
         ],
     )
@@ -103,10 +107,11 @@ class VersionPickingMiddleware(BaseHTTPMiddleware):
         api_version = self._api_version_manager.get(request)
 
         if api_version is None:
-            if callable(self.api_version_default_value):  # pragma: no cover # TODO
+            if callable(self.api_version_default_value):
                 api_version = await self.api_version_default_value(request)
             else:
                 api_version = self.api_version_default_value
+            DEFAULT_API_VERSION_VAR.set(api_version)
 
         self.api_version_var.set(api_version)
         response = await call_next(request)

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/route_generation.py

@@ -17,12 +17,11 @@ import fastapi.security.base
 import fastapi.utils
 from fastapi import APIRouter
 from fastapi.routing import APIRoute
-from issubclass import issubclass as lenient_issubclass
 from pydantic import BaseModel
 from starlette.routing import BaseRoute
 from typing_extensions import TypeVar, assert_never
 
-from cadwyn._utils import DATACLASS_SLOTS, Sentinel
+from cadwyn._utils import DATACLASS_SLOTS, Sentinel, lenient_issubclass
 from cadwyn.exceptions import (
     CadwynError,
     RouteAlreadyExistsError,

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/routing.py

@@ -11,6 +11,7 @@ from starlette.responses import RedirectResponse
 from starlette.routing import BaseRoute, Match
 from starlette.types import Receive, Scope, Send
 
+from cadwyn._internal.context_vars import DEFAULT_API_VERSION_VAR
 from cadwyn._utils import same_definition_as_in
 from cadwyn.middleware import APIVersionFormat
 from cadwyn.structure.common import VersionType
@@ -70,8 +71,8 @@ class _RootCadwynAPIRouter(APIRouter):
         if scope["type"] == "lifespan":
             await self.lifespan(scope, receive, send)
             return
-
         version = self.api_version_var.get(None)
+        default_version_that_was_picked = DEFAULT_API_VERSION_VAR.get(None)
 
         # if version is None, then it's an unversioned request and we need to use the unversioned routes
         # if there will be a value, we search for the most suitable version
@@ -81,6 +82,14 @@ class _RootCadwynAPIRouter(APIRouter):
             routes = self.versioned_routers[version].routes
         else:
             routes = await self._get_routes_from_closest_suitable_version(version)
+        if default_version_that_was_picked:
+            # We add unversioned routes to versioned routes because otherwise unversioned routes
+            # will be completely unavailable when a default version is passed. So routes such as
+            # /docs will not be accessible at all.
+
+            # We use this order because if versioned routes go first and there is a versioned route that is
+            # the same as an unversioned route -- the unversioned one becomes impossible to match.
+            routes = self.unversioned_routes + routes
         await self.process_request(scope=scope, receive=receive, send=send, routes=routes)
 
     @cached_property

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/structure/schemas.py

@@ -2,7 +2,6 @@ from collections.abc import Callable
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Literal, Union, cast
 
-from issubclass import issubclass as lenient_issubclass
 from pydantic import AliasChoices, AliasPath, BaseModel, Field
 from pydantic._internal._decorators import PydanticDescriptorProxy, unwrap_wrapped_function
 from pydantic.fields import FieldInfo
@@ -12,6 +11,7 @@ from cadwyn._utils import (
     Sentinel,
     fully_unwrap_decorator,
     get_name_of_function_wrapped_in_pydantic_validator,
+    lenient_issubclass,
 )
 from cadwyn.exceptions import CadwynStructureError
 

{cadwyn-5.1.4 → cadwyn-5.2.1}/cadwyn/structure/versions.py

@@ -24,8 +24,9 @@ from fastapi.routing import APIRoute, _prepare_response_content
 from pydantic import BaseModel
 from pydantic_core import PydanticUndefined
 from starlette._utils import is_async_callable
-from typing_extensions import Any, Literal, ParamSpec, TypeAlias, TypeVar, assert_never, deprecated, get_args
+from typing_extensions import Any, ParamSpec, TypeAlias, TypeVar, assert_never, deprecated, get_args
 
+from cadwyn._internal.context_vars import CURRENT_DEPENDENCY_SOLVER_VAR
 from cadwyn._utils import classproperty
 from cadwyn.exceptions import (
     CadwynError,
@@ -52,10 +53,6 @@ _CADWYN_REQUEST_PARAM_NAME = "cadwyn_request_param"
 _CADWYN_RESPONSE_PARAM_NAME = "cadwyn_response_param"
 _P = ParamSpec("_P")
 _R = TypeVar("_R")
-_CURRENT_DEPENDENCY_SOLVER_OPTIONS = Literal["cadwyn", "fastapi"]
-_CURRENT_DEPENDENCY_SOLVER_VAR: ContextVar[_CURRENT_DEPENDENCY_SOLVER_OPTIONS] = ContextVar(
-    "cadwyn_dependencies_dry_run"
-)
 
 PossibleInstructions: TypeAlias = Union[
     AlterSchemaSubInstruction, AlterEndpointSubInstruction, AlterEnumSubInstruction, SchemaHadInstruction, staticmethod
@@ -387,7 +384,7 @@ class VersionBundle:
         request.scope["headers"] = tuple((key.encode(), value.encode()) for key, value in request_info.headers.items())
         del request._headers
         # This gives us the ability to tell the user whether cadwyn is running its dependencies or FastAPI
-        _CURRENT_DEPENDENCY_SOLVER_VAR.set("cadwyn")
+        CURRENT_DEPENDENCY_SOLVER_VAR.set("cadwyn")
         # Remember this: if len(body_params) == 1, then route.body_schema == route.dependant.body_params[0]
         result = await solve_dependencies(
             request=request,

{cadwyn-5.1.4 → cadwyn-5.2.1}/docs/concepts/version_changes.md

@@ -39,8 +39,7 @@ from .v2023_02_10 import RemoveTaxIDEndpoints
 
 versions = VersionBundle(
     HeadVersion(),
-    Version("2023-02-10"),
-    RemoveTaxIDEndpoints,
+    Version("2023-02-10", RemoveTaxIDEndpoints),
     Version("2022-11-16"),
 )
 ```
@@ -64,8 +63,7 @@ from .v2023_02_10 import RemoveTaxIDEndpoints
 
 versions = VersionBundle(
     HeadVersion(),
-    Version("2023-02-10"),
-    RemoveTaxIDEndpoints,
+    Version("2023-02-10", RemoveTaxIDEndpoints),
     Version("2022-11-16"),
 )
 ```

{cadwyn-5.1.4 → cadwyn-5.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cadwyn"
-version = "5.1.4"
+version = "5.2.1"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = [{ name = "Stanislav Zmiev", email = "zmievsa@gmail.com" }]
 license = "MIT"
@@ -55,7 +55,6 @@ dependencies = [
     "starlette >=0.30.0",
     "pydantic >=2.0.0",
     "jinja2 >=3.1.2",
-    "issubclass >=0.1.2",
     "backports-strenum >=1.3.1,<2; python_version < '3.11'",
     "typing-extensions>=4.8.0",
 ]
@@ -154,6 +153,7 @@ reportMissingSuperCall = true
 reportFunctionMemberAccess = false
 reportCircularImports = true
 reportInvalidTypeForm = false
+reportPrivateImportUsage = false
 
 [tool.pytest.ini_options]
 filterwarnings = [

{cadwyn-5.1.4 → cadwyn-5.2.1}/tests/test_applications.py

@@ -8,6 +8,7 @@ from fastapi.testclient import TestClient
 from pydantic import BaseModel
 
 from cadwyn import Cadwyn
+from cadwyn.exceptions import CadwynStructureError
 from cadwyn.route_generation import VersionedAPIRouter
 from cadwyn.structure.endpoints import endpoint
 from cadwyn.structure.schemas import schema
@@ -405,3 +406,15 @@ def test__api_version_header_name_is_deprecated_and_translates_to_api_version_pa
     with pytest.warns(DeprecationWarning):
         cadwyn = Cadwyn(api_version_header_name="x-api-version", versions=VersionBundle(Version("2022-11-16")))
     assert cadwyn.api_version_parameter_name == "x-api-version"
+
+
+def test__api_version_default_value_with_path_location__should_raise_error():
+    with pytest.raises(
+        CadwynStructureError,
+        match="You tried to pass an api_version_default_value while putting the API version in Path",
+    ):
+        Cadwyn(
+            versions=VersionBundle(HeadVersion(), Version("2022-11-16")),
+            api_version_default_value="2022-11-16",
+            api_version_location="path",
+        )

{cadwyn-5.1.4 → cadwyn-5.2.1}/tests/test_routing.py

@@ -1,3 +1,5 @@
+from typing import Callable
+
 import pytest
 from starlette.requests import Request
 from starlette.responses import PlainTextResponse
@@ -5,7 +7,8 @@ from starlette.routing import Match, NoMatchFound
 from starlette.testclient import TestClient
 
 from cadwyn import Cadwyn
-from cadwyn.structure.versions import Version, VersionBundle
+from cadwyn.route_generation import VersionedAPIRouter
+from cadwyn.structure.versions import HeadVersion, Version, VersionBundle
 from tests._resources.app_for_testing_routing import mixed_hosts_app
 
 
@@ -153,3 +156,53 @@ def test__host_routing__partial_match__404():
 
     response = client.get("/v1/doggies/tom")
     assert response.status_code == 200
+
+
+async def get_default_version(req: Request):
+    return "2023-04-14"
+
+
+@pytest.mark.parametrize("default_version", ["2023-04-14", get_default_version])
+def test__get_unversioned_endpoints__with_default_version(default_version: "str | Callable"):
+    app = Cadwyn(
+        versions=VersionBundle(HeadVersion(), Version("2023-04-14"), Version("2022-11-16")),
+        api_version_default_value=default_version,
+    )
+
+    router = VersionedAPIRouter()
+
+    @app.get("/my_duplicated_route")
+    def get_my_unversioned_number():
+        return 11
+
+    @router.get("/my_duplicated_route")
+    def get_my_versioned_number():
+        return 83
+
+    @router.get("/my_single_route")
+    def get_my_versioned_number_2():
+        return 52
+
+    app.generate_and_include_versioned_routers(router)
+
+    with TestClient(app) as client:
+        resp = client.get("/docs")
+        assert resp.status_code == 200, resp.json()
+
+        resp = client.get("/docs?version=2023-04-14")
+        assert resp.status_code == 200, resp.json()
+
+        resp = client.get("/docs?version=2022-11-16")
+        assert resp.status_code == 200, resp.json()
+
+        resp = client.get("/my_duplicated_route")
+        assert resp.status_code == 200, resp.json()
+        assert resp.json() == 11
+
+        resp = client.get("/my_duplicated_route", headers={"X-API-VERSION": "2023-04-14"})
+        assert resp.status_code == 200, resp.json()
+        assert resp.json() == 83
+
+        resp = client.get("/my_single_route")
+        assert resp.status_code == 200, resp.json()
+        assert resp.json() == 52

{cadwyn-5.1.4 → cadwyn-5.2.1}/uv.lock

@@ -94,12 +94,11 @@ wheels = [
 
 [[package]]
 name = "cadwyn"
-version = "5.1.4"
+version = "5.2.1"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },
     { name = "fastapi" },
-    { name = "issubclass" },
     { name = "jinja2" },
     { name = "pydantic" },
     { name = "starlette" },
@@ -140,7 +139,6 @@ requires-dist = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'", specifier = ">=1.3.1,<2" },
     { name = "fastapi", specifier = ">=0.112.4" },
     { name = "fastapi", extras = ["standard"], marker = "extra == 'standard'", specifier = ">=0.112.3" },
-    { name = "issubclass", specifier = ">=0.1.2" },
     { name = "jinja2", specifier = ">=3.1.2" },
     { name = "pydantic", specifier = ">=2.0.0" },
     { name = "starlette", specifier = ">=0.30.0" },
@@ -614,15 +612,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/76/74/5222a632fd8d3202ddef383b71c8b6c31a9d77989030efba5be561163d41/inline_snapshot-0.20.8-py3-none-any.whl", hash = "sha256:bded4e142b8817930e4df428b88c462308a8f01ad699852e7574a54bad7ea9f2", size = 48157 },
 ]
 
-[[package]]
-name = "issubclass"
-version = "0.1.2"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/7d/89/f9a05e3bbc7cc2a5806138e62f2f94504e491411c8d0c994296dcfd0cfaf/issubclass-0.1.2.tar.gz", hash = "sha256:740dabca95adbd25442d1dd616ed455046ab9551c38514758dc291f431fded35", size = 1850 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/b1/69/3135026fbb9d4bcdc1e76a9e4c18fc4c6161a6eea6905b76d27eeaa00940/issubclass-0.1.2-py3-none-any.whl", hash = "sha256:ea54b6b27526cf1be49a4bc15d713bef0b480e0230482626a37cf21529da3864", size = 2164 },
-]
-
 [[package]]
 name = "jinja2"
 version = "3.1.6"

cadwyn-5.1.4/cadwyn/dependencies.py

@@ -1,5 +0,0 @@
-from cadwyn.structure.versions import _CURRENT_DEPENDENCY_SOLVER_OPTIONS, _CURRENT_DEPENDENCY_SOLVER_VAR
-
-
-async def current_dependency_solver() -> _CURRENT_DEPENDENCY_SOLVER_OPTIONS:
-    return _CURRENT_DEPENDENCY_SOLVER_VAR.get("fastapi")