cadwyn 3.4.2__tar.gz → 3.4.4__tar.gz

{cadwyn-3.4.2 → cadwyn-3.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 3.4.2
+Version: 3.4.4
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT

{cadwyn-3.4.2 → cadwyn-3.4.4}/cadwyn/codegen/_plugins/latest_version_aliasing.py

@@ -64,8 +64,6 @@ class _ImportedModule:
         module = f"{self.path}.{self.name}"
         name = ast.alias(name="*")
         level = self.how_far_up_is_base_schema_dir_from_current_module
-        if level == 2 and self.is_package:
-            level -= 1
 
         return ast.ImportFrom(
             level=level,

{cadwyn-3.4.2 → cadwyn-3.4.4}/cadwyn/exceptions.py

@@ -25,6 +25,10 @@ class RouterGenerationError(CadwynError):
     pass
 
 
+class RouterPathParamsModifiedError(RouterGenerationError):
+    pass
+
+
 class RouteAlreadyExistsError(RouterGenerationError):
     def __init__(self, *routes: APIRoute):
         self.routes = routes

{cadwyn-3.4.2 → cadwyn-3.4.4}/cadwyn/routing.py

@@ -1,5 +1,6 @@
 import functools
 import inspect
+import re
 import sys
 import typing
 import warnings
@@ -45,7 +46,13 @@ from typing_extensions import Self, assert_never
 from cadwyn._compat import model_fields, rebuild_fastapi_body_param
 from cadwyn._package_utils import get_package_path_from_module, get_version_dir_path
 from cadwyn._utils import Sentinel, UnionType, get_another_version_of_module
-from cadwyn.exceptions import CadwynError, ModuleIsNotVersionedError, RouteAlreadyExistsError, RouterGenerationError
+from cadwyn.exceptions import (
+    CadwynError,
+    ModuleIsNotVersionedError,
+    RouteAlreadyExistsError,
+    RouterGenerationError,
+    RouterPathParamsModifiedError,
+)
 from cadwyn.structure import Version, VersionBundle
 from cadwyn.structure.common import Endpoint, VersionDate
 from cadwyn.structure.endpoints import (
@@ -624,6 +631,19 @@ def _apply_endpoint_had_instruction(
                     " It means that your version change has no effect on the attribute"
                     " and can be removed.",
                 )
+            if attr_name == "path":
+                original_path_params = {p.alias for p in original_route.dependant.path_params}
+                new_path_params = set(re.findall("{(.*?)}", attr))
+                if new_path_params != original_path_params:
+                    raise RouterPathParamsModifiedError(
+                        f'When altering the path of "{original_route.path}" in "{version_change.__name__}",'
+                        " you have tried to change its path params "
+                        f'from "{list(original_route.methods)}" to "{list(new_path_params)}". It is not allowed to '
+                        "change the path params of a route because the endpoint was created to handle the old path "
+                        "params. In fact, there is no need to change them because the change of path params is "
+                        "not a breaking change. If you really need to change the path params, you should create a "
+                        "new route with the new path params and delete the old one.",
+                    )
             setattr(original_route, attr_name, attr)
 
 

{cadwyn-3.4.2 → cadwyn-3.4.4}/cadwyn/structure/versions.py

@@ -303,13 +303,13 @@ class VersionBundle:
         self,
         body_type: type[BaseModel] | None,
         latest_dependant_with_internal_schema: Dependant,
+        path: str,
         request: FastapiRequest,
         response: FastapiResponse,
         request_info: RequestInfo,
         current_version: VersionDate,
         latest_route: APIRoute,
     ) -> dict[str, Any]:
-        path = request.scope["path"]
         method = request.method
         for v in reversed(self.versions):
             if v.value <= current_version:
@@ -363,7 +363,6 @@ class VersionBundle:
         Returns:
             Modified data
         """
-
         for v in self.versions:
             if v.value <= current_version:
                 break
@@ -396,7 +395,6 @@ class VersionBundle:
             async def decorator(*args: Any, **kwargs: Any) -> _R:
                 request: FastapiRequest = kwargs[request_param_name]
                 response: FastapiResponse = kwargs[response_param_name]
-                path = request.scope["path"]
                 method = request.method
                 kwargs = await self._convert_endpoint_kwargs_to_version(
                     template_module_body_field_for_request_migrations,
@@ -413,7 +411,7 @@ class VersionBundle:
                 return await self._convert_endpoint_response_to_version(
                     endpoint,
                     latest_route,
-                    path,
+                    route,
                     method,
                     response_param_name,
                     kwargs,
@@ -433,7 +431,7 @@ class VersionBundle:
         self,
         func_to_get_response_from: Endpoint,
         latest_route: APIRoute,
-        path: str,
+        route: APIRoute,
         method: str,
         response_param_name: str,
         kwargs: dict[str, Any],
@@ -480,7 +478,7 @@ class VersionBundle:
             response_info,
             api_version,
             latest_route,
-            path,
+            route.path,
             method,
         )
         if isinstance(response_or_response_body, FastapiResponse):
@@ -545,6 +543,7 @@ class VersionBundle:
         new_kwargs = await self._migrate_request(
             template_module_body_field_for_request_migrations,
             latest_dependant_with_internal_schema,
+            route.path,
             request,
             response,
             request_info,

{cadwyn-3.4.2 → cadwyn-3.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cadwyn"
-version = "3.4.2"
+version = "3.4.4"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"

{cadwyn-3.4.2 → cadwyn-3.4.4}/setup.py

@@ -22,7 +22,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'cadwyn',
-    'version': '3.4.2',
+    'version': '3.4.4',
     'description': 'Production-ready community-driven modern Stripe-like API versioning in FastAPI',
     'long_description': '# Cadwyn\n\nProduction-ready community-driven modern [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 while auto-generating the schemas and routes for older versions. You keep API versioning encapsulated in small and independent "version change" modules while your business logic stays simple and knows nothing about versioning.\n\nIts [approach](https://docs.cadwyn.dev/theory/#ii-migration-based-response-building) will be useful if you want to:\n\n1. Support many API versions for a long time\n2. Effortlessly backport features and bugfixes to older API versions\n\nWhether you are a newbie in API versioning, a pro looking for a sophisticated tool, an experimenter looking to build a similar framework, or even someone who just wants to learn about all approaches to API versioning -- Cadwyn has the functionality, theory, and documentation to cover all the mentioned use cases.\n\n## Get started\n\nThe [documentation](https://docs.cadwyn.dev) has everything you need to succeed.\n\n## Sponsors\n\nThese are our gorgeous sponsors. They are using Cadwyn and are sponsoring it through various means. Contact [me](https://github.com/zmievsa) if you would like to become one too!\n\n[![Monite](https://docs.cadwyn.dev/img/sponsor_logos/monite.png)](https://docs.monite.com/)\n',
     'author': 'Stanislav Zmiev',