cadwyn 3.12.0__tar.gz → 3.12.1__tar.gz

{cadwyn-3.12.0 → cadwyn-3.12.1}/PKG-INFO

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

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/__main__.py

@@ -115,8 +115,7 @@ def _get_version_bundle(possibly_version_bundle: Any) -> VersionBundle:
 @app.callback()
 def main(
     version: bool = typer.Option(None, "-V", "--version", callback=version_callback, is_eager=True),
-):
-    ...
+): ...
 
 
 if __name__ == "__main__":

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/codegen/_main.py

@@ -53,8 +53,7 @@ def generate_code_for_versioned_packages(
     codegen_plugins: Sequence[CodegenPlugin] = DEFAULT_CODEGEN_PLUGINS,
     migration_plugins: Sequence[MigrationPlugin] = DEFAULT_CODEGEN_MIGRATION_PLUGINS,
     extra_context: dict[str, Any] | None = None,
-):
-    ...
+): ...
 
 
 @overload
@@ -70,8 +69,7 @@ def generate_code_for_versioned_packages(
     codegen_plugins: Sequence[CodegenPlugin] = DEFAULT_CODEGEN_PLUGINS,
     migration_plugins: Sequence[MigrationPlugin] = DEFAULT_CODEGEN_MIGRATION_PLUGINS,
     extra_context: dict[str, Any] | None = None,
-):
-    ...
+): ...
 
 
 def generate_code_for_versioned_packages(

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/route_generation.py

@@ -95,8 +95,7 @@ class InternalRepresentationOf:
 def generate_versioned_routers(
     router: _R,
     versions: VersionBundle,
-) -> dict[VersionDate, _R]:
-    ...
+) -> dict[VersionDate, _R]: ...
 
 
 @overload
@@ -105,8 +104,7 @@ def generate_versioned_routers(
     router: _R,
     versions: VersionBundle,
     latest_schemas_package: ModuleType | None,
-) -> dict[VersionDate, _R]:
-    ...
+) -> dict[VersionDate, _R]: ...
 
 
 def generate_versioned_routers(

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/routing.py

@@ -67,15 +67,14 @@ class _RootHeaderAPIRouter(APIRouter):
         if self.min_routes_version > request_header_value:
             # then the request version is older that the oldest route we have
             _logger.info(
-                f"Request version {request_version} "
-                f"is older than the oldest "
-                f"version {self.min_routes_version.isoformat()} ",
+                "Request version is older than the oldest version. No route can match this version",
+                extra={"oldest_version": self.min_routes_version.isoformat(), "request_version": request_version},
             )
             return []
         version_chosen = self.find_closest_date_but_not_new(request_header_value)
         _logger.info(
-            f"Partial match. The endpoint with {version_chosen} "
-            f"version was selected for API call version {request_version}",
+            "Partial match. The endpoint with a lower version was selected for the API call",
+            extra={"version_chosen": version_chosen, "request_version": request_version},
         )
         return self.versioned_routers[version_chosen].routes
 

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/structure/data.py

@@ -109,13 +109,11 @@ class AlterRequestByPathInstruction(_BaseAlterRequestInstruction):
 @overload
 def convert_request_to_next_version_for(
     first_schema: type, /, *additional_schemas: type
-) -> "type[staticmethod[_P, None]]":
-    ...
+) -> "type[staticmethod[_P, None]]": ...
 
 
 @overload
-def convert_request_to_next_version_for(path: str, methods: list[str], /) -> "type[staticmethod[_P, None]]":
-    ...
+def convert_request_to_next_version_for(path: str, methods: list[str], /) -> "type[staticmethod[_P, None]]": ...
 
 
 def convert_request_to_next_version_for(
@@ -174,8 +172,7 @@ def convert_response_to_previous_version_for(
     /,
     *schemas: type,
     migrate_http_errors: bool = False,
-) -> "type[staticmethod[_P, None]]":
-    ...
+) -> "type[staticmethod[_P, None]]": ...
 
 
 @overload
@@ -185,8 +182,7 @@ def convert_response_to_previous_version_for(
     /,
     *,
     migrate_http_errors: bool = False,
-) -> "type[staticmethod[_P, None]]":
-    ...
+) -> "type[staticmethod[_P, None]]": ...
 
 
 def convert_response_to_previous_version_for(

{cadwyn-3.12.0 → cadwyn-3.12.1}/cadwyn/structure/versions.py

@@ -20,7 +20,7 @@ from fastapi.concurrency import run_in_threadpool
 from fastapi.dependencies.models import Dependant
 from fastapi.dependencies.utils import solve_dependencies
 from fastapi.exceptions import RequestValidationError
-from fastapi.responses import FileResponse, StreamingResponse
+from fastapi.responses import FileResponse, JSONResponse, StreamingResponse
 from fastapi.routing import APIRoute, _prepare_response_content
 from pydantic import BaseModel
 from starlette._utils import is_async_callable
@@ -74,9 +74,9 @@ class VersionChange:
     alter_enum_instructions: ClassVar[list[AlterEnumSubInstruction]] = Sentinel
     alter_module_instructions: ClassVar[list[AlterModuleInstruction]] = Sentinel
     alter_endpoint_instructions: ClassVar[list[AlterEndpointSubInstruction]] = Sentinel
-    alter_request_by_schema_instructions: ClassVar[
-        dict[type[BaseModel], list[AlterRequestBySchemaInstruction]]
-    ] = Sentinel
+    alter_request_by_schema_instructions: ClassVar[dict[type[BaseModel], list[AlterRequestBySchemaInstruction]]] = (
+        Sentinel
+    )
     alter_request_by_path_instructions: ClassVar[dict[str, list[AlterRequestByPathInstruction]]] = Sentinel
     alter_response_by_schema_instructions: ClassVar[dict[type, list[AlterResponseBySchemaInstruction]]] = Sentinel
     alter_response_by_path_instructions: ClassVar[dict[str, list[AlterResponseByPathInstruction]]] = Sentinel
@@ -245,8 +245,7 @@ class VersionBundle:
         *other_versions: Version,
         api_version_var: APIVersionVarType | None = None,
         head_schemas_package: ModuleType | None = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     @deprecated("Pass head_version_package instead of latest_schemas_package.")
@@ -257,8 +256,7 @@ class VersionBundle:
         *other_versions: Version,
         api_version_var: APIVersionVarType | None = None,
         latest_schemas_package: ModuleType | None = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     def __init__(
         self,
@@ -620,7 +618,10 @@ class VersionBundle:
             if isinstance(response_or_response_body, StreamingResponse | FileResponse):
                 body = None
             elif response_or_response_body.body:
-                body = json.loads(response_or_response_body.body)
+                if isinstance(response_or_response_body, JSONResponse) or raised_exception is not None:
+                    body = json.loads(response_or_response_body.body)
+                else:
+                    body = response_or_response_body.body.decode(response_or_response_body.charset)
             else:
                 body = None
                 # TODO (https://github.com/zmievsa/cadwyn/issues/51): Only do this if there are migrations
@@ -666,16 +667,25 @@ class VersionBundle:
             # that do not have it. We don't support it too.
             if response_info.body is not None and hasattr(response_info._response, "body"):
                 # 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()
+                if isinstance(response_info.body, str):
+                    response_info._response.body = response_info.body.encode(response_info._response.charset)
+                else:
+                    response_info._response.body = json.dumps(
+                        response_info.body,
+                        ensure_ascii=False,
+                        allow_nan=False,
+                        indent=None,
+                        separators=(",", ":"),
+                    ).encode("utf-8")
+                # It makes sense to re-calculate content length because the previously calculated one
+                # might slightly differ. If it differs -- uvicorn will break.
+                response_info.headers["content-length"] = str(len(response_info._response.body))
 
             if raised_exception is not None and response_info.status_code >= 400:
                 if isinstance(response_info.body, dict) and "detail" in response_info.body:
                     detail = response_info.body["detail"]
                 else:
                     detail = response_info.body
-                # It makes more sense to re-calculate content length because the previously calculated one
-                # might slightly differ.
-                del response_info.headers["content-length"]
 
                 raise HTTPException(
                     status_code=response_info.status_code,

cadwyn-3.12.1/pyproject.toml

@@ -0,0 +1,137 @@
+[tool.poetry]
+name = "cadwyn"
+version = "3.12.1"
+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",
+    "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",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Framework :: AsyncIO",
+    "Framework :: FastAPI",
+    "Framework :: Pydantic",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: Internet :: WWW/HTTP",
+]
+
+
+[tool.poetry.dependencies]
+python = "^3.10"
+typing-extensions = "*"
+fastapi = ">=0.110.0"
+starlette = ">=0.36.3"
+pydantic = ">=1.0.0"
+typer = {version = ">=0.7.0", optional = true}
+better-ast-comments = "~1.2.1"
+jinja2 = ">=3.1.2"
+
+[tool.poetry.extras]
+cli = ["typer"]
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=7.2.1"
+pytest-cov = ">=4.0.0"
+uvicorn = "*"
+devtools = "*"
+pdbpp = "^0.10.3"
+httpx = "*"
+pytest-fixture-classes = ">=1.0.3"
+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"
+pytest-sugar = "^1.0.0"
+
+[tool.poetry.scripts]
+cadwyn = "cadwyn.__main__:app"
+
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.coverage.report]
+skip_covered = true
+skip_empty = true
+# Taken from https://coverage.readthedocs.io/en/7.1.0/excluding.html#advanced-exclusion
+exclude_lines = [
+    "pragma: no cover",
+    "assert_never\\(",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if False:",
+    "assert_never",
+    "if 0:",
+    "class .*\\bProtocol\\):",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@(abc\\.)?abstractmethod",
+    "@(typing\\.)?overload",
+    "__rich_repr__",
+    "__repr__",
+]
+omit = ["./docs/plugin.py", "./site/plugin.py", "./tests/_data/_temp/**/*", "tests/tutorial/data/**/*", "scripts/*.py"]
+
+[tool.pyright]
+reportMissingImports = true
+strictListInference = true
+strictDictionaryInference = true
+strictSetInference = true
+reportPropertyTypeMismatch = true
+reportImportCycles = true
+reportUntypedFunctionDecorator = "warning"
+reportUntypedClassDecorator = "warning"
+reportUntypedBaseClass = "warning"
+reportDeprecated = "warning"
+reportInvalidTypeVarUse = true
+reportUnnecessaryCast = true
+reportUnnecessaryComparison = true
+reportUnnecessaryContains = true
+reportAssertAlwaysTrue = true
+reportUnsupportedDunderAll = true
+reportUnnecessaryTypeIgnoreComment = true
+reportMissingSuperCall = true
+reportFunctionMemberAccess = false
+reportCircularImports = true
+
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

cadwyn-3.12.0/pyproject.toml

@@ -1,247 +0,0 @@
-[tool.poetry]
-name = "cadwyn"
-version = "3.12.0"
-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",
-    "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",
-    "Topic :: Software Development :: Libraries",
-    "Topic :: Software Development",
-    "Typing :: Typed",
-    "Development Status :: 5 - Production/Stable",
-    "Environment :: Web Environment",
-    "Framework :: AsyncIO",
-    "Framework :: FastAPI",
-    "Framework :: Pydantic",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
-    "Topic :: Internet :: WWW/HTTP",
-]
-
-
-[tool.poetry.dependencies]
-python = "^3.10"
-typing-extensions = "*"
-fastapi = ">=0.110.0"
-starlette = ">=0.36.3"
-pydantic = ">=1.0.0"
-typer = {version = ">=0.7.0", optional = true}
-better-ast-comments = "~1.2.1"
-jinja2 = ">=3.1.2"
-
-[tool.poetry.extras]
-cli = ["typer"]
-
-
-[tool.poetry.group.dev.dependencies]
-ruff = "*"
-pytest = ">=7.2.1"
-pytest-cov = ">=4.0.0"
-uvicorn = "*"
-devtools = "*"
-pdbpp = "^0.10.3"
-httpx = "*"
-pytest-fixture-classes = ">=1.0.3"
-pre-commit = ">=3.4.0"
-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"
-pytest-sugar = "^1.0.0"
-
-[tool.poetry.scripts]
-cadwyn = "cadwyn.__main__:app"
-
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-
-[tool.coverage.report]
-skip_covered = true
-skip_empty = true
-# Taken from https://coverage.readthedocs.io/en/7.1.0/excluding.html#advanced-exclusion
-exclude_lines = [
-    "pragma: no cover",
-    "assert_never\\(",
-    "if self.debug:",
-    "if settings.DEBUG",
-    "raise AssertionError",
-    "raise NotImplementedError",
-    "if False:",
-    "assert_never",
-    "if 0:",
-    "class .*\\bProtocol\\):",
-    "if __name__ == .__main__.:",
-    "if TYPE_CHECKING:",
-    "@(abc\\.)?abstractmethod",
-    "@(typing\\.)?overload",
-    "__rich_repr__",
-    "__repr__",
-]
-omit = ["./docs/plugin.py", "./site/plugin.py", "./tests/_data/_temp/**/*", "tests/tutorial/data/**/*", "scripts/*.py"]
-
-[tool.pyright]
-reportMissingImports = true
-strictListInference = true
-strictDictionaryInference = true
-strictSetInference = true
-reportPropertyTypeMismatch = true
-reportImportCycles = true
-reportUntypedFunctionDecorator = "warning"
-reportUntypedClassDecorator = "warning"
-reportUntypedBaseClass = "warning"
-reportDeprecated = "warning"
-reportInvalidTypeVarUse = true
-reportUnnecessaryCast = true
-reportUnnecessaryComparison = true
-reportUnnecessaryContains = true
-reportAssertAlwaysTrue = true
-reportUnsupportedDunderAll = true
-reportUnnecessaryTypeIgnoreComment = true
-reportMissingSuperCall = true
-reportFunctionMemberAccess = false
-reportCircularImports = true
-
-
-[tool.ruff]
-target-version = "py310"
-line-length = 120
-extend-exclude = ["scripts/*.py"]
-
-[tool.ruff.lint]
-select = [
-    "F",       # pyflakes
-    "E",       # pycodestyle errors
-    "W",       # pycodestyle warnings
-    "C90",     # mccabe
-    "I",       # isort
-    "N",       # pep8-naming
-    "UP",      # pyupgrade
-    "YTT",     # flake8-2020
-    "S",       # flake8-bandit
-    "BLE",     # flake8-blind-except
-    "FBT003",  # flake8-boolean-trap
-    "B",       # flake8-bugbear
-    "COM",     # flake8-commas
-    "C4",      # flake8-comprehensions
-    "T10",     # flake8-debugger
-    "ISC",     # flake8-implicit-str-concat
-    "G010",    # Logging statement uses warn instead of warning
-    "G201",    # Logging .exception(...) should be used instead of .error(..., exc_info=True)
-    "G202",    # Logging statement has redundant exc_info
-    "INP",     # flake8-no-pep420
-    "PIE",     # flake8-pie
-    "T20",     # flake8-print
-    "PYI",     # flake8-pyi
-    "PT",      # flake8-pytest-style
-    "Q",       # flake8-quotes
-    "RSE",     # flake8-raise
-    "RET",     # flake8-return
-    "SIM",     # flake8-simplify
-    "TCH",     # flake8-type-checking
-    "ARG",     # flake8-unused-arguments
-    "PTH",     # flake8-use-pathlib
-    "ERA",     # flake8-eradicate
-    "PGH",     # pygrep-hooks
-    "PLC0414", # Import alias does not rename original package
-    "PLE",     # Error
-    "PLW",     # Warning
-    "TRY",     # tryceratops
-    "FLY",     # flynt
-    "RUF",     # ruff-specific rules
-    "ANN001",  # missing type annotation for arguments
-    "ANN002",  # missing type annotation for *args
-    "ANN003",  # missing type annotation for **kwargs
-]
-unfixable = [
-    "ERA001", # eradicate: found commented out code (can be dangerous if fixed automatically)
-]
-ignore = [
-    "D203",   # 1 blank line required before class docstring
-    "ARG001", # Unused first argument
-    "ARG002", # Unused method argument
-    "TRY003", # Avoid specifying long messages outside the exception class
-    "TRY300", # Consider moving statement into the else clause
-    "PT019",  # Fixture without value is injected as parameter, use @pytest.mark.usefixtures instead
-              # (usefixtures doesn't play well with IDE features such as auto-renaming)
-    "SIM108", # Use ternary operator instead of if-else block (ternaries lie to coverage)
-    "RET505", # Unnecessary `else` after `return` statement
-    "N805",   # First argument of a method should be named `self` (pydantic validators don't play well with this)
-    "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
-    "RET506", # Unnecessary `elif` after `raise` statement
-]
-
-
-[tool.ruff.lint.per-file-ignores]
-"tests/*" = [
-    "S",      # ignore bandit security issues in tests
-    "B018",   # ignore useless expressions in tests
-    "PT012",  # ignore complex with pytest.raises clauses
-    "RUF012", # ignore mutable class attributes ClassVar typehint requirement
-    "ANN001", # Missing type annotation for function argument
-    "ANN002", # Missing type annotation for *args
-    "ANN003", # Missing type annotation for **kwargs
-    "PGH003", # Use specific rule codes when ignoring type issues
-    "B008",   # Do not perform function call in argument defaults
-]
-"cadwyn/_utils.py" = [
-    "ERA001", # Found commented-out code (it's not actually commented out. It's just comments)
-]
-
-[tool.ruff.lint.mccabe]
-max-complexity = 14
-
-[tool.ruff.format]
-quote-style = "double"
-indent-style = "space"
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"