cadwyn 2.3.0rc0__tar.gz → 2.3.1__tar.gz

{cadwyn-2.3.0rc0 → cadwyn-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 2.3.0rc0
+Version: 2.3.1
 Summary: Modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
@@ -35,7 +35,7 @@ Requires-Dist: fastapi (>=0.96.1)
 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.4,<0.0.5)
+Requires-Dist: verselect (>=0.0.6)
 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.3.0rc0 → cadwyn-2.3.1}/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.3.0rc0 → cadwyn-2.3.1}/cadwyn/__init__.py

@@ -1,11 +1,13 @@
 import importlib.metadata
 
 from .codegen import generate_code_for_versioned_packages
+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",
     "generate_code_for_versioned_packages",
     "VersionBundle",

{cadwyn-2.3.0rc0 → cadwyn-2.3.1}/cadwyn/main.py

@@ -18,7 +18,7 @@ from cadwyn.routing import generate_versioned_routers
 from cadwyn.structure import VersionBundle
 
 
-class _Cadwyn(HeaderRoutingFastAPI):
+class Cadwyn(HeaderRoutingFastAPI):
     def __init__(
         self,
         *,
@@ -37,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,
@@ -77,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,

{cadwyn-2.3.0rc0 → cadwyn-2.3.1}/cadwyn/routing.py

@@ -41,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
@@ -55,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)
@@ -72,7 +79,7 @@ class _EndpointInfo:
 @dataclass(slots=True)
 class _RouterInfo(Generic[_R]):
     router: _R
-    routes_with_migrated_requests: dict[EndpointPath, set[EndpointMethod]]
+    routes_with_migrated_requests: dict[_EndpointPath, set[_EndpointMethod]]
     route_bodies_with_migrated_requests: set[type[BaseModel]]
 
 
@@ -447,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
 
@@ -673,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
     ]
@@ -683,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.3.0rc0 → cadwyn-2.3.1}/cadwyn/structure/versions.py

@@ -207,25 +207,27 @@ class Version:
 class VersionBundle:
     def __init__(
         self,
-        *versions: Version,
+        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:

{cadwyn-2.3.0rc0 → cadwyn-2.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "2.3.0.rc0"
+version = "2.3.1"
 description = "Modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
@@ -36,7 +36,7 @@ typing-extensions = "*"
 fastapi = ">=0.96.1"
 pydantic = "^1.10.0"
 typer = {version = ">=0.7.0", optional = true}
-verselect-zmievsa = "^0.0.4"
+verselect = ">=0.0.6"
 
 [tool.poetry.extras]
 cli = ["typer"]

{cadwyn-2.3.0rc0 → cadwyn-2.3.1}/setup.py

@@ -11,7 +11,7 @@ install_requires = \
 ['fastapi>=0.96.1',
  'pydantic>=1.10.0,<2.0.0',
  'typing-extensions',
- 'verselect-zmievsa>=0.0.4,<0.0.5']
+ 'verselect>=0.0.6']
 
 extras_require = \
 {'cli': ['typer>=0.7.0']}
@@ -21,9 +21,9 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'cadwyn',
-    'version': '2.3.0rc0',
+    'version': '2.3.1',
     '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',