cadwyn 4.0.0__py3-none-any.whl → 4.2.0__py3-none-any.whl

cadwyn/structure/versions.py

@@ -23,7 +23,7 @@ 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 assert_never
+from typing_extensions import assert_never, deprecated
 
 from cadwyn._utils import classproperty
 from cadwyn.exceptions import (
@@ -64,6 +64,7 @@ IdentifierPythonPath = str
 
 class VersionChange:
     description: ClassVar[str] = Sentinel
+    is_hidden_from_changelog: bool = False
     instructions_to_migrate_to_previous_version: ClassVar[Sequence[PossibleInstructions]] = Sentinel
     alter_schema_instructions: ClassVar[list[AlterSchemaSubInstruction | SchemaHadInstruction]] = Sentinel
     alter_enum_instructions: ClassVar[list[AlterEnumSubInstruction]] = Sentinel
@@ -198,24 +199,29 @@ class VersionChangeWithSideEffects(VersionChange, _abstract=True):
 
 
 class Version:
-    def __init__(self, value: VersionDate | str, *version_changes: type[VersionChange]) -> None:
+    def __init__(self, value: VersionDate | str, *changes: type[VersionChange]) -> None:
         super().__init__()
 
         if isinstance(value, str):
             value = date.fromisoformat(value)
         self.value = value
-        self.version_changes = version_changes
+        self.changes = changes
+
+    @property
+    @deprecated("'version_changes' attribute is deprecated and will be removed in Cadwyn 5.x.x. Use 'changes' instead.")
+    def version_changes(self):  # pragma: no cover
+        return self.changes
 
     def __repr__(self) -> str:
         return f"Version('{self.value}')"
 
 
 class HeadVersion:
-    def __init__(self, *version_changes: type[VersionChange]) -> None:
+    def __init__(self, *changes: type[VersionChange]) -> None:
         super().__init__()
-        self.version_changes = version_changes
+        self.changes = changes
 
-        for version_change in version_changes:
+        for version_change in changes:
             if any(
                 [
                     version_change.alter_request_by_path_instructions,
@@ -228,6 +234,11 @@ class HeadVersion:
                     f"HeadVersion does not support request or response migrations but {version_change} contained one."
                 )
 
+    @property
+    @deprecated("'version_changes' attribute is deprecated and will be removed in Cadwyn 5.x.x. Use 'changes' instead.")
+    def version_changes(self):  # pragma: no cover
+        return self.changes
+
 
 def get_cls_pythonpath(cls: type) -> IdentifierPythonPath:
     return f"{cls.__module__}.{cls.__name__}"
@@ -260,7 +271,7 @@ class VersionBundle:
             )
         if not self.versions:
             raise CadwynStructureError("You must define at least one non-head version in a VersionBundle.")
-        if self.versions[-1].version_changes:
+        if self.versions[-1].changes:
             raise CadwynStructureError(
                 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 "
@@ -275,7 +286,7 @@ class VersionBundle:
                     f"You tried to define two versions with the same value in the same "
                     f"{VersionBundle.__name__}: '{version.value}'.",
                 )
-            for version_change in version.version_changes:
+            for version_change in version.changes:
                 if version_change._bound_version_bundle is not None:
                     raise CadwynStructureError(
                         f"You tried to bind version change '{version_change.__name__}' to two different versions. "
@@ -295,14 +306,14 @@ class VersionBundle:
         altered_schemas = {
             get_cls_pythonpath(instruction.schema): instruction.schema
             for version in self._all_versions
-            for version_change in version.version_changes
+            for version_change in version.changes
             for instruction in list(version_change.alter_schema_instructions)
         }
 
         migrated_schemas = {
             get_cls_pythonpath(schema): schema
             for version in self._all_versions
-            for version_change in version.version_changes
+            for version_change in version.changes
             for schema in list(version_change.alter_request_by_schema_instructions.keys())
         }
 
@@ -313,7 +324,7 @@ class VersionBundle:
         return {
             get_cls_pythonpath(instruction.enum): instruction.enum
             for version in self._all_versions
-            for version_change in version.version_changes
+            for version_change in version.changes
             for instruction in version_change.alter_enum_instructions
         }
 
@@ -327,9 +338,7 @@ class VersionBundle:
     def _version_changes_to_version_mapping(
         self,
     ) -> dict[type[VersionChange] | type[VersionChangeWithSideEffects], VersionDate]:
-        return {
-            version_change: version.value for version in self.versions for version_change in version.version_changes
-        }
+        return {version_change: version.value for version in self.versions for version_change in version.changes}
 
     async def _migrate_request(
         self,
@@ -347,7 +356,7 @@ class VersionBundle:
         for v in reversed(self.versions):
             if v.value <= current_version:
                 continue
-            for version_change in v.version_changes:
+            for version_change in v.changes:
                 if body_type is not None and body_type in version_change.alter_request_by_schema_instructions:
                     for instruction in version_change.alter_request_by_schema_instructions[body_type]:
                         instruction(request_info)
@@ -394,7 +403,7 @@ class VersionBundle:
         for v in self.versions:
             if v.value <= current_version:
                 break
-            for version_change in v.version_changes:
+            for version_change in v.changes:
                 migrations_to_apply: list[_BaseAlterResponseInstruction] = []
 
                 if head_response_model and head_response_model in version_change.alter_response_by_schema_instructions:

{cadwyn-4.0.0.dist-info → cadwyn-4.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 4.0.0
+Version: 4.2.0
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
@@ -32,6 +32,7 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Provides-Extra: cli
+Requires-Dist: backports-strenum (>=1.3.1,<2.0.0) ; python_version < "3.11"
 Requires-Dist: fastapi (>=0.110.0)
 Requires-Dist: issubclass (>=0.1.2,<0.2.0)
 Requires-Dist: jinja2 (>=3.1.2)

cadwyn-4.2.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+cadwyn/__init__.py,sha256=w4Iu8rEu9zfptMKsBaWgAj0vJABKGJukKYQBNbuwt1Q,1035
+cadwyn/__main__.py,sha256=fGoKJPNVueqqXW4rqwmRUBBMoDGeLEyATdT-rel5Pvs,2449
+cadwyn/_asts.py,sha256=kNDXS0Ju0pYZyohAmJNVgJpspwKai5_a9tbekkGehUE,5130
+cadwyn/_importer.py,sha256=2mZrDHlfY2heZsMBW-9RBpvKsCk9I-Wa8pxZ6f2f8gY,1074
+cadwyn/_render.py,sha256=LJ-R1TrBgMJpTkJb6pQdRWaMjKyw3R6eTlXXEieqUw0,5466
+cadwyn/_utils.py,sha256=GK9w_qzyOI_o6UaGVfwLLYhnJFMzXistoYI9fq2E9dE,1159
+cadwyn/applications.py,sha256=Ar-wHBp6om5K_g74JsJwMO0NscKPQpUouWg-1H5a2iQ,15495
+cadwyn/changelogs.py,sha256=SdrdAKQ01mpzs-EN_zg-D0TY7wxsibjRjLMhGcI4q80,20066
+cadwyn/exceptions.py,sha256=VlJKRmEGfFTDtHbOWc8kXK4yMi2N172K684Y2UIV8rI,1832
+cadwyn/middleware.py,sha256=8cuBri_yRkl0goe6G0MLwtL04WGbW9Infah3wy9hUVM,3372
+cadwyn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cadwyn/route_generation.py,sha256=-4HJWH2AoyGuB4qER-Gjc6kgUYUpzo_FoSkw3Gyi6rU,22872
+cadwyn/routing.py,sha256=9AHSojmuLgUAQlLMIqXz-ViZ9n-fljgOsn7oxha7PjM,7341
+cadwyn/schema_generation.py,sha256=rqiKM-Z5owqkvntNeW4j32gVAzn9_ToAxQNHOWEgZ5Y,39967
+cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cadwyn/static/docs.html,sha256=WNm5ANJVy51TcIUFOaqKf1Z8eF86CC85TTHPxACtkzw,3455
+cadwyn/structure/__init__.py,sha256=vej7TdTMSOg8U8Wk7GTNdA4rc6loA9083FWaTg4jAaY,655
+cadwyn/structure/common.py,sha256=GUclfxKLRlFwPjT237fCtLIzdvjvC9gI3acuxBizwbg,414
+cadwyn/structure/data.py,sha256=1ALPhBBCE_t4GrxM0Fa3hQ-jkORJgeWNySnZ42bsi0g,7382
+cadwyn/structure/endpoints.py,sha256=9FFnbqPM9v0CP6J6tGhMNKVvWqA9u3ZjI2Fannr2Rl0,5933
+cadwyn/structure/enums.py,sha256=bZL-iUOUFi9ZYlMZJw-tAix2yrgCp3gH3N2gwO44LUU,1043
+cadwyn/structure/schemas.py,sha256=D0BD1D3v9MRdVWchU9JM2zHd0dvB0UgXHDGFCe5aQZc,8209
+cadwyn/structure/versions.py,sha256=cyBSVyYwe50V8g19G7y2rIFR6OxSVAF9Q98u1GNZiyU,32533
+cadwyn-4.2.0.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
+cadwyn-4.2.0.dist-info/METADATA,sha256=X7fWn-_w1M3y189xXqfh2Os2se0yTlnnl2COTRfuXSo,4420
+cadwyn-4.2.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+cadwyn-4.2.0.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
+cadwyn-4.2.0.dist-info/RECORD,,

cadwyn-4.0.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-cadwyn/__init__.py,sha256=N98kE6Eb7g7mH-YW1XuAqb084W2NKvPhA1cUs_O0nak,930
-cadwyn/__main__.py,sha256=fGoKJPNVueqqXW4rqwmRUBBMoDGeLEyATdT-rel5Pvs,2449
-cadwyn/_asts.py,sha256=kNDXS0Ju0pYZyohAmJNVgJpspwKai5_a9tbekkGehUE,5130
-cadwyn/_importer.py,sha256=2mZrDHlfY2heZsMBW-9RBpvKsCk9I-Wa8pxZ6f2f8gY,1074
-cadwyn/_render.py,sha256=-eY4zMzBEJPteDF_CRwJah5DWFmUl2zHQHrb21mcfb8,5482
-cadwyn/_utils.py,sha256=GK9w_qzyOI_o6UaGVfwLLYhnJFMzXistoYI9fq2E9dE,1159
-cadwyn/applications.py,sha256=g4VlB3SzQMjfAq5vX8u6DYj2OZei2oGBffSUTVVyaAA,14478
-cadwyn/exceptions.py,sha256=VlJKRmEGfFTDtHbOWc8kXK4yMi2N172K684Y2UIV8rI,1832
-cadwyn/middleware.py,sha256=8cuBri_yRkl0goe6G0MLwtL04WGbW9Infah3wy9hUVM,3372
-cadwyn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cadwyn/route_generation.py,sha256=GiCUCAKFQoIID3Zv5dYGTIbsGu3TSxDnB62ZUH-Mh58,22961
-cadwyn/routing.py,sha256=9AHSojmuLgUAQlLMIqXz-ViZ9n-fljgOsn7oxha7PjM,7341
-cadwyn/schema_generation.py,sha256=SZoP0IPgVdlJ015ItW5dxwvlWYcA41Lx1pQzCOwV7TE,39386
-cadwyn/static/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cadwyn/static/docs.html,sha256=WNm5ANJVy51TcIUFOaqKf1Z8eF86CC85TTHPxACtkzw,3455
-cadwyn/structure/__init__.py,sha256=vej7TdTMSOg8U8Wk7GTNdA4rc6loA9083FWaTg4jAaY,655
-cadwyn/structure/common.py,sha256=6Z4nI97XPWTCinn6np73m-rLPyYNrz2fWXKJlqjsiaQ,269
-cadwyn/structure/data.py,sha256=1ALPhBBCE_t4GrxM0Fa3hQ-jkORJgeWNySnZ42bsi0g,7382
-cadwyn/structure/endpoints.py,sha256=JhTgVrqLjm5LkE9thjvU1UuWcSCmDgW2bMdqznsZb2Y,5777
-cadwyn/structure/enums.py,sha256=iMokxA2QYJ61SzyB-Pmuq3y7KL7-e6TsnjLVUaVZQnw,954
-cadwyn/structure/schemas.py,sha256=dfVeVL6R6RjcNeehbd4yPlCYCkpiHi0Ujrwkq4pCvd8,9285
-cadwyn/structure/versions.py,sha256=3SXzQD9Ps3jukF6prhGTABUAik70jd7KebTApY8B3Ns,32190
-cadwyn-4.0.0.dist-info/LICENSE,sha256=KeCWewiDQYpmSnzF-p_0YpoWiyDcUPaCuG8OWQs4ig4,1072
-cadwyn-4.0.0.dist-info/METADATA,sha256=0Exz0MGTvNEndoEkQ4xJ8Nn_c3Puk52utPDTJtrCIx0,4344
-cadwyn-4.0.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-cadwyn-4.0.0.dist-info/entry_points.txt,sha256=eO05hLn9GoRzzpwT9GONPmXKsonjuMNssM2D2WHWKGk,46
-cadwyn-4.0.0.dist-info/RECORD,,