cadwyn 4.3.0__tar.gz → 4.4.0__tar.gz

{cadwyn-4.3.0 → cadwyn-4.4.0}/.github/actions/setup-python-uv/action.yaml

@@ -13,15 +13,15 @@ inputs:
 runs:
   using: "composite"
   steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
     - uses: astral-sh/setup-uv@v3
       with:
         version: ${{ inputs.uv-version }}
         enable-cache: true
         cache-dependency-glob: "uv.lock"
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ inputs.python-version }}
     - run: |
-        uv sync --inexact --frozen --all-extras --dev
+        uv sync --frozen --all-extras --dev
         echo "$(pwd)/.venv/bin" >> $GITHUB_PATH
       shell: bash

{cadwyn-4.3.0 → cadwyn-4.4.0}/.github/workflows/ci.yaml

@@ -38,32 +38,57 @@ jobs:
       - uses: ./.github/actions/setup-python-uv
         with:
           python-version: ${{ matrix.python-version }}
-      - run: uv run coverage run --source=. -m pytest .
+      - run: uv run coverage run --source=. --parallel-mode -m pytest tests
       - name: Upload coverage results
         uses: actions/upload-artifact@v3
         if: matrix.os == 'ubuntu-latest' # Cross-platform coverage combination doesn't work
         with:
-          name: coverage-results
+          name: main-tests-coverage-results
+          path: coverage/
+  Tutorial-tests:
+    runs-on: ubuntu-latest
+    name: Tutorial tests
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install cadwyn with instructions from docs
+        run: sh docs_src/quickstart/setup/block001.sh
+      - run: pip install pytest coverage dirty-equals
+      - run: coverage run --source=. --parallel-mode -m pytest docs_src
+      - name: Upload coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-tests-coverage-results
           path: coverage/
   Coverage:
-    needs: Tests
+    needs: [Tests, Tutorial-tests]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v3
+      - name: Download main tests coverage info
+        uses: actions/download-artifact@v3
         with:
-          name: coverage-results
+          name: main-tests-coverage-results
           path: coverage/
-      - uses: ./.github/actions/setup-python-uv
-      - run: ls -all
-      - run: uv run coverage combine
-      - run: uv run coverage xml
+      - name: Download docs tests coverage info
+        uses: actions/download-artifact@v3
+        with:
+          name: docs-tests-coverage-results
+          path: coverage/
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - run: pip install 'coverage[toml]'
+      - run: coverage combine
+      - run: coverage xml
       - name: Upload to Codecov
         uses: codecov/codecov-action@v4
         env:
           fail_ci_if_error: true
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-      - run: uv run coverage report --fail-under=100
+      - run: coverage report --fail-under=100
 
   Lint:
     runs-on: ubuntu-latest

cadwyn-4.4.0/.github/workflows/daily_tests.yaml

@@ -0,0 +1,33 @@
+name: Twice Daily Package Update Testing
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+    - cron: "0 12 * * *"
+  workflow_dispatch: # Allows manual triggering of the workflow
+
+jobs:
+  update-dependencies-and-test:
+    name: Update dependencies and run tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-python-uv
+      - run: uv sync --refresh --all-extras --dev --upgrade
+      - run: pytest .
+
+  notify-on-failure:
+    name: Notify on failure
+    runs-on: ubuntu-latest
+    needs: update-dependencies-and-test
+    if: failure()
+    steps:
+      - name: Send Telegram Notification on Failure
+        uses: appleboy/telegram-action@master
+        with:
+          to: 438153389
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          message: |
+            New version of something broke Cadwyn!
+            ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

{cadwyn-4.3.0 → cadwyn-4.4.0}/.github/workflows/validate_links.yaml

@@ -21,10 +21,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses:
-          ./.github/actions/setup-python-uv
-          # TODO: Validate that the command exits with code 0 and has no ERROR in logs (both)
-      - run: uv run mkdocs build
+      - uses: ./.github/actions/setup-python-uv
+      - run: |
+          OUTPUT=$(uv run mkdocs build 2>&1)
+          echo "$OUTPUT"
+
+          if echo "$OUTPUT" | grep -q "ERROR"; then
+              exit 1
+          fi
+
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:

{cadwyn-4.3.0 → cadwyn-4.4.0}/CHANGELOG.md

@@ -5,6 +5,19 @@ Please follow [the Keep a Changelog standard](https://keepachangelog.com/en/1.0.
 
 ## [Unreleased]
 
+## [4.4.0]
+
+### Added
+
+* Support for [webhooks](https://fastapi.tiangolo.com/advanced/openapi-webhooks/) in swagger
+* Automatic generation of versioned routes and webhooks upon the first request to Cadwyn. Notice that if you were using some of cadwyn's internal interfaces, this might break your code. If it did, make an issue and let's discuss your use case
+
+## [4.3.1]
+
+### Fixed
+
+* Removed typer from main dependencies
+
 ## [4.3.0]
 
 ### Changed

{cadwyn-4.3.0 → cadwyn-4.4.0}/Makefile

@@ -2,7 +2,7 @@ SHELL := /bin/bash
 py_warn = PYTHONDEVMODE=1
 
 install:
-	uv sync --all-extras
+	uv sync --all-extras --dev
 
 lint:
 	pre-commit run --all-files

{cadwyn-4.3.0 → cadwyn-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cadwyn
-Version: 4.3.0
+Version: 4.4.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
@@ -38,10 +38,10 @@ Requires-Dist: issubclass>=0.1.2
 Requires-Dist: jinja2>=3.1.2
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: starlette>=0.30.0
-Requires-Dist: typer>=0.7.0
 Requires-Dist: typing-extensions>=4.8.0
 Provides-Extra: standard
 Requires-Dist: fastapi[standard]>=0.112.3; extra == 'standard'
+Requires-Dist: typer>=0.7.0; extra == 'standard'
 Description-Content-Type: text/markdown
 
 # Cadwyn

{cadwyn-4.3.0 → cadwyn-4.4.0}/cadwyn/applications.py

@@ -25,6 +25,7 @@ from starlette.routing import BaseRoute, Route
 from starlette.types import Lifespan
 from typing_extensions import Self
 
+from cadwyn._utils import same_definition_as_in
 from cadwyn.changelogs import CadwynChangelogResource, _generate_changelog
 from cadwyn.middleware import HeaderVersioningMiddleware, _get_api_version_dependency
 from cadwyn.route_generation import generate_versioned_routers
@@ -96,8 +97,8 @@ class Cadwyn(FastAPI):
         **extra: Any,
     ) -> None:
         self.versions = versions
-        # TODO: Remove argument entirely in any major version.
         self._dependency_overrides_provider = FakeDependencyOverridesProvider({})
+        self._cadwyn_initialized = False
 
         super().__init__(
             debug=debug,
@@ -156,6 +157,8 @@ class Cadwyn(FastAPI):
             api_version_header_name=api_version_header_name,
             api_version_var=self.versions.api_version_var,
         )
+        self._versioned_webhook_routers: dict[date, APIRouter] = {}
+        self._latest_version_router = APIRouter(dependency_overrides_provider=self._dependency_overrides_provider)
 
         self.changelog_url = changelog_url
         self.include_changelog_url_in_schema = include_changelog_url_in_schema
@@ -176,6 +179,26 @@ class Cadwyn(FastAPI):
             default_response_class=default_response_class,
         )
 
+    @same_definition_as_in(FastAPI.__call__)
+    async def __call__(self, scope: Any, receive: Any, send: Any) -> None:
+        if not self._cadwyn_initialized:
+            self._cadwyn_initialize()
+        self.__call__ = super().__call__
+        await self.__call__(scope, receive, send)
+
+    def _cadwyn_initialize(self) -> None:
+        generated_routers = generate_versioned_routers(
+            self._latest_version_router,
+            webhooks=self.webhooks,
+            versions=self.versions,
+        )
+        for version, router in generated_routers.endpoints.items():
+            self.add_header_versioned_routers(router, header_value=version.isoformat())
+
+        for version, router in generated_routers.webhooks.items():
+            self._versioned_webhook_routers[version] = router
+        self._cadwyn_initialized = True
+
     def _add_default_versioned_routers(self) -> None:
         for version in self.versions:
             self.router.versioned_routers[version.value] = APIRouter(**self._kwargs_to_router)
@@ -240,12 +263,8 @@ class Cadwyn(FastAPI):
                 )
 
     def generate_and_include_versioned_routers(self, *routers: APIRouter) -> None:
-        root_router = APIRouter(dependency_overrides_provider=self._dependency_overrides_provider)
         for router in routers:
-            root_router.include_router(router)
-        router_versions = generate_versioned_routers(root_router, versions=self.versions)
-        for version, router in router_versions.items():
-            self.add_header_versioned_routers(router, header_value=version.isoformat())
+            self._latest_version_router.include_router(router)
 
     async def openapi_jsons(self, req: Request) -> JSONResponse:
         raw_version = req.query_params.get("version") or req.headers.get(self.router.api_version_header_name)
@@ -276,6 +295,10 @@ class Cadwyn(FastAPI):
         if root_path and root_path not in server_urls and self.root_path_in_servers:
             self.servers.insert(0, {"url": root_path})
 
+        webhook_routes = None
+        if version in self._versioned_webhook_routers:
+            webhook_routes = self._versioned_webhook_routers[version].routes
+
         return JSONResponse(
             get_openapi(
                 title=self.title,
@@ -287,6 +310,7 @@ class Cadwyn(FastAPI):
                 contact=self.contact,
                 license_info=self.license_info,
                 routes=routes,
+                webhooks=webhook_routes,
                 tags=self.openapi_tags,
                 servers=self.servers,
             )

{cadwyn-4.3.0 → cadwyn-4.4.0}/cadwyn/route_generation.py

@@ -7,7 +7,6 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Generic,
-    TypeVar,
     cast,
 )
 
@@ -20,7 +19,7 @@ from fastapi.routing import APIRoute
 from issubclass import issubclass as lenient_issubclass
 from pydantic import BaseModel
 from starlette.routing import BaseRoute
-from typing_extensions import assert_never
+from typing_extensions import TypeVar, assert_never
 
 from cadwyn._utils import Sentinel
 from cadwyn.exceptions import (
@@ -48,7 +47,8 @@ if TYPE_CHECKING:
     from fastapi.dependencies.models import Dependant
 
 _Call = TypeVar("_Call", bound=Callable[..., Any])
-_R = TypeVar("_R", bound=fastapi.routing.APIRouter)
+_R = TypeVar("_R", bound=APIRouter)
+_WR = TypeVar("_WR", bound=APIRouter, default=APIRouter)
 # This is a hack we do because we can't guarantee how the user will use the router.
 _DELETED_ROUTE_TAG = "_CADWYN_DELETED_ROUTE"
 
@@ -59,8 +59,21 @@ class _EndpointInfo:
     endpoint_methods: frozenset[str]
 
 
-def generate_versioned_routers(router: _R, versions: VersionBundle) -> dict[VersionDate, _R]:
-    return _EndpointTransformer(router, versions).transform()
+@dataclass(slots=True, frozen=True)
+class GeneratedRouters(Generic[_R, _WR]):
+    endpoints: dict[VersionDate, _R]
+    webhooks: dict[VersionDate, _WR]
+
+
+def generate_versioned_routers(
+    router: _R,
+    versions: VersionBundle,
+    *,
+    webhooks: _WR | None = None,
+) -> GeneratedRouters[_R, _WR]:
+    if webhooks is None:
+        webhooks = cast(_WR, APIRouter())
+    return _EndpointTransformer(router, versions, webhooks).transform()
 
 
 class VersionedAPIRouter(fastapi.routing.APIRouter):
@@ -77,30 +90,36 @@ class VersionedAPIRouter(fastapi.routing.APIRouter):
         return endpoint
 
 
-class _EndpointTransformer(Generic[_R]):
-    def __init__(self, parent_router: _R, versions: VersionBundle) -> None:
+class _EndpointTransformer(Generic[_R, _WR]):
+    def __init__(self, parent_router: _R, versions: VersionBundle, webhooks: _WR) -> None:
         super().__init__()
         self.parent_router = parent_router
         self.versions = versions
+        self.parent_webhooks_router = webhooks
         self.schema_generators = generate_versioned_models(versions)
 
         self.routes_that_never_existed = [
             route for route in parent_router.routes if isinstance(route, APIRoute) and _DELETED_ROUTE_TAG in route.tags
         ]
 
-    def transform(self) -> dict[VersionDate, _R]:
+    def transform(self) -> GeneratedRouters[_R, _WR]:
         router = deepcopy(self.parent_router)
+        webhook_router = deepcopy(self.parent_webhooks_router)
         routers: dict[VersionDate, _R] = {}
+        webhook_routers: dict[VersionDate, _WR] = {}
 
         for version in self.versions:
             self.schema_generators[str(version.value)].annotation_transformer.migrate_router_to_version(router)
+            self.schema_generators[str(version.value)].annotation_transformer.migrate_router_to_version(webhook_router)
 
             self._validate_all_data_converters_are_applied(router, version)
 
             routers[version.value] = router
+            webhook_routers[version.value] = webhook_router
             # Applying changes for the next version
             router = deepcopy(router)
-            self._apply_endpoint_changes_to_router(router, version)
+            webhook_router = deepcopy(webhook_router)
+            self._apply_endpoint_changes_to_router(router.routes + webhook_router.routes, version)
 
         if self.routes_that_never_existed:
             raise RouterGenerationError(
@@ -146,7 +165,13 @@ class _EndpointTransformer(Generic[_R]):
                 for route in router.routes
                 if not (isinstance(route, fastapi.routing.APIRoute) and _DELETED_ROUTE_TAG in route.tags)
             ]
-        return routers
+        for _, webhook_router in webhook_routers.items():
+            webhook_router.routes = [
+                route
+                for route in webhook_router.routes
+                if not (isinstance(route, fastapi.routing.APIRoute) and _DELETED_ROUTE_TAG in route.tags)
+            ]
+        return GeneratedRouters(routers, webhook_routers)
 
     def _validate_all_data_converters_are_applied(self, router: APIRouter, version: Version):
         path_to_route_methods_mapping, head_response_models, head_request_bodies = self._extract_all_routes_identifiers(
@@ -223,10 +248,9 @@ class _EndpointTransformer(Generic[_R]):
     # TODO (https://github.com/zmievsa/cadwyn/issues/28): Simplify
     def _apply_endpoint_changes_to_router(  # noqa: C901
         self,
-        router: fastapi.routing.APIRouter,
+        routes: list[BaseRoute] | list[APIRoute],
         version: Version,
     ):
-        routes = router.routes
         for version_change in version.changes:
             for instruction in version_change.alter_endpoint_instructions:
                 original_routes = _get_routes(

{cadwyn-4.3.0 → cadwyn-4.4.0}/docs/quickstart/setup.md

@@ -6,7 +6,7 @@ Cadwyn is built around FastAPI and supports all of its functionality out of the
 ## Installation
 
 ```bash
-pip install 'cadwyn[standard]'
+{!> ../docs_src/quickstart/setup/block001.sh !}
 ```
 
 ## The basics

cadwyn-4.4.0/docs_src/quickstart/setup/block001.sh

@@ -0,0 +1 @@
+pip install 'cadwyn[standard]'

{cadwyn-4.3.0 → cadwyn-4.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cadwyn"
-version = "4.3.0"
+version = "4.4.0"
 description = "Production-ready community-driven modern Stripe-like API versioning in FastAPI"
 authors = [{ name = "Stanislav Zmiev", email = "zmievsa@gmail.com" }]
 license = "MIT"
@@ -50,7 +50,6 @@ dependencies = [
     "fastapi >=0.112.3",
     "starlette >=0.30.0",
     "pydantic >=2.0.0",
-    "typer >=0.7.0",
     "jinja2 >=3.1.2",
     "issubclass >=0.1.2",
     "backports-strenum >=1.3.1,<2; python_version < '3.11'",
@@ -58,7 +57,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-standard = ["fastapi[standard]>=0.112.3"]
+standard = ["fastapi[standard]>=0.112.3", "typer>=0.7.0"]
 
 [project.urls]
 "Source code" = "https://github.com/zmievsa/cadwyn"

{cadwyn-4.3.0 → cadwyn-4.4.0}/tests/_resources/versioned_app/app.py

@@ -8,10 +8,9 @@ from fastapi.testclient import TestClient
 
 from cadwyn import Cadwyn
 from cadwyn.structure.versions import Version, VersionBundle
-from tests._resources.utils import BASIC_HEADERS
 from tests._resources.versioned_app.v2021_01_01 import router as v2021_01_01_router
 from tests._resources.versioned_app.v2022_01_02 import router as v2022_01_02_router
-from tests._resources.versioned_app.webhooks import router as webhooks_router
+from tests._resources.versioned_app.webhooks import router as unversioned_router
 
 
 # TODO: Add better tests for covering lifespan
@@ -23,17 +22,16 @@ async def lifespan(app: FastAPI):
 versioned_app = Cadwyn(versions=VersionBundle(Version(date(2021, 1, 1))), lifespan=lifespan)
 versioned_app.add_header_versioned_routers(v2021_01_01_router, header_value="2021-01-01")
 versioned_app.add_header_versioned_routers(v2022_01_02_router, header_value="2022-02-02")
-versioned_app.include_router(webhooks_router)
+versioned_app.include_router(unversioned_router)
 
 versioned_app_with_custom_api_version_var = Cadwyn(
     versions=VersionBundle(Version(date(2021, 1, 1))), lifespan=lifespan, api_version_var=ContextVar("My api version")
 )
 versioned_app_with_custom_api_version_var.add_header_versioned_routers(v2021_01_01_router, header_value="2021-01-01")
 versioned_app_with_custom_api_version_var.add_header_versioned_routers(v2022_01_02_router, header_value="2022-02-02")
-versioned_app_with_custom_api_version_var.include_router(webhooks_router)
+versioned_app_with_custom_api_version_var.include_router(unversioned_router)
 
 # TODO: We should not have any clients that are run like this. Instead, all of them must run using "with"
-client = TestClient(versioned_app, raise_server_exceptions=False, headers=BASIC_HEADERS)
 client_without_headers = TestClient(versioned_app)
 client_without_headers_and_with_custom_api_version_var = TestClient(versioned_app_with_custom_api_version_var)
 

{cadwyn-4.3.0 → cadwyn-4.4.0}/tests/_resources/versioned_app/webhooks.py

@@ -3,6 +3,6 @@ from fastapi.routing import APIRouter
 router = APIRouter(prefix="/v1")
 
 
-@router.post("/webhooks", response_model=dict)
+@router.post("/unversioned", response_model=dict)
 def read_root():
     return {"saved": True}

{cadwyn-4.3.0 → cadwyn-4.4.0}/tests/conftest.py

@@ -105,6 +105,7 @@ class CreateVersionedApp:
             )
         )
         app.generate_and_include_versioned_routers(router)
+        app._cadwyn_initialize()
         return app
 
 

{cadwyn-4.3.0 → cadwyn-4.4.0}/tests/test_applications.py

@@ -6,10 +6,13 @@ import pytest
 from fastapi import APIRouter, BackgroundTasks, Depends, FastAPI
 from fastapi.routing import APIRoute
 from fastapi.testclient import TestClient
+from pydantic import BaseModel
 
 from cadwyn import Cadwyn
 from cadwyn.route_generation import VersionedAPIRouter
-from cadwyn.structure.versions import HeadVersion, Version, VersionBundle
+from cadwyn.structure.endpoints import endpoint
+from cadwyn.structure.schemas import schema
+from cadwyn.structure.versions import HeadVersion, Version, VersionBundle, VersionChange
 from tests._resources.utils import BASIC_HEADERS, DEFAULT_API_VERSION
 from tests._resources.versioned_app.app import (
     client_without_headers,
@@ -162,8 +165,8 @@ def test__header_based_versioning__invalid_version_header_format__should_raise_4
     assert resp.json()[0]["loc"] == ["header", "x-api-version"]
 
 
-def test__get_webhooks_router():
-    resp = client_without_headers.post("/v1/webhooks")
+def test__get_unversioned_router():
+    resp = client_without_headers.post("/v1/unversioned")
     assert resp.status_code == 200
     assert resp.json() == {"saved": True}
 
@@ -254,14 +257,14 @@ def test__get_docs__specific_version():
     assert resp.status_code == 200
 
 
-def test__get_webhooks_with_redirect():
-    resp = client_without_headers.post("/v1/webhooks/")
+def test__get_unversioned_with_redirect():
+    resp = client_without_headers.post("/v1/unversioned/")
     assert resp.status_code == 200
     assert resp.json() == {"saved": True}
 
 
-def test__get_webhooks_as_partial_because_of_method():
-    resp = client_without_headers.patch("/v1/webhooks")
+def test__get_unversioned_as_partial_because_of_method():
+    resp = client_without_headers.patch("/v1/unversioned")
     assert resp.status_code == 405
 
 
@@ -291,3 +294,60 @@ def test__background_tasks():
         resp = client.post("/send-notification/test@example.com", headers=BASIC_HEADERS)
         assert resp.status_code == 200, resp.json()
         assert background_task_data == ("test@example.com", "some notification")
+
+
+def test__webhooks():
+    webhooks = VersionedAPIRouter()
+
+    class Subscription(BaseModel):
+        username: str
+        monthly_fee: float
+        start_date: str
+
+    @webhooks.post("new-subscription")
+    def new_subscription(body: Subscription):  # pragma: no cover
+        """
+        When a new user subscribes to your service we'll send you a POST request with this
+        data to the URL that you register for the event `new-subscription` in the dashboard.
+        """
+
+    class MyVersionChange(VersionChange):
+        description = "Mess with webhooks"
+        instructions_to_migrate_to_previous_version = [
+            endpoint("new-subscription", ["POST"]).didnt_exist,
+            schema(Subscription).field("monthly_fee").didnt_exist,
+        ]
+
+    app = Cadwyn(
+        versions=VersionBundle(HeadVersion(), Version("2023-04-12", MyVersionChange), Version("2022-11-16")),
+        webhooks=webhooks,
+    )
+
+    @app.webhooks.post("post-subscription")  # pragma: no cover
+    def post_subscription(body: Subscription):  # pragma: no cover
+        """This should also be there"""
+
+    with TestClient(app) as client:
+        resp = client.get("/openapi.json?version=2023-04-12")
+        openapi_dict = resp.json()
+
+        assert "webhooks" in openapi_dict, "'webhooks' section is missing"
+        assert "new-subscription" in openapi_dict["webhooks"], "'new-subscription' webhook is missing"
+        assert "post-subscription" in openapi_dict["webhooks"], "'post-subscription' webhook is missing"
+        assert "post" in openapi_dict["webhooks"]["post-subscription"], "POST method for 'post-subscription' is missing"
+        assert "Subscription" in openapi_dict["components"]["schemas"], "'Subscription' component is missing"
+        assert (
+            "monthly_fee" in openapi_dict["components"]["schemas"]["Subscription"]["properties"]
+        ), "monthly_fee field is missing"
+
+        resp = client.get("/openapi.json?version=2022-11-16")
+        openapi_dict = resp.json()
+
+        assert "webhooks" in openapi_dict, "'webhooks' section is missing"
+        assert "new-subscription" not in openapi_dict["webhooks"], "'new-subscription' webhook is missing"
+        assert "post-subscription" in openapi_dict["webhooks"], "'post-subscription' webhook is present"
+        assert "post" in openapi_dict["webhooks"]["post-subscription"], "POST method for 'post-subscription' is missing"
+        assert "Subscription" in openapi_dict["components"]["schemas"], "'Subscription' component is missing"
+        assert (
+            "monthly_fee" not in openapi_dict["components"]["schemas"]["Subscription"]["properties"]
+        ), "monthly_fee field is present yet it must be deleted"

{cadwyn-4.3.0 → cadwyn-4.4.0}/tests/test_router_generation.py

@@ -190,10 +190,10 @@ def test__endpoint_existed__deleting_restoring_deleting_restoring_an_endpoint(
     )
     routers = generate_versioned_routers(router, versions=versions)
 
-    assert len(routers[date(2003, 1, 1)].routes) == 0
-    assert len(routers[date(2002, 1, 1)].routes) == 1
-    assert len(routers[date(2001, 1, 1)].routes) == 0
-    assert len(routers[date(2000, 1, 1)].routes) == 1
+    assert len(routers.endpoints[date(2003, 1, 1)].routes) == 0
+    assert len(routers.endpoints[date(2002, 1, 1)].routes) == 1
+    assert len(routers.endpoints[date(2001, 1, 1)].routes) == 0
+    assert len(routers.endpoints[date(2000, 1, 1)].routes) == 1
 
 
 @pytest.mark.parametrize(
@@ -599,14 +599,14 @@ def test__endpoint_existed__deleting_and_restoring_two_routes_for_the_same_endpo
     )
     routers = generate_versioned_routers(router, versions=versions)
 
-    assert len(routers[date(2002, 1, 1)].routes) == 0
-    assert len(routers[date(2001, 1, 1)].routes) == 1
-    assert len(routers[date(2000, 1, 1)].routes) == 2
+    assert len(routers.endpoints[date(2002, 1, 1)].routes) == 0
+    assert len(routers.endpoints[date(2001, 1, 1)].routes) == 1
+    assert len(routers.endpoints[date(2000, 1, 1)].routes) == 2
 
-    assert endpoints_equal(routers[date(2001, 1, 1)].routes[0].endpoint, route_to_restore_first)  # pyright: ignore
+    assert endpoints_equal(routers.endpoints[date(2001, 1, 1)].routes[0].endpoint, route_to_restore_first)  # pyright: ignore
     assert {
-        get_wrapped_endpoint(routers[date(2000, 1, 1)].routes[0].endpoint),  # pyright: ignore
-        get_wrapped_endpoint(routers[date(2000, 1, 1)].routes[1].endpoint),  # pyright: ignore
+        get_wrapped_endpoint(routers.endpoints[date(2000, 1, 1)].routes[0].endpoint),  # pyright: ignore
+        get_wrapped_endpoint(routers.endpoints[date(2000, 1, 1)].routes[1].endpoint),  # pyright: ignore
     } == {
         route_to_restore_first,
         route_to_restore_second,
@@ -1014,9 +1014,9 @@ def test__cascading_router_exists(router: VersionedAPIRouter, api_version_var: C
     )
     routers = generate_versioned_routers(router, versions=versions)
 
-    assert client(routers[date(2002, 1, 1)]).get("/test").json() == {"detail": "Not Found"}
-    assert client(routers[date(2001, 1, 1)]).get("/test").json() == 83
-    assert client(routers[date(2000, 1, 1)]).get("/test").json() == 83
+    assert client(routers.endpoints[date(2002, 1, 1)]).get("/test").json() == {"detail": "Not Found"}
+    assert client(routers.endpoints[date(2001, 1, 1)]).get("/test").json() == 83
+    assert client(routers.endpoints[date(2000, 1, 1)]).get("/test").json() == 83
 
 
 def test__cascading_router_didnt_exist(
@@ -1041,13 +1041,13 @@ def test__cascading_router_didnt_exist(
     )
     routers = generate_versioned_routers(router, versions=versions)
 
-    assert client(routers[date(2002, 1, 1)]).get("/test").json() == 83
+    assert client(routers.endpoints[date(2002, 1, 1)]).get("/test").json() == 83
 
-    assert client(routers[date(2001, 1, 1)]).get("/test").json() == {
+    assert client(routers.endpoints[date(2001, 1, 1)]).get("/test").json() == {
         "detail": "Not Found",
     }
 
-    assert client(routers[date(2000, 1, 1)]).get("/test").json() == {
+    assert client(routers.endpoints[date(2000, 1, 1)]).get("/test").json() == {
         "detail": "Not Found",
     }
 
@@ -1081,7 +1081,7 @@ def test__generate_versioned_routers__two_routers(
     root_router.include_router(router)
     root_router.include_router(router2)
 
-    routers = generate_versioned_routers(root_router, versions=versions)
+    routers = generate_versioned_routers(root_router, versions=versions).endpoints
     assert all(type(r) is APIRouter for r in routers.values())
     assert len(routers[date(2001, 1, 1)].routes) == 2
     assert len(routers[date(2000, 1, 1)].routes) == 1

{cadwyn-4.3.0 → cadwyn-4.4.0}/uv.lock

@@ -84,7 +84,7 @@ wheels = [
 
 [[package]]
 name = "cadwyn"
-version = "4.2.4"
+version = "4.3.1"
 source = { editable = "." }
 dependencies = [
     { name = "backports-strenum", marker = "python_full_version < '3.11'" },
@@ -93,13 +93,13 @@ dependencies = [
     { name = "jinja2" },
     { name = "pydantic" },
     { name = "starlette" },
-    { name = "typer" },
     { name = "typing-extensions" },
 ]
 
 [package.optional-dependencies]
 standard = [
     { name = "fastapi", extra = ["standard"] },
+    { name = "typer" },
 ]
 
 [package.dev-dependencies]
@@ -131,7 +131,7 @@ requires-dist = [
     { name = "jinja2", specifier = ">=3.1.2" },
     { name = "pydantic", specifier = ">=2.0.0" },
     { name = "starlette", specifier = ">=0.30.0" },
-    { name = "typer", specifier = ">=0.7.0" },
+    { name = "typer", marker = "extra == 'standard'", specifier = ">=0.7.0" },
     { name = "typing-extensions", specifier = ">=4.8.0" },
 ]
 
@@ -1167,16 +1167,16 @@ wheels = [
 
 [[package]]
 name = "rich"
-version = "13.9.1"
+version = "13.9.2"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "markdown-it-py" },
     { name = "pygments" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/b3/78/87d00a1df7c457ad9aa0139f01b8a11c67209f27f927c503b0109bf2ed6c/rich-13.9.1.tar.gz", hash = "sha256:097cffdf85db1babe30cc7deba5ab3a29e1b9885047dab24c57e9a7f8a9c1466", size = 222907 }
+sdist = { url = "https://files.pythonhosted.org/packages/aa/9e/1784d15b057b0075e5136445aaea92d23955aad2c93eaede673718a40d95/rich-13.9.2.tar.gz", hash = "sha256:51a2c62057461aaf7152b4d611168f93a9fc73068f8ded2790f29fe2b5366d0c", size = 222843 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/ab/71/cd9549551f1aa11cf7e5f92bae5817979e8b3a19e31e8810c15f3f45c311/rich-13.9.1-py3-none-any.whl", hash = "sha256:b340e739f30aa58921dc477b8adaa9ecdb7cecc217be01d93730ee1bc8aa83be", size = 242147 },
+    { url = "https://files.pythonhosted.org/packages/67/91/5474b84e505a6ccc295b2d322d90ff6aa0746745717839ee0c5fb4fdcceb/rich-13.9.2-py3-none-any.whl", hash = "sha256:8c82a3d3f8dcfe9e734771313e606b39d8247bb6b826e196f4914b333b743cf1", size = 242117 },
 ]
 
 [[package]]