Add support for dependencies in routes and support Python 3.12 (#44)

This PR includes:
- Support for dependencies in post routes.
- Support for Python 3.12.
- Updates FastAPI to `^0.111.0`.
- Switches from `snapshottest` to `syrupy` (restricted lower Python version boundary to 3.8.1 due to syrupy).
- Updates `datamodel-code-generator`.
- Updates to pre-commit hooks and a lot of dependencies.

Author: Joakim Nordling

.github/workflows/tests.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
       - name: Checkout 🔁
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -21,24 +21,25 @@ repos:
         args: ["--fix=crlf"]
         files: \.bat$
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         language_version: python3
   - repo: https://github.com/psf/black
-    rev: 23.11.0
+    rev: 24.4.2
     hooks:
       - id: black
         language_version: python3
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.1.0
     hooks:
       - id: prettier
+        exclude: "^openapi_to_fastapi/tests/__snapshots__/"
   - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
   - repo: https://github.com/twu/skjold
-    rev: v0.6.1
+    rev: v0.6.2
     hooks:
       - id: skjold

README.md

@@ -255,7 +255,7 @@ router = SpecRouter(specs, validators=[MyValidator])
 
 You will need:
 
-- Python 3.8+ (though 3.11+ might have some issues with dependencies)
+- Python 3.8.1+ (tested on 3.8 - 3.12)
 - [pre-commit](https://pre-commit.com/#install)
 
 Before working on the project, make sure you run:

openapi_to_fastapi/model_generator.py

@@ -31,10 +31,6 @@ def generate_model_from_schema(schema: str, format_code: bool = False) -> str:
         extra_template_data=None,
         target_python_version=PythonVersion.PY_38,
         dump_resolve_reference_action=None,
-        # Validation of OpenAPI 3.1 specs isn't supported right now. Issues:
-        # https://github.com/koxudaxi/datamodel-code-generator/issues/1649 and
-        # https://github.com/RonnyPfannschmidt/prance/issues/95
-        validation=False,
         field_constraints=False,
         snake_case_field=False,
         strip_default_none=False,

openapi_to_fastapi/routes.py

@@ -1,10 +1,10 @@
 import json
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Type, Union
+from typing import Any, Callable, Dict, List, Optional, Sequence, Type, Union
 
 import pydantic
-from fastapi import APIRouter
+from fastapi import APIRouter, params
 from fastapi.openapi import models as oas
 
 from .model_generator import load_models
@@ -35,6 +35,7 @@ class RouteInfo:
     tags: Optional[List[str]] = None
     summary: Optional[str] = None
     deprecated: Optional[bool] = None
+    dependencies: Optional[Sequence[params.Depends]] = None
 
     request_model: Optional[Type[pydantic.BaseModel]] = None
     response_model: Optional[Type[pydantic.BaseModel]] = None
@@ -188,6 +189,7 @@ def post(
         response_description: Optional[str] = None,
         name_factory: Optional[Callable] = None,
         responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
+        dependencies: Optional[Sequence[params.Depends]] = None,
     ):
         """
         Define implementation for a specific POST route
@@ -201,6 +203,7 @@ def post(
         :param description: Route description. Got from OpenAPI spec by default
         :param response_description: Description of the response
         :param responses: Possible responses the route may return. Used in documentation
+        :param dependencies: Possible dependencies to add to the route.
         """
 
         def _wrapper(fn):
@@ -215,6 +218,7 @@ def _wrapper(fn):
             route_info.tags = tags
             route_info.name_factory = name_factory
             route_info.responses = responses
+            route_info.dependencies = dependencies
 
             if response_description:
                 route_info.response_description = response_description
@@ -258,5 +262,6 @@ def to_fastapi_router(self):
                 responses=route_info.responses,
                 tags=route_info.tags,
                 deprecated=route_info.deprecated,
+                dependencies=route_info.dependencies,
             )(handler)
         return router

openapi_to_fastapi/tests/__snapshots__/test_router/test_custom_route_definitions.json

@@ -0,0 +1,22 @@
+{
+  "detail": [
+    {
+      "input": null,
+      "loc": [
+        "query",
+        "vendor"
+      ],
+      "msg": "Field required",
+      "type": "missing"
+    },
+    {
+      "input": null,
+      "loc": [
+        "header",
+        "auth-header"
+      ],
+      "msg": "Field required",
+      "type": "missing"
+    }
+  ]
+}

openapi_to_fastapi/tests/__snapshots__/test_router/test_weather_route_payload_errors.1.json

@@ -0,0 +1,25 @@
+{
+  "detail": [
+    {
+      "input": "1,1.2",
+      "loc": [
+        "body",
+        "lat"
+      ],
+      "msg": "Input should be a valid number, unable to parse string as a number",
+      "type": "float_parsing"
+    },
+    {
+      "ctx": {
+        "le": 180.0
+      },
+      "input": "99999",
+      "loc": [
+        "body",
+        "lon"
+      ],
+      "msg": "Input should be less than or equal to 180",
+      "type": "less_than_equal"
+    }
+  ]
+}

openapi_to_fastapi/tests/__snapshots__/test_router/test_weather_route_payload_errors.json

@@ -0,0 +1,22 @@
+{
+  "detail": [
+    {
+      "input": {},
+      "loc": [
+        "body",
+        "lat"
+      ],
+      "msg": "Field required",
+      "type": "missing"
+    },
+    {
+      "input": {},
+      "loc": [
+        "body",
+        "lon"
+      ],
+      "msg": "Field required",
+      "type": "missing"
+    }
+  ]
+}

openapi_to_fastapi/tests/conftest.py

@@ -3,6 +3,7 @@
 import pytest
 from fastapi import FastAPI
 from starlette.testclient import TestClient
+from syrupy.extensions.json import JSONSnapshotExtension
 
 from openapi_to_fastapi.routes import SpecRouter
 
@@ -28,3 +29,8 @@ def definitions_client(specs_root):
     spec_router = SpecRouter(specs_root / "definitions")
     app.include_router(spec_router.to_fastapi_router())
     return TestClient(app)
+
+
+@pytest.fixture
+def json_snapshot(snapshot):
+    return snapshot.use_extension(JSONSnapshotExtension)