cadwyn 4.4.5__py3-none-any.whl → 4.5.0__py3-none-any.whl

cadwyn/route_generation.py

@@ -221,6 +221,8 @@ class _EndpointTransformer(Generic[_R, _WR]):
 
             for by_schema_converters in version_change.alter_request_by_schema_instructions.values():
                 for by_schema_converter in by_schema_converters:
+                    if not by_schema_converter.check_usage:  # pragma: no cover
+                        continue
                     missing_models = set(by_schema_converter.schemas) - head_request_bodies
                     if missing_models:
                         raise RouteRequestBySchemaConverterDoesNotApplyToAnythingError(
@@ -232,6 +234,8 @@ class _EndpointTransformer(Generic[_R, _WR]):
                         )
             for by_schema_converters in version_change.alter_response_by_schema_instructions.values():
                 for by_schema_converter in by_schema_converters:
+                    if not by_schema_converter.check_usage:  # pragma: no cover
+                        continue
                     missing_models = set(by_schema_converter.schemas) - head_response_models
                     if missing_models:
                         raise RouteResponseBySchemaConverterDoesNotApplyToAnythingError(
@@ -240,6 +244,9 @@ class _EndpointTransformer(Generic[_R, _WR]):
                             f"failed to find routes with the following response models: "
                             f"{[m.__name__ for m in missing_models]}. "
                             f"This means that you are trying to apply this converter to non-existing endpoint(s). "
+                            "If this is intentional and this converter really does not apply to any endpoints, then "
+                            "pass check_usage=False argument to "
+                            f"{version_change.__name__}.{by_schema_converter.transformer.__name__}"
                         )
 
     def _extract_all_routes_identifiers(

cadwyn/schema_generation.py

@@ -158,7 +158,7 @@ def migrate_response_body(
     *,
     latest_body: Any,
     version: VersionDate | str,
-):
+) -> Any:
     """Convert the data to a specific version
 
     Apply all version changes from latest until the passed version in reverse order

cadwyn/structure/data.py

@@ -86,6 +86,12 @@ class _AlterDataInstruction:
         return self.transformer(__request_or_response)
 
 
+@dataclass
+class _BaseAlterBySchemaInstruction:
+    schemas: tuple[Any, ...]
+    check_usage: bool = True
+
+
 ##########
 # Requests
 ##########
@@ -97,8 +103,7 @@ class _BaseAlterRequestInstruction(_AlterDataInstruction):
 
 
 @dataclass
-class _AlterRequestBySchemaInstruction(_BaseAlterRequestInstruction):
-    schemas: tuple[Any, ...]
+class _AlterRequestBySchemaInstruction(_BaseAlterBySchemaInstruction, _BaseAlterRequestInstruction): ...
 
 
 @dataclass
@@ -110,7 +115,10 @@ class _AlterRequestByPathInstruction(_BaseAlterRequestInstruction):
 
 @overload
 def convert_request_to_next_version_for(
-    first_schema: type, /, *additional_schemas: type
+    first_schema: type,
+    /,
+    *additional_schemas: type,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]": ...
 
 
@@ -123,6 +131,7 @@ def convert_request_to_next_version_for(
     methods_or_second_schema: list[str] | None | type = None,
     /,
     *additional_schemas: type,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]":
     _validate_decorator_args(schema_or_path, methods_or_second_schema, additional_schemas)
 
@@ -141,6 +150,7 @@ def convert_request_to_next_version_for(
             return _AlterRequestBySchemaInstruction(
                 schemas=schemas,
                 transformer=transformer,
+                check_usage=check_usage,
             )
 
     return decorator  # pyright: ignore[reportReturnType]
@@ -158,8 +168,7 @@ class _BaseAlterResponseInstruction(_AlterDataInstruction):
 
 
 @dataclass
-class _AlterResponseBySchemaInstruction(_BaseAlterResponseInstruction):
-    schemas: tuple[Any, ...]
+class _AlterResponseBySchemaInstruction(_BaseAlterBySchemaInstruction, _BaseAlterResponseInstruction): ...
 
 
 @dataclass
@@ -175,6 +184,7 @@ def convert_response_to_previous_version_for(
     /,
     *schemas: type,
     migrate_http_errors: bool = False,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]": ...
 
 
@@ -194,6 +204,7 @@ def convert_response_to_previous_version_for(
     /,
     *additional_schemas: type,
     migrate_http_errors: bool = False,
+    check_usage: bool = True,
 ) -> "type[staticmethod[_P, None]]":
     _validate_decorator_args(schema_or_path, methods_or_second_schema, additional_schemas)
 
@@ -215,6 +226,7 @@ def convert_response_to_previous_version_for(
                 schemas=schemas,
                 transformer=transformer,
                 migrate_http_errors=migrate_http_errors,
+                check_usage=check_usage,
             )
 
     return decorator  # pyright: ignore[reportReturnType]

{cadwyn-4.4.5.dist-info → cadwyn-4.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cadwyn
-Version: 4.4.5
+Version: 4.5.0
 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

{cadwyn-4.4.5.dist-info → cadwyn-4.5.0.dist-info}/RECORD

@@ -9,20 +9,20 @@ cadwyn/changelogs.py,sha256=uveMizeeqNv0JuXza9Rkg0ulDEWyJL24bRxcHkHlwjI,20054
 cadwyn/exceptions.py,sha256=VlJKRmEGfFTDtHbOWc8kXK4yMi2N172K684Y2UIV8rI,1832
 cadwyn/middleware.py,sha256=kUZK2dmoricMbv6knPCIHpXEInX2670XIwAj0v_XQxk,3408
 cadwyn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cadwyn/route_generation.py,sha256=g-Ecx2cK7lqB2fgALp45RvdjGesFZi-Ng5-F96lbcDM,24642
+cadwyn/route_generation.py,sha256=tdIsdDIBY4hVUlTGMh4pTMM92LzxhV9CmGs6J8iAhaw,25152
 cadwyn/routing.py,sha256=mZRe7ivfTY2qdgrCBO4AHvKQq6Dazf7g_8B6aCrTgN8,7221
-cadwyn/schema_generation.py,sha256=_GnYH-77NourN8YfQEzrpgeb_1oF2A9exnPhYNF1JW4,40743
+cadwyn/schema_generation.py,sha256=OUOcBfIDFviSqIYy0a2EHVWWSh1n2GKbvtr5xuolFgQ,40750
 cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cadwyn/static/docs.html,sha256=WNm5ANJVy51TcIUFOaqKf1Z8eF86CC85TTHPxACtkzw,3455
 cadwyn/structure/__init__.py,sha256=Wgvjdq3vfl9Yhe-BkcFGAMi_Co11YOfTmJQqgF5Gzx4,655
 cadwyn/structure/common.py,sha256=GUclfxKLRlFwPjT237fCtLIzdvjvC9gI3acuxBizwbg,414
-cadwyn/structure/data.py,sha256=Wbm7U9uHG9aCyyqMMTwMUZ8X16Q0e1_YpYyed-aDzFU,7376
+cadwyn/structure/data.py,sha256=uViRW4uOOonXZj90hOlPNk02AIwp0fvDNoF8M5_CEes,7707
 cadwyn/structure/endpoints.py,sha256=8lrc4xanCt7gat106yYRIQC0TNxzFkLF-urIml_d_X0,5934
 cadwyn/structure/enums.py,sha256=bZL-iUOUFi9ZYlMZJw-tAix2yrgCp3gH3N2gwO44LUU,1043
 cadwyn/structure/schemas.py,sha256=bck4XzCOICVuohh-ZpIv4l57hx3l-f0O23b7w8n2WvA,8215
 cadwyn/structure/versions.py,sha256=L07vdC9d7_h4WKV8TArgZKfgfzB8-M4f62FXZm8o1TM,33232
-cadwyn-4.4.5.dist-info/METADATA,sha256=Daqhrd2_iWhKP60jJvEZYEtJSMh4SDIMpPFXgrCLSTc,4504
-cadwyn-4.4.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cadwyn-4.4.5.dist-info/entry_points.txt,sha256=mGX8wl-Xfhpr5M93SUmkykaqinUaYAvW9rtDSX54gx0,47
-cadwyn-4.4.5.dist-info/licenses/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
-cadwyn-4.4.5.dist-info/RECORD,,
+cadwyn-4.5.0.dist-info/METADATA,sha256=7V9B9KEfVWvWZPDZBCNLgGYMRqvJ1w2-bX69O9z8xmY,4504
+cadwyn-4.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cadwyn-4.5.0.dist-info/entry_points.txt,sha256=mGX8wl-Xfhpr5M93SUmkykaqinUaYAvW9rtDSX54gx0,47
+cadwyn-4.5.0.dist-info/licenses/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
+cadwyn-4.5.0.dist-info/RECORD,,