cadwyn 2.1.0rc1__tar.gz → 2.3.0__tar.gz

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 2.1.0rc1
+Version: 2.3.0
 Summary: Modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
@@ -32,10 +32,10 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Provides-Extra: cli
 Requires-Dist: fastapi (>=0.96.1)
-Requires-Dist: fastapi-header-versioning (>=1.1.0)
 Requires-Dist: pydantic (>=1.10.0,<2.0.0)
 Requires-Dist: typer (>=0.7.0); extra == "cli"
 Requires-Dist: typing-extensions
+Requires-Dist: verselect-zmievsa (>=0.0.5)
 Project-URL: Repository, https://github.com/zmievsa/cadwyn
 Description-Content-Type: text/markdown
 
@@ -73,10 +73,10 @@ Its [approach](./docs/theory.md#ii-migration-based-response-building) will be us
 
 The [documentation](https://docs.cadwyn.dev) has everything you need to get started. It is recommended to read it in the following order:
 
-1. [Tutorial](https://docs.cadwyn.dev/tutorial/)
-2. [Recipes](https://docs.cadwyn.dev/recipes/)
-3. [Reference](https://docs.cadwyn.dev/reference/)
-4. [Theory](https://docs.cadwyn.dev/theory/)
+1. [Tutorial](./tutorial.md)
+2. [Recipes](./recipes.md)
+3. [Reference](./reference.md)
+4. [Theory](./theory.md) <!-- TODO: Move section about cadwyn's approach to the beginning and move other approaches and "how we got here" to another article  -->
 
 ## Similar projects
 

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/README.md

@@ -32,10 +32,10 @@ Its [approach](./docs/theory.md#ii-migration-based-response-building) will be us
 
 The [documentation](https://docs.cadwyn.dev) has everything you need to get started. It is recommended to read it in the following order:
 
-1. [Tutorial](https://docs.cadwyn.dev/tutorial/)
-2. [Recipes](https://docs.cadwyn.dev/recipes/)
-3. [Reference](https://docs.cadwyn.dev/reference/)
-4. [Theory](https://docs.cadwyn.dev/theory/)
+1. [Tutorial](./tutorial.md)
+2. [Recipes](./recipes.md)
+3. [Reference](./reference.md)
+4. [Theory](./theory.md) <!-- TODO: Move section about cadwyn's approach to the beginning and move other approaches and "how we got here" to another article  -->
 
 ## Similar projects
 

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/__init__.py

@@ -1,14 +1,14 @@
 import importlib.metadata
 
 from .codegen import generate_code_for_versioned_packages
-from .header import get_cadwyn_dependency
+from .main import Cadwyn
 from .routing import VersionedAPIRouter, generate_versioned_routers
 from .structure import VersionBundle, internal_body_representation_of
 
 __version__ = importlib.metadata.version("cadwyn")
 __all__ = [
+    "Cadwyn",
     "VersionedAPIRouter",
-    "get_cadwyn_dependency",
     "generate_code_for_versioned_packages",
     "VersionBundle",
     "generate_versioned_routers",

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/codegen.py

@@ -15,8 +15,8 @@ from types import GenericAlias, LambdaType, ModuleType, NoneType
 from typing import (
     Any,
     TypeAlias,
-    _BaseGenericAlias,
-    cast,  # pyright: ignore[reportGeneralTypeIssues]
+    _BaseGenericAlias,  # pyright: ignore[reportGeneralTypeIssues]
+    cast,
     final,
     get_args,
     get_origin,

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/exceptions.py

@@ -1,4 +1,17 @@
 from fastapi.routing import APIRoute
+from verselect.exceptions import AppCreationError
+
+__all__ = [
+    "AppCreationError",
+    "CadwynError",
+    "LintingError",
+    "CodeGenerationError",
+    "InvalidGenerationInstructionError",
+    "RouterGenerationError",
+    "RouteAlreadyExistsError",
+    "CadwynStructureError",
+    "ModuleIsNotVersionedError",
+]
 
 
 class CadwynError(Exception):

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/main.py

@@ -6,29 +6,26 @@ from fastapi import APIRouter, routing
 from fastapi.datastructures import Default
 from fastapi.params import Depends
 from fastapi.utils import generate_unique_id
-from fastapi_header_versioning import HeaderRoutingFastAPI
-from fastapi_header_versioning.fastapi import HeaderVersionedAPIRouter
 from starlette.middleware import Middleware
 from starlette.requests import Request
 from starlette.responses import JSONResponse, Response
 from starlette.routing import BaseRoute
 from starlette.types import Lifespan
 from typing_extensions import Self
+from verselect import HeaderRoutingFastAPI
 
-from cadwyn.header import get_cadwyn_dependency
 from cadwyn.routing import generate_versioned_routers
 from cadwyn.structure import VersionBundle
 
 
-class _Cadwyn(HeaderRoutingFastAPI):
+class Cadwyn(HeaderRoutingFastAPI):
     def __init__(
         self,
         *,
         versions: VersionBundle,
         latest_schemas_module: ModuleType,
-        version_header: str = "x-api-version",
+        api_version_header_name: str = "x-api-version",
         debug: bool = False,
-        routes: list[BaseRoute] | None = None,
         title: str = "FastAPI",
         summary: str | None = None,
         description: str = "",
@@ -40,7 +37,7 @@ class _Cadwyn(HeaderRoutingFastAPI):
         default_response_class: type[Response] = Default(JSONResponse),  # noqa: B008
         redirect_slashes: bool = True,
         docs_url: str | None = "/docs",
-        redoc_url: str | None = "/redoc",
+        redoc_url: None = None,
         swagger_ui_oauth2_redirect_url: str | None = "/docs/oauth2-redirect",
         swagger_ui_init_oauth: dict[str, Any] | None = None,
         middleware: Sequence[Middleware] | None = None,
@@ -66,9 +63,9 @@ class _Cadwyn(HeaderRoutingFastAPI):
         **extra: Any,
     ) -> None:
         super().__init__(
-            version_header=version_header,
+            api_version_header_name=api_version_header_name,
+            api_version_var=versions.api_version_var,
             debug=debug,
-            routes=routes,
             title=title,
             summary=summary,
             description=description,
@@ -80,7 +77,6 @@ class _Cadwyn(HeaderRoutingFastAPI):
             default_response_class=default_response_class,
             redirect_slashes=redirect_slashes,
             docs_url=docs_url,
-            redoc_url=redoc_url,
             swagger_ui_oauth2_redirect_url=swagger_ui_oauth2_redirect_url,
             swagger_ui_init_oauth=swagger_ui_init_oauth,
             middleware=middleware,
@@ -106,21 +102,15 @@ class _Cadwyn(HeaderRoutingFastAPI):
         )
         self.versions = versions
         self.latest_schemas_module = latest_schemas_module
-        self.version_header = version_header
-        self.cadwyn_header_dependency = get_cadwyn_dependency(
-            version_header_name=version_header,
-            api_version_var=self.versions.api_version_var,
-        )
 
-    def include_versioned_routers(self, *routers: APIRouter) -> None:
+    def generate_and_include_versioned_routers(self, *routers: APIRouter) -> None:
+        root_router = APIRouter()
+        for router in routers:
+            root_router.include_router(router)
         router_versions = generate_versioned_routers(
-            *routers,
+            root_router,
             versions=self.versions,
             latest_schemas_module=self.latest_schemas_module,
         )
-        root_router = HeaderVersionedAPIRouter()
-
         for version, router in router_versions.items():
-            root_router.include_router(router, version=str(version))
-
-        self.include_router(root_router, dependencies=[self.cadwyn_header_dependency])
+            self.add_header_versioned_routers(router, header_value=version.isoformat())

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/routing.py

@@ -12,6 +12,7 @@ from pathlib import Path
 from types import GenericAlias, MappingProxyType, ModuleType
 from typing import (
     Any,
+    Generic,
     TypeAlias,
     TypeVar,
     _BaseGenericAlias,  # pyright: ignore[reportGeneralTypeIssues]
@@ -40,6 +41,7 @@ from starlette.routing import (
     request_response,
 )
 from typing_extensions import assert_never
+from verselect.routing import VERSION_HEADER_FORMAT
 
 from cadwyn._utils import Sentinel, UnionType, get_another_version_of_module
 from cadwyn.codegen import _get_package_path_from_module, _get_version_dir_path
@@ -54,12 +56,18 @@ from cadwyn.structure.endpoints import (
 )
 from cadwyn.structure.versions import _CADWYN_REQUEST_PARAM_NAME, _CADWYN_RESPONSE_PARAM_NAME, VersionChange
 
+__all__ = [
+    "generate_versioned_routers",
+    "VersionedAPIRouter",
+    "VERSION_HEADER_FORMAT",
+]
+
 _T = TypeVar("_T", bound=Callable[..., Any])
 _R = TypeVar("_R", bound=fastapi.routing.APIRouter)
 # This is a hack we do because we can't guarantee how the user will use the router.
 _DELETED_ROUTE_TAG = "_CADWYN_DELETED_ROUTE"
-EndpointPath: TypeAlias = str
-EndpointMethod: TypeAlias = str
+_EndpointPath: TypeAlias = str
+_EndpointMethod: TypeAlias = str
 
 
 @dataclass(slots=True, frozen=True, eq=True)
@@ -69,9 +77,9 @@ class _EndpointInfo:
 
 
 @dataclass(slots=True)
-class _RouterInfo:
-    router: fastapi.routing.APIRouter
-    routes_with_migrated_requests: dict[EndpointPath, set[EndpointMethod]]
+class _RouterInfo(Generic[_R]):
+    router: _R
+    routes_with_migrated_requests: dict[_EndpointPath, set[_EndpointMethod]]
     route_bodies_with_migrated_requests: set[type[BaseModel]]
 
 
@@ -97,14 +105,14 @@ class VersionedAPIRouter(fastapi.routing.APIRouter):
         return endpoint
 
 
-@final
-class _EndpointTransformer:
+class _EndpointTransformer(Generic[_R]):
     def __init__(
         self,
-        parent_router: fastapi.routing.APIRouter,
+        parent_router: _R,
         versions: VersionBundle,
         latest_schemas_module: ModuleType,
     ) -> None:
+        super().__init__()
         self.parent_router = parent_router
         self.versions = versions
         self.annotation_transformer = _AnnotationTransformer(latest_schemas_module, versions)
@@ -113,7 +121,7 @@ class _EndpointTransformer:
             route for route in parent_router.routes if isinstance(route, APIRoute) and _DELETED_ROUTE_TAG in route.tags
         ]
 
-    def transform(self):
+    def transform(self) -> dict[VersionDate, _R]:
         router = deepcopy(self.parent_router)
         router_infos: dict[VersionDate, _RouterInfo] = {}
         routes_with_migrated_requests = {}
@@ -446,41 +454,23 @@ class _AnnotationTransformer:
             return self._change_version_of_type(annotation, version_dir)
         elif callable(annotation):
             # TASK: https://github.com/zmievsa/cadwyn/issues/48
-            if inspect.iscoroutinefunction(annotation):
-
-                @functools.wraps(annotation)
-                async def new_callable(  # pyright: ignore[reportGeneralTypeIssues]
-                    *args: Any,
-                    **kwargs: Any,
-                ) -> Any:
-                    return await annotation(*args, **kwargs)
-
-            else:
-
-                @functools.wraps(annotation)
-                def new_callable(  # pyright: ignore[reportGeneralTypeIssues]
-                    *args: Any,
-                    **kwargs: Any,
-                ) -> Any:
-                    return annotation(*args, **kwargs)
-
-            # Otherwise it will have the same signature as __wrapped__
-            new_callable.__alt_wrapped__ = new_callable.__wrapped__  # pyright: ignore[reportGeneralTypeIssues]
-            del new_callable.__wrapped__
+            annotation_modifying_decorator = _copy_function(annotation)
             old_params = inspect.signature(annotation).parameters
-            callable_annotations = new_callable.__annotations__
+            callable_annotations = annotation_modifying_decorator.__annotations__
 
-            new_callable: Any = cast(Any, new_callable)
-            new_callable.__annotations__ = self._change_version_of_annotations(
+            annotation_modifying_decorator.__annotations__ = self._change_version_of_annotations(
                 callable_annotations,
                 version_dir,
             )
-            new_callable.__defaults__ = self._change_version_of_annotations(
+            annotation_modifying_decorator.__defaults__ = self._change_version_of_annotations(
                 tuple(p.default for p in old_params.values() if p.default is not inspect.Signature.empty),
                 version_dir,
             )
-            new_callable.__signature__ = _generate_signature(new_callable, old_params)
-            return new_callable
+            annotation_modifying_decorator.__signature__ = _generate_signature(
+                annotation_modifying_decorator,
+                old_params,
+            )
+            return annotation_modifying_decorator
         else:
             return annotation
 
@@ -581,7 +571,7 @@ def _add_data_migrations_to_route(
     route.endpoint = versions._versioned(
         template_body_field,
         template_body_field_name,
-        route.dependant.body_params,
+        route,
         dependant_for_request_migrations,
         latest_response_model,
         request_param_name=route.dependant.request_param_name,
@@ -672,7 +662,7 @@ def _get_route_from_func(
     return None
 
 
-def _get_migrated_routes_by_path(version: Version) -> dict[EndpointPath, set[EndpointMethod]]:
+def _get_migrated_routes_by_path(version: Version) -> dict[_EndpointPath, set[_EndpointMethod]]:
     request_by_path_migration_instructions = [
         version_change.alter_request_by_path_instructions for version_change in version.version_changes
     ]
@@ -682,3 +672,34 @@ def _get_migrated_routes_by_path(version: Version) -> dict[EndpointPath, set[End
             for instruction in instruction_list:
                 migrated_routes[path] |= instruction.methods
     return migrated_routes
+
+
+def _copy_function(function: _T) -> _T:
+    while hasattr(function, "__alt_wrapped__"):
+        function = function.__alt_wrapped__
+
+    if inspect.iscoroutinefunction(function):
+
+        @functools.wraps(function)
+        async def annotation_modifying_decorator(  # pyright: ignore[reportGeneralTypeIssues]
+            *args: Any,
+            **kwargs: Any,
+        ) -> Any:
+            return await function(*args, **kwargs)
+
+    else:
+
+        @functools.wraps(function)
+        def annotation_modifying_decorator(
+            *args: Any,
+            **kwargs: Any,
+        ) -> Any:
+            return function(*args, **kwargs)
+
+    # Otherwise it will have the same signature as __wrapped__ due to how inspect module works
+    annotation_modifying_decorator.__alt_wrapped__ = (  # pyright: ignore[reportGeneralTypeIssues]
+        annotation_modifying_decorator.__wrapped__
+    )
+    del annotation_modifying_decorator.__wrapped__
+
+    return cast(_T, annotation_modifying_decorator)

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/structure/endpoints.py

@@ -8,8 +8,12 @@ from fastapi.params import Depends
 from fastapi.routing import APIRoute
 from starlette.routing import BaseRoute
 
+from cadwyn.exceptions import LintingError
+
 from .._utils import Sentinel
 
+HTTP_METHODS = {"GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"}
+
 
 @dataclass(slots=True)
 class EndpointAttributesPayload:
@@ -144,6 +148,14 @@ class EndpointInstructionFactory:
 
 
 def endpoint(path: str, methods: list[str], /, *, func_name: str | None = None) -> EndpointInstructionFactory:
+    invalid_methods = set(methods) - HTTP_METHODS
+    if invalid_methods:
+        invalid_methods = ", ".join(sorted(invalid_methods))
+        raise LintingError(
+            f"The following HTTP methods are not valid: {invalid_methods}. "
+            "Please use valid HTTP methods such as GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD.",
+        )
+
     return EndpointInstructionFactory(path, set(methods), func_name)
 
 

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/cadwyn/structure/versions.py

@@ -1,21 +1,24 @@
+import email.message
 import functools
 import inspect
 import json
 from collections import defaultdict
 from collections.abc import Callable, Sequence
+from contextlib import AsyncExitStack
 from contextvars import ContextVar
 from enum import Enum
-from typing import Any, ClassVar, ParamSpec, TypeAlias, TypeVar
+from typing import Any, ClassVar, ParamSpec, TypeAlias, TypeVar, cast
 
+from fastapi import HTTPException, params
 from fastapi import Request as FastapiRequest
 from fastapi import Response as FastapiResponse
-from fastapi import params
 from fastapi._compat import ModelField, _normalize_errors
 from fastapi.dependencies.models import Dependant
 from fastapi.dependencies.utils import solve_dependencies
 from fastapi.exceptions import RequestValidationError
-from fastapi.routing import _prepare_response_content
+from fastapi.routing import APIRoute, _prepare_response_content
 from pydantic import BaseModel
+from pydantic.fields import Undefined
 from typing_extensions import assert_never
 
 from cadwyn.exceptions import CadwynError, CadwynStructureError
@@ -45,6 +48,7 @@ PossibleInstructions: TypeAlias = (
     | AlterSchemaInstruction
     | staticmethod
 )
+APIVersionVarType: TypeAlias = ContextVar[VersionDate | None] | ContextVar[VersionDate]
 
 
 class VersionChange:
@@ -203,25 +207,27 @@ class Version:
 class VersionBundle:
     def __init__(
         self,
-        *versions: Version,
-        api_version_var: ContextVar[VersionDate | None] | ContextVar[VersionDate],
+        latest_version: Version,
+        /,
+        *other_versions: Version,
+        api_version_var: APIVersionVarType,
     ) -> None:
         super().__init__()
 
-        self.versions = versions
+        self.versions = (latest_version, *other_versions)
         self.api_version_var = api_version_var
-        if sorted(versions, key=lambda v: v.value, reverse=True) != list(versions):
-            raise ValueError(
+        if sorted(self.versions, key=lambda v: v.value, reverse=True) != list(self.versions):
+            raise CadwynStructureError(
                 "Versions are not sorted correctly. Please sort them in descending order.",
             )
-        if versions[-1].version_changes:
+        if self.versions[-1].version_changes:
             raise CadwynStructureError(
-                f'The first version "{versions[-1].value}" cannot have any version changes. '
+                f'The first version "{self.versions[-1].value}" cannot have any version changes. '
                 "Version changes are defined to migrate to/from a previous version so you "
                 "cannot define one for the very first version.",
             )
         version_values = set()
-        for version in versions:
+        for version in self.versions:
             if version.value not in version_values:
                 version_values.add(version.value)
             else:
@@ -293,6 +299,7 @@ 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]
+
         new_kwargs, errors, _, _, _ = await solve_dependencies(
             request=request,
             response=response,
@@ -301,7 +308,6 @@ class VersionBundle:
             # TODO: Take it from route
             dependency_overrides_provider=None,
         )
-
         if errors:
             raise RequestValidationError(_normalize_errors(errors), body=request_info.body)
         return new_kwargs
@@ -346,7 +352,7 @@ class VersionBundle:
         self,
         template_module_body_field_for_request_migrations: type[BaseModel] | None,
         module_body_field_name: str | None,
-        body_params: list[ModelField],
+        route: APIRoute,
         dependant_for_request_migrations: Dependant,
         latest_response_model: Any,
         *,
@@ -368,7 +374,7 @@ class VersionBundle:
                     request_param_name,
                     kwargs,
                     response,
-                    body_params,
+                    route,
                 )
 
                 return await self._convert_endpoint_response_to_version(
@@ -445,9 +451,8 @@ class VersionBundle:
         request_param_name: str,
         kwargs: dict[str, Any],
         response: FastapiResponse,
-        body_params: list[ModelField],
+        route: APIRoute,
     ):
-        is_single_body_field = len(body_params) == 1
         request: FastapiRequest = kwargs[request_param_name]
         if request_param_name == _CADWYN_REQUEST_PARAM_NAME:
             kwargs.pop(request_param_name)
@@ -456,14 +461,13 @@ class VersionBundle:
         if api_version is None:
             return kwargs
 
+        # TODO: What if the user never edits it? We just add a round of (de)serialization
         if (
-            is_single_body_field
+            len(route.dependant.body_params) == 1
             and template_module_body_field_for_request_migrations is not None
             and body_field_alias is not None
             and body_field_alias in kwargs
         ):
-            # TODO: What if the user never edits it? We just add a round of (de)serialization
-
             raw_body = kwargs[body_field_alias]
             if raw_body is None:
                 body = None
@@ -471,12 +475,8 @@ class VersionBundle:
                 body = raw_body.dict(by_alias=True, exclude_unset=True)
                 if kwargs[body_field_alias].__custom_root_type__:
                     body = body["__root__"]
-        # TODO: What if it's large? We need to also make ours a generator, then... But we can't because ours is
-        # synchronous. HMM... Or maybe just reading it later will solve the issue. Who knows...
-        elif any(isinstance(param.field_info, params.Form) for param in body_params):
-            body = await request.form()
         else:
-            body = await request.body()
+            body = await _get_body(request, route.body_field)
         request_info = RequestInfo(request, body)
         new_kwargs = await self._migrate_request(
             template_module_body_field_for_request_migrations,
@@ -493,6 +493,53 @@ class VersionBundle:
         return new_kwargs
 
 
+async def _get_body(request: FastapiRequest, body_field: ModelField | None):  # pragma: no cover # This is from fastapi
+    is_body_form = body_field and isinstance(body_field.field_info, params.Form)
+    try:
+        body: Any = None
+        if body_field:
+            if is_body_form:
+                body = await request.form()
+                stack = cast(AsyncExitStack, request.scope.get("fastapi_astack"))
+                stack.push_async_callback(body.close)
+            else:
+                body_bytes = await request.body()
+                if body_bytes:
+                    json_body: Any = Undefined
+                    content_type_value = request.headers.get("content-type")
+                    if not content_type_value:
+                        json_body = await request.json()
+                    else:
+                        message = email.message.Message()
+                        message["content-type"] = content_type_value
+                        if message.get_content_maintype() == "application":
+                            subtype = message.get_content_subtype()
+                            if subtype == "json" or subtype.endswith("+json"):
+                                json_body = await request.json()
+                    if json_body != Undefined:
+                        body = json_body
+                    else:
+                        body = body_bytes
+    except json.JSONDecodeError as e:
+        raise RequestValidationError(
+            [
+                {
+                    "type": "json_invalid",
+                    "loc": ("body", e.pos),
+                    "msg": "JSON decode error",
+                    "input": {},
+                    "ctx": {"error": e.msg},
+                },
+            ],
+            body=e.doc,
+        ) from e
+    except HTTPException:
+        raise
+    except Exception as e:  # noqa: BLE001
+        raise HTTPException(status_code=400, detail="There was an error parsing the body") from e
+    return body
+
+
 def _add_keyword_only_parameter(
     func: Callable,
     param_name: str,

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "2.1.0.rc1"
+version = "2.3.0"
 description = "Modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
@@ -35,8 +35,8 @@ python = "^3.10"
 typing-extensions = "*"
 fastapi = ">=0.96.1"
 pydantic = "^1.10.0"
-fastapi-header-versioning = ">=1.1.0"
 typer = {version = ">=0.7.0", optional = true}
+verselect-zmievsa = ">=0.0.5"
 
 [tool.poetry.extras]
 cli = ["typer"]

{cadwyn-2.1.0rc1 → cadwyn-2.3.0}/setup.py

@@ -8,10 +8,10 @@ package_data = \
 {'': ['*']}
 
 install_requires = \
-['fastapi-header-versioning>=1.1.0',
- 'fastapi>=0.96.1',
+['fastapi>=0.96.1',
  'pydantic>=1.10.0,<2.0.0',
- 'typing-extensions']
+ 'typing-extensions',
+ 'verselect-zmievsa>=0.0.5']
 
 extras_require = \
 {'cli': ['typer>=0.7.0']}
@@ -21,9 +21,9 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'cadwyn',
-    'version': '2.1.0rc1',
+    'version': '2.3.0',
     'description': 'Modern Stripe-like API versioning in FastAPI',
-    'long_description': '# Cadwyn\n\nModern [Stripe-like](https://stripe.com/blog/api-versioning) API versioning in FastAPI\n\n---\n\n<p align="center">\n<a href="https://github.com/zmievsa/cadwyn/actions?query=workflow%3ATests+event%3Apush+branch%3Amain" target="_blank">\n    <img src="https://github.com/zmievsa/cadwyn/actions/workflows/test.yaml/badge.svg?branch=main&event=push" alt="Test">\n</a>\n<a href="https://codecov.io/gh/ovsyanka83/cadwyn" target="_blank">\n    <img src="https://img.shields.io/codecov/c/github/ovsyanka83/cadwyn?color=%2334D058" alt="Coverage">\n</a>\n<a href="https://pypi.org/project/cadwyn/" target="_blank">\n    <img alt="PyPI" src="https://img.shields.io/pypi/v/cadwyn?color=%2334D058&label=pypi%20package" alt="Package version">\n</a>\n<a href="https://pypi.org/project/cadwyn/" target="_blank">\n    <img src="https://img.shields.io/pypi/pyversions/cadwyn?color=%2334D058" alt="Supported Python versions">\n</a>\n</p>\n\n## Who is this for?\n\nCadwyn allows you to support a single version of your code, auto-generating the code/routes for older versions. You keep versioning encapsulated in small and independent "version change" modules while your business logic knows nothing about versioning.\n\nIts [approach](./docs/theory.md#ii-migration-based-response-building) will be useful if you want to:\n\n1. Support many (>2) API versions for a long time\n2. Effortlessly backport features and bugfixes to older API versions\n\n## Get started\n\nThe [documentation](https://docs.cadwyn.dev) has everything you need to get started. It is recommended to read it in the following order:\n\n1. [Tutorial](https://docs.cadwyn.dev/tutorial/)\n2. [Recipes](https://docs.cadwyn.dev/recipes/)\n3. [Reference](https://docs.cadwyn.dev/reference/)\n4. [Theory](https://docs.cadwyn.dev/theory/)\n\n## Similar projects\n\nThe following projects are trying to accomplish similar results with a lot more simplistic functionality.\n\n- <https://github.com/sjkaliski/pinned>\n- <https://github.com/phillbaker/gates>\n- <https://github.com/lukepolo/laravel-api-migrations>\n- <https://github.com/tomschlick/request-migrations>\n- <https://github.com/keygen-sh/request_migrations>\n',
+    'long_description': '# Cadwyn\n\nModern [Stripe-like](https://stripe.com/blog/api-versioning) API versioning in FastAPI\n\n---\n\n<p align="center">\n<a href="https://github.com/zmievsa/cadwyn/actions?query=workflow%3ATests+event%3Apush+branch%3Amain" target="_blank">\n    <img src="https://github.com/zmievsa/cadwyn/actions/workflows/test.yaml/badge.svg?branch=main&event=push" alt="Test">\n</a>\n<a href="https://codecov.io/gh/ovsyanka83/cadwyn" target="_blank">\n    <img src="https://img.shields.io/codecov/c/github/ovsyanka83/cadwyn?color=%2334D058" alt="Coverage">\n</a>\n<a href="https://pypi.org/project/cadwyn/" target="_blank">\n    <img alt="PyPI" src="https://img.shields.io/pypi/v/cadwyn?color=%2334D058&label=pypi%20package" alt="Package version">\n</a>\n<a href="https://pypi.org/project/cadwyn/" target="_blank">\n    <img src="https://img.shields.io/pypi/pyversions/cadwyn?color=%2334D058" alt="Supported Python versions">\n</a>\n</p>\n\n## Who is this for?\n\nCadwyn allows you to support a single version of your code, auto-generating the code/routes for older versions. You keep versioning encapsulated in small and independent "version change" modules while your business logic knows nothing about versioning.\n\nIts [approach](./docs/theory.md#ii-migration-based-response-building) will be useful if you want to:\n\n1. Support many (>2) API versions for a long time\n2. Effortlessly backport features and bugfixes to older API versions\n\n## Get started\n\nThe [documentation](https://docs.cadwyn.dev) has everything you need to get started. It is recommended to read it in the following order:\n\n1. [Tutorial](./tutorial.md)\n2. [Recipes](./recipes.md)\n3. [Reference](./reference.md)\n4. [Theory](./theory.md) <!-- TODO: Move section about cadwyn\'s approach to the beginning and move other approaches and "how we got here" to another article  -->\n\n## Similar projects\n\nThe following projects are trying to accomplish similar results with a lot more simplistic functionality.\n\n- <https://github.com/sjkaliski/pinned>\n- <https://github.com/phillbaker/gates>\n- <https://github.com/lukepolo/laravel-api-migrations>\n- <https://github.com/tomschlick/request-migrations>\n- <https://github.com/keygen-sh/request_migrations>\n',
     'author': 'Stanislav Zmiev',
     'author_email': 'zmievsa@gmail.com',
     'maintainer': 'None',

cadwyn-2.1.0rc1/cadwyn/header.py

@@ -1,28 +0,0 @@
-import datetime
-import types
-from collections.abc import Mapping
-from contextvars import ContextVar
-from typing import Any
-
-from fastapi import Depends, Header
-
-
-def get_cadwyn_dependency(
-    *,
-    version_header_name: str,
-    default_version: datetime.date | None = None,
-    extra_kwargs_to_header_constructor: Mapping[str, Any] = types.MappingProxyType({}),
-    api_version_var: ContextVar[datetime.date | None] | ContextVar[datetime.date],
-) -> Any:
-    if default_version is None:
-        extra_kwargs: Mapping[str, Any] = extra_kwargs_to_header_constructor
-    else:
-        extra_kwargs = extra_kwargs_to_header_constructor | {"default": default_version}
-
-    async def dependency(
-        api_version: datetime.date = Header(alias=version_header_name, **extra_kwargs),  # noqa: B008
-    ):
-        api_version_var.set(api_version)
-        return api_version
-
-    return Depends(dependency)