cadwyn 3.1.0__tar.gz → 3.1.2__tar.gz

{cadwyn-3.1.0 → cadwyn-3.1.2}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: cadwyn
-Version: 3.1.0
+Version: 3.1.2
 Summary: Production-ready community-driven modern Stripe-like API versioning in FastAPI
 Home-page: https://github.com/zmievsa/cadwyn
 License: MIT
+Keywords: python,api,json-schema,stripe,versioning,code-generation,hints,api-versioning,pydantic,fastapi,python310,python311,python312
 Author: Stanislav Zmiev
 Author-email: zmievsa@gmail.com
 Requires-Python: >=3.10,<4.0
@@ -22,6 +23,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
@@ -37,6 +41,7 @@ Requires-Dist: pydantic (>=1.0.0)
 Requires-Dist: typer (>=0.7.0); extra == "cli"
 Requires-Dist: typing-extensions
 Requires-Dist: verselect (>=0.0.6)
+Project-URL: Documentation, https://docs.cadwyn.dev
 Project-URL: Repository, https://github.com/zmievsa/cadwyn
 Description-Content-Type: text/markdown
 

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/_compat.py

@@ -63,7 +63,6 @@ def get_attrs_that_are_not_from_field_and_that_are_from_field(value: type):
 
 @dataclasses.dataclass(slots=True)
 class PydanticFieldWrapper:
-    # TODO: What's the difference between these two? I keep forgetting
     annotation: Any
 
     init_model_field: dataclasses.InitVar[ModelField]  # pyright: ignore[reportGeneralTypeIssues]
@@ -92,7 +91,6 @@ class PydanticFieldWrapper:
         else:
             setattr(self.field_info, name, value)
 
-    # TODO: If we ever have performance issues  with this -- it makes sense to cache and update it in update_attribute
     @property
     def passed_field_attributes(self):
         if PYDANTIC_V2:

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/_package_utils.py

@@ -29,6 +29,7 @@ def get_version_dir_path(template_package: ModuleType, version: date) -> Path:
 
 
 def get_package_path_from_module(template_package: ModuleType) -> Path:
+    # Can be cached in the future to gain some speedups
     file = inspect.getsourcefile(template_package)
 
     # I am too lazy to reproduce this error correctly

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_asts.py

@@ -126,9 +126,10 @@ def transform_type(value: type) -> Any:
                 + ")"
             )
         else:
-            # TODO: Finish this comment :D
             # In pydantic V1:
-            # MRO of conint looks like: []
+            # MRO of constr looks like: [ConstrainedStrValue, pydantic.types.ConstrainedStr, str, object]
+            #                                                                                -2     -1
+            #                                                                                ^^^
             value = value.mro()[-2]
 
     return value.__name__
@@ -181,6 +182,7 @@ def _get_lambda_source_from_default_factory(source: str) -> str:
 
 
 def read_python_module(module: ModuleType) -> str:
+    # Can be cached in the future to gain some speedups
     try:
         return inspect.getsource(module)
     except OSError as e:

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_common.py

@@ -113,7 +113,7 @@ class GlobalCodegenContext:
 @dataclasses.dataclass(slots=True, kw_only=True)
 class CodegenContext(GlobalCodegenContext):
     # This attribute is extremely useful for calculating relative imports
-    index_of_latest_schema_dir_in_module_python_path: int
+    index_of_latest_package_dir_in_module_python_path: int
     module_python_path: str
     module_path: Path
     template_module: ModuleType

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_main.py

@@ -92,7 +92,6 @@ def _generate_versioned_directories(
     codegen_plugins: Collection[CodegenPlugin],
     migration_plugins: Collection[MigrationPlugin],
 ):
-    # TODO: An alternative structure for module python path: An object similar to pathlib.Path with .name, etc
     for version in versions:
         global_context = GlobalCodegenContext(
             current_version=version,
@@ -113,7 +112,6 @@ def _generate_directory_for_version(
     version: Version,
     global_context: GlobalCodegenContext,
 ):
-    # TODO: This call can be optimized
     template_dir = get_package_path_from_module(template_package)
     version_dir = get_version_dir_path(template_package, version.value)
     for (
@@ -178,27 +176,24 @@ def _build_context(
         parsed_file,
         module_python_path,
     )
-    version_dir = template_dir.with_name(version_dir.name)
-    index_of_latest_schema_dir_in_module_python_path = get_index_of_latest_schema_dir_in_module_python_path(
+    index_of_latest_package_dir_in_module_python_path = get_index_of_latest_schema_dir_in_module_python_path(
         template_module,
-        version_dir,
+        template_dir.with_name(version_dir.name),
     )
-    context: CodegenContext = CodegenContext(
+    return CodegenContext(
         current_version=global_context.current_version,
         versions=global_context.versions,
         schemas=global_context.schemas,
         enums=global_context.enums,
         modules=global_context.modules,
         extra=global_context.extra,
-        index_of_latest_schema_dir_in_module_python_path=index_of_latest_schema_dir_in_module_python_path,
+        index_of_latest_package_dir_in_module_python_path=index_of_latest_package_dir_in_module_python_path,
         module_python_path=module_python_path,
         all_names_defined_on_toplevel_of_file=all_names_defined_at_toplevel_of_file,
         template_module=template_module,
         module_path=parallel_file,
     )
 
-    return context
-
 
 def _generate_parallel_directory(
     template_module: ModuleType,

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_plugins/class_migrations.py

@@ -38,8 +38,6 @@ def _apply_alter_schema_instructions(
     alter_schema_instructions: Sequence[AlterSchemaSubInstruction | AlterSchemaInstruction],
     version_change_name: str,
 ):
-    # TODO: If we have a request migration for an endpoint instead of a schema and we haven't found that endpoint
-    # during codegen -- raise an error or maybe add an argument that controlls that. Or maybe this is overengineering..
     for alter_schema_instruction in alter_schema_instructions:
         schema = alter_schema_instruction.schema
         schema_path = get_cls_pythonpath(schema)
@@ -118,10 +116,10 @@ def _add_field_to_model(
         )
 
     model.fields[alter_schema_instruction.field_name] = PydanticFieldWrapper(
-        annotation_ast=None,  # TODO: Get this from migration
+        annotation_ast=None,
         annotation=alter_schema_instruction.type,
         init_model_field=alter_schema_instruction.field,
-        field_ast=None,  # TODO: Get this from migration
+        field_ast=None,
     )
 
 

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_plugins/class_rebuilding.py

@@ -114,13 +114,11 @@ def _render_annotation(annotation: Any):
 
 
 def _generate_field_ast(field: PydanticFieldWrapper):
-    # TODO: Make sure that cadwyn doesn't remove OLD property definitions
     if field.field_ast is not None:
         # We do this because next plugins **might** use a transformer which will edit the ast within the field
         # and break rendering
         return copy.deepcopy(field.field_ast)
     passed_attrs = field.passed_field_attributes
-    # TODO: This is None check feels buggy
     if is_pydantic_constrained_type(field.annotation) and field.annotation_ast is None:
         (
             attrs_that_are_only_in_contype,

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/codegen/_plugins/latest_version_aliasing.py

@@ -21,7 +21,7 @@ class LatestVersionAliasingPlugin:
         imports = _prepare_imports_from_version_dirs(
             context.template_module,
             ["latest"],
-            context.index_of_latest_schema_dir_in_module_python_path,
+            context.index_of_latest_package_dir_in_module_python_path,
         )
 
         import_text = ast.unparse(imports[0].get_ast()) + " # noqa: F403"
@@ -64,7 +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
-        # TODO: Add a testcase where is_package == True and level == 3
         if self.is_package and level == 2:
             level -= 1
         return ast.ImportFrom(
@@ -77,7 +76,7 @@ class _ImportedModule:
 def _prepare_imports_from_version_dirs(
     original_module: ModuleType,
     version_dir_names: Collection[str],
-    index_of_latest_schema_dir_in_pythonpath: int,
+    index_of_latest_package_dir_in_pythonpath: int,
 ) -> list[_ImportedModule]:
     # package.latest                     -> from .. import latest
     # package.latest.module              -> from ...latest import module
@@ -90,16 +89,16 @@ def _prepare_imports_from_version_dirs(
     # package.latest.subpackage.module  -> from ...latest.subpackage.module import *
 
     original_module_parts = original_module.__name__.split(".")
-    original_module_parts[index_of_latest_schema_dir_in_pythonpath] = "{}"
+    original_module_parts[index_of_latest_package_dir_in_pythonpath] = "{}"
     how_far_up_is_base_schema_dir_from_current_module = (
-        len(original_module_parts) - index_of_latest_schema_dir_in_pythonpath
+        len(original_module_parts) - index_of_latest_package_dir_in_pythonpath
     )
     is_package = original_module_parts[-1] == "__init__"
     if is_package:
         original_module_parts.pop(-1)
 
     package_name = original_module_parts[-1]
-    package_path = original_module_parts[index_of_latest_schema_dir_in_pythonpath:-1]
+    package_path = original_module_parts[index_of_latest_package_dir_in_pythonpath:-1]
     import_pythonpath_template = ".".join(package_path)
     absolute_python_path_template = ".".join(original_module_parts)
     return [

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/routing.py

@@ -41,7 +41,6 @@ from starlette.routing import (
     request_response,
 )
 from typing_extensions import Self, assert_never
-from verselect.routing import VERSION_HEADER_FORMAT
 
 from cadwyn._compat import model_fields, rebuild_fastapi_body_param
 from cadwyn._package_utils import get_package_path_from_module, get_version_dir_path
@@ -56,12 +55,6 @@ 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.
@@ -127,8 +120,10 @@ class _EndpointTransformer(Generic[_R]):
         ]
 
     def transform(self) -> dict[VersionDate, _R]:
+        schema_to_internal_request_body_representation = _extract_internal_request_schemas_from_router(
+            self.parent_router
+        )
         router = deepcopy(self.parent_router)
-        schema_to_internal_request_body_representation = _extract_internal_request_schemas_from_router(router)
         router_infos: dict[VersionDate, _RouterInfo] = {}
         routes_with_migrated_requests = {}
         route_bodies_with_migrated_requests: set[type[BaseModel]] = set()
@@ -157,8 +152,6 @@ class _EndpointTransformer(Generic[_R]):
                 f"{self.routes_that_never_existed}",
             )
 
-        # BEWARE: We assume that the order of routes didn't change.
-        # TODO: Make a test suite checking that it doesn't change
         for route_index, latest_route in enumerate(self.parent_router.routes):
             if not isinstance(latest_route, APIRoute):
                 continue
@@ -166,11 +159,10 @@ class _EndpointTransformer(Generic[_R]):
             copy_of_dependant = deepcopy(latest_route.dependant)
             # Remember this: if len(body_params) == 1, then route.body_schema == route.dependant.body_params[0]
             if len(copy_of_dependant.body_params) == 1:
-                body_param: FastAPIModelField = copy_of_dependant.body_params[0]
-                body_schema = body_param.type_
-                new_type = schema_to_internal_request_body_representation.get(body_schema, body_schema)
-                new_body_param = rebuild_fastapi_body_param(body_param, new_type)
-                copy_of_dependant.body_params = [new_body_param]
+                self._replace_internal_representation_with_the_versioned_schema(
+                    copy_of_dependant,
+                    schema_to_internal_request_body_representation,
+                )
 
             for older_router_info in list(router_infos.values()):
                 older_route = older_router_info.router.routes[route_index]
@@ -188,11 +180,11 @@ class _EndpointTransformer(Generic[_R]):
                     template_older_body_model = None
                 _add_data_migrations_to_route(
                     older_route,
+                    # NOTE: The fact that we use latest here assumes that the route can never change its response schema
+                    latest_route,
                     template_older_body_model,
                     older_route.body_field.alias if older_route.body_field is not None else None,
                     copy_of_dependant,
-                    # NOTE: The fact that we use latest here assumes that the route can never change its response schema
-                    latest_route.response_model,
                     self.versions,
                 )
         for _, router_info in router_infos.items():
@@ -203,7 +195,18 @@ class _EndpointTransformer(Generic[_R]):
             ]
         return {version: router_info.router for version, router_info in router_infos.items()}
 
-    # TODO: Simplify https://github.com/zmievsa/cadwyn/issues/28
+    def _replace_internal_representation_with_the_versioned_schema(
+        self,
+        copy_of_dependant: Dependant,
+        schema_to_internal_request_body_representation: dict[type[BaseModel], type[BaseModel]],
+    ):
+        body_param: FastAPIModelField = copy_of_dependant.body_params[0]
+        body_schema = body_param.type_
+        new_type = schema_to_internal_request_body_representation.get(body_schema, body_schema)
+        new_body_param = rebuild_fastapi_body_param(body_param, new_type)
+        copy_of_dependant.body_params = [new_body_param]
+
+    # TODO (https://github.com/zmievsa/cadwyn/issues/28): Simplify
     def _apply_endpoint_changes_to_router(  # noqa: C901
         self,
         router: fastapi.routing.APIRouter,
@@ -223,7 +226,6 @@ class _EndpointTransformer(Generic[_R]):
                 methods_we_should_have_applied_changes_to = instruction.endpoint_methods.copy()
 
                 if isinstance(instruction, EndpointDidntExistInstruction):
-                    # TODO OPTIMIZATION:
                     deleted_routes = _get_routes(
                         routes,
                         instruction.endpoint_path,
@@ -250,7 +252,6 @@ class _EndpointTransformer(Generic[_R]):
                         ' "{version_change_name}" doesn\'t exist in a newer version'
                     )
                 elif isinstance(instruction, EndpointExistedInstruction):
-                    # TODO Optimization
                     if original_routes:
                         method_union = set()
                         for original_route in original_routes:
@@ -330,7 +331,9 @@ class _EndpointTransformer(Generic[_R]):
                     )
 
 
-def _extract_internal_request_schemas_from_router(router: fastapi.routing.APIRouter):
+def _extract_internal_request_schemas_from_router(
+    router: fastapi.routing.APIRouter,
+) -> dict[type[BaseModel], type[BaseModel]]:
     """Please note that this functon replaces internal bodies with original bodies in the router"""
     schema_to_internal_request_body_representation = {}
 
@@ -354,6 +357,7 @@ def _extract_internal_request_schemas_from_router(router: fastapi.routing.APIRou
                 route.endpoint,
                 modify_annotations=_extract_internal_request_schemas_from_annotations,
             )
+            _remake_endpoint_dependencies(route)
     return schema_to_internal_request_body_representation
 
 
@@ -580,10 +584,10 @@ def _add_request_and_response_params(route: APIRoute):
 
 def _add_data_migrations_to_route(
     route: APIRoute,
+    latest_route: Any,
     template_body_field: type[BaseModel] | None,
     template_body_field_name: str | None,
     dependant_for_request_migrations: Dependant,
-    latest_response_model: Any,
     versions: VersionBundle,
 ):
     if not (route.dependant.request_param_name and route.dependant.response_param_name):  # pragma: no cover
@@ -596,8 +600,8 @@ def _add_data_migrations_to_route(
         template_body_field,
         template_body_field_name,
         route,
+        latest_route,
         dependant_for_request_migrations,
-        latest_response_model,
         request_param_name=route.dependant.request_param_name,
         response_param_name=route.dependant.response_param_name,
     )(route.endpoint)

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/structure/data.py

@@ -12,7 +12,7 @@ from cadwyn._utils import same_definition_as_in
 _P = ParamSpec("_P")
 
 
-# TODO: Add form handling https://github.com/zmievsa/cadwyn/issues/49
+# TODO (https://github.com/zmievsa/cadwyn/issues/49): Add form handling
 class RequestInfo:
     __slots__ = ("body", "headers", "_cookies", "_query_params", "_request")
 
@@ -33,7 +33,7 @@ class RequestInfo:
         return self._query_params
 
 
-# TODO: handle media_type and background
+# TODO (https://github.com/zmievsa/cadwyn/issues/111): handle _response.media_type and _response.background
 class ResponseInfo:
     __slots__ = ("body", "_response")
 

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/structure/schemas.py

@@ -67,7 +67,7 @@ class OldSchemaFieldExistedWith:
     field: FieldInfo
 
 
-# TODO: Add an ability to add extras (use only pydanticV2 syntax everywhere)
+# TODO (https://github.com/zmievsa/cadwyn/issues/112): Add an ability to add extras
 @dataclass(slots=True)
 class AlterFieldInstructionFactory:
     schema: type[BaseModel]

{cadwyn-3.1.0 → cadwyn-3.1.2}/cadwyn/structure/versions.py

@@ -305,6 +305,7 @@ class VersionBundle:
         response: FastapiResponse,
         request_info: RequestInfo,
         current_version: VersionDate,
+        latest_route: APIRoute,
     ):
         path = request.scope["path"]
         method = request.method
@@ -329,8 +330,7 @@ class VersionBundle:
             response=response,
             dependant=dependant,
             body=request_info.body,
-            # TODO: Take it from route
-            dependency_overrides_provider=None,
+            dependency_overrides_provider=latest_route.dependency_overrides_provider,
         )
         if errors:
             raise RequestValidationError(_normalize_errors(errors), body=request_info.body)
@@ -340,7 +340,7 @@ class VersionBundle:
         self,
         response_info: ResponseInfo,
         current_version: VersionDate,
-        latest_response_model: Any | None,
+        latest_route: APIRoute,
         path: str,
         method: str,
     ) -> ResponseInfo:
@@ -361,24 +361,24 @@ class VersionBundle:
                 break
             for version_change in v.version_changes:
                 if (
-                    latest_response_model
-                    and latest_response_model in version_change.alter_response_by_schema_instructions
+                    latest_route.response_model
+                    and latest_route.response_model in version_change.alter_response_by_schema_instructions
                 ):
-                    version_change.alter_response_by_schema_instructions[latest_response_model](response_info)
+                    version_change.alter_response_by_schema_instructions[latest_route.response_model](response_info)
                 if path in version_change.alter_response_by_path_instructions:
                     for instruction in version_change.alter_response_by_path_instructions[path]:
                         if method in instruction.methods:
                             instruction(response_info)
         return response_info
 
-    # TODO: This function is all over the place. Refactor it and all functions it calls.
+    # TODO (https://github.com/zmievsa/cadwyn/issues/113): Refactor this function and all functions it calls.
     def _versioned(
         self,
         template_module_body_field_for_request_migrations: type[BaseModel] | None,
         module_body_field_name: str | None,
         route: APIRoute,
+        latest_route: APIRoute,
         dependant_for_request_migrations: Dependant,
-        latest_response_model: Any,
         *,
         request_param_name: str,
         response_param_name: str,
@@ -399,11 +399,12 @@ class VersionBundle:
                     kwargs,
                     response,
                     route,
+                    latest_route,
                 )
 
                 return await self._convert_endpoint_response_to_version(
                     endpoint,
-                    latest_response_model,
+                    latest_route,
                     path,
                     method,
                     response_param_name,
@@ -424,7 +425,7 @@ class VersionBundle:
     async def _convert_endpoint_response_to_version(
         self,
         func_to_get_response_from: Endpoint,
-        latest_response_model: Any,
+        latest_route: APIRoute,
         path: str,
         method: str,
         response_param_name: str,
@@ -434,8 +435,6 @@ class VersionBundle:
     ) -> Any:
         if response_param_name == _CADWYN_RESPONSE_PARAM_NAME:
             kwargs.pop(response_param_name)
-        # TODO: Verify that we handle fastapi.Response here
-        # TODO: Verify that we handle fastapi.Response descendants
         if endpoint_is_async_callable:
             response_or_response_body: FastapiResponse | object = await func_to_get_response_from(**kwargs)
         else:
@@ -449,22 +448,24 @@ class VersionBundle:
         if isinstance(response_or_response_body, FastapiResponse):
             response_info = ResponseInfo(
                 response_or_response_body,
-                # TODO: Give user the ability to specify their own renderer
-                # TODO: Only do this if there are migrations
+                # TODO (https://github.com/zmievsa/cadwyn/issues/51): Only do this if there are migrations
                 json.loads(response_or_response_body.body) if response_or_response_body.body else None,
             )
         else:
-            # TODO: We probably need to call this in the same way as in fastapi instead of hardcoding exclude_unset.
-            # We have such an ability if we force passing the route into this wrapper. Or maybe not... Important!
             response_info = ResponseInfo(
                 fastapi_response_dependency,
-                _prepare_response_content(response_or_response_body, exclude_unset=False),
+                _prepare_response_content(
+                    response_or_response_body,
+                    exclude_unset=latest_route.response_model_exclude_unset,
+                    exclude_defaults=latest_route.response_model_exclude_defaults,
+                    exclude_none=latest_route.response_model_exclude_none,
+                ),
             )
 
         response_info = self._migrate_response(
             response_info,
             api_version,
-            latest_response_model,
+            latest_route,
             path,
             method,
         )
@@ -476,8 +477,7 @@ class VersionBundle:
             # `RuntimeError: Response content longer than Content-Length` or
             # `Too much data for declared Content-Length`, based on the protocol
             if response_info.body is not None:
-                # TODO: Give user the ability to specify their own renderer
-                # TODO: Only do this if there are migrations
+                # TODO (https://github.com/zmievsa/cadwyn/issues/51): Only do this if there are migrations
                 response_info._response.body = json.dumps(response_info.body).encode()
             return response_info._response
         return response_info.body
@@ -491,6 +491,7 @@ class VersionBundle:
         kwargs: dict[str, Any],
         response: FastapiResponse,
         route: APIRoute,
+        latest_route: APIRoute,
     ):
         request: FastapiRequest = kwargs[request_param_name]
         if request_param_name == _CADWYN_REQUEST_PARAM_NAME:
@@ -500,7 +501,7 @@ 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
+        # TODO (https://github.com/zmievsa/cadwyn/issues/51): Make this zero-cost for migration-less cases
         if (
             len(route.dependant.body_params) == 1
             and template_module_body_field_for_request_migrations is not None
@@ -524,6 +525,7 @@ class VersionBundle:
             response,
             request_info,
             api_version,
+            latest_route,
         )
         # Because we re-added it into our kwargs when we did solve_dependencies
         if request_param_name == _CADWYN_REQUEST_PARAM_NAME:

{cadwyn-3.1.0 → cadwyn-3.1.2}/pyproject.toml

@@ -1,17 +1,36 @@
 [tool.poetry]
 name = "cadwyn"
-version = "3.1.0"
+version = "3.1.2"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = ["Stanislav Zmiev <zmievsa@gmail.com>"]
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/zmievsa/cadwyn"
+documentation = "https://docs.cadwyn.dev"
+keywords = [
+    "python",
+    "api",
+    "json-schema",
+    "stripe",
+    "versioning",
+    "code-generation",
+    "hints",
+    "api-versioning",
+    "pydantic",
+    "fastapi",
+    "python310",
+    "python311",
+    "python312",
+]
 classifiers = [
     "Intended Audience :: Information Technology",
     "Intended Audience :: System Administrators",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3",
     "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Internet",
     "Topic :: Software Development :: Libraries :: Application Frameworks",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -43,7 +62,6 @@ ast-comments = "~1.2.0"
 cli = ["typer"]
 
 [tool.poetry.group.dev.dependencies]
-black = "*"
 ruff = "*"
 pytest = ">=7.2.1"
 pytest-cov = ">=4.0.0"
@@ -59,6 +77,7 @@ dirty-equals = "^0.6.0"
 mkdocs = "^1.5.2"
 mkdocs-material = "^9.3.1"
 python-multipart = "^0.0.6"
+mkdocs-simple-hooks = "^0.1.5"
 
 [tool.poetry.scripts]
 cadwyn = "cadwyn.__main__:app"
@@ -89,17 +108,7 @@ exclude_lines = [
     "__rich_repr__",
     "__repr__",
 ]
-omit = [
-    "tests/test_tutorial/test_users_example003/*",
-    "tests/_data/*",
-    "tests/_temp/*",
-    "tests/test_tutorial/*/schemas/*",
-]
-
-[tool.black]
-color = true
-line-length = 120
-target-version = ["py310"]
+omit = ["./docs/plugin.py", "./site/plugin.py", "./tests/_data/_temp/**/*", "tests/tutorial/data/**/*"]
 
 [tool.pyright]
 reportMissingImports = true
@@ -120,7 +129,6 @@ reportAssertAlwaysTrue = true
 reportUnsupportedDunderAll = true
 reportUnnecessaryTypeIgnoreComment = true
 reportMissingSuperCall = true
-ignore=["cadwyn/_codegen/ast_comments.py"]
 
 
 [tool.ruff]
@@ -184,8 +192,28 @@ ignore = [
     "RET505", # Unnecessary `else` after `return` statement
     "N805",   # First argument of a method should be named `self`
     "UP007",  # Use `X | Y` for type annotations (we need this for testing and our runtime logic)
+
+    # The following rules are recommended to be ignored by ruff when using ruff format
+    "ISC001",  # Checks for implicitly concatenated strings on a single line
+    "ISC002",  # Checks for implicitly concatenated strings that span multiple lines
+    "W191",  # Checks for indentation that uses tabs
+    "E111",  # Checks for indentation with a non-multiple of 4 spaces
+    "E114",  # Checks for indentation of comments with a non-multiple of 4 spaces
+    "E117",  # Checks for over-indented code
+    "D206",  # Checks for docstrings that are indented with tabs
+    "D300",  # Checks for docstrings that use '''single quotes''' instead of """double quotes"""
+    "Q000",  # Checks for inline strings that use single quotes or double quotes
+    "Q001",  # Checks for multiline strings that use single quotes or double quotes
+    "Q002",  # Checks for docstrings that use single quotes or double quotes
+    "Q003",  # Checks for strings that include escaped quotes
+    "COM812",  # Checks for the absence of trailing commas
+    "COM819",  # Checks for the presence of prohibited trailing commas
 ]
 
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
 [tool.ruff.per-file-ignores]
 "tests/*" = [
     "S",      # ignore bandit security issues in tests

{cadwyn-3.1.0 → cadwyn-3.1.2}/setup.py

@@ -22,7 +22,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'cadwyn',
-    'version': '3.1.0',
+    'version': '3.1.2',
     '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',
     'author': 'Stanislav Zmiev',