Improve test support across python versions

Author: jceipek

ninja/signature/details.py

@@ -221,21 +221,26 @@ def _get_param_type(self, name: str, arg: inspect.Parameter) -> FuncParam:
         annotation = arg.annotation
         default = arg.default
 
-        # TODO: Remove version check once support for <=3.8 is dropped.
-        # Annotated[] is only available in 3.9+ per
-        # https://docs.python.org/3/library/typing.html#typing.Annotated
-        if get_origin(annotation) is Annotated and version_info >= (3, 9):
+        if get_origin(annotation) is Annotated:
             args = get_args(annotation)
             if isinstance(args[-1], Param):
                 prev_default = default
                 if len(args) == 2:
                     annotation, default = args
                 else:
-                    # NOTE: Annotated[args[:-1]] seems to have the same runtime
-                    # behavior as Annotated[*args[:-1]], but the latter is
-                    # invalid in Python < 3.11 because star expressions
-                    # were not allowed in index expressions.
-                    annotation, default = Annotated[args[:-1]], args[-1]
+                    # TODO: Remove version check once support for <=3.8 is dropped.
+                    # Annotated[] is only available at runtime in 3.9+ per
+                    # https://docs.python.org/3/library/typing.html#typing.Annotated
+                    if version_info >= (3, 9):
+                        # NOTE: Annotated[args[:-1]] seems to have the same runtime
+                        # behavior as Annotated[*args[:-1]], but the latter is
+                        # invalid in Python < 3.11 because star expressions
+                        # were not allowed in index expressions.
+                        annotation, default = Annotated[args[:-1]], args[-1]
+                    else:
+                        raise NotImplementedError(
+                            "This definition requires Python version 3.9+"
+                        )
                 if prev_default != self.signature.empty:
                     default.default = prev_default
 

tests/main.py

@@ -1,7 +1,9 @@
+from sys import version_info
 from typing import List, Optional
 from uuid import UUID
 
 import pydantic
+import pytest
 from django.urls import register_converter
 from typing_extensions import Annotated
 
@@ -55,12 +57,29 @@ def custom_validator(value: int) -> int:
     }),
 ]
 
-
-@router.get("/path/param_ex/{item_id}")
-def get_path_param_ex_id(
-    request, item_id: PathEx[CustomValidatedInt, P(description="path_ex description")]
-):
-    return item_id
+# TODO: Remove this condition once support for <= 3.8 is dropped
+if version_info >= (3, 9):
+
+    @router.get("/path/param_ex/{item_id}")
+    def get_path_param_ex_id(
+        request,
+        item_id: PathEx[CustomValidatedInt, P(description="path_ex description")],
+    ):
+        return item_id
+
+else:
+
+    def test_annotated_path_ex_unsupported():
+        with pytest.raises(NotImplementedError, match="3.9+"):
+
+            @router.get("/path/param_ex/{item_id}")
+            def get_path_param_ex_id(
+                request,
+                item_id: PathEx[
+                    CustomValidatedInt, P(description="path_ex description")
+                ],
+            ):
+                return item_id
 
 
 @router.get("/path/param/{item_id}")

tests/test_openapi_schema.py

@@ -1,12 +1,13 @@
 import sys
+from sys import version_info
 from typing import Any, List, Union
 from unittest.mock import Mock
-from typing_extensions import Annotated
 
 import pydantic
 import pytest
 from django.contrib.admin.views.decorators import staff_member_required
 from django.test import Client, override_settings
+from typing_extensions import Annotated
 
 from ninja import (
     Body,
@@ -42,11 +43,13 @@ class TypeB(Schema):
 
 AnnotatedStr = Annotated[
     str,
-    pydantic.WithJsonSchema({
-        "type": "string",
-        "format": "custom-format",
-        "example": "example_string",
-    }),
+    pydantic.WithJsonSchema(
+        {
+            "type": "string",
+            "format": "custom-format",
+            "example": "example_string",
+        }
+    ),
 ]
 
 
@@ -86,19 +89,43 @@ def method_body_schema(request, data: Payload):
     return dict(i=data.i, f=data.f)
 
 
-@api.get("/test-path/{int:i}/{f}/{path_ex}", response=Response)
+@api.get("/test-path/{int:i}/{f}", response=Response)
 def method_path(
     request,
     i: int,
     f: float,
-    path_ex: PathEx[
-        AnnotatedStr,
-        P(description="path_ex description"),
-    ],
 ):
     return dict(i=i, f=f)
 
 
+# This definition is only possible in Python 3.9+
+# TODO: Drop this condition once support for <= 3.8 is dropped
+if version_info >= (3, 9):
+
+    @api.get("/test-pathex/{path_ex}", response=AnnotatedStr)
+    def method_pathex(
+        request,
+        path_ex: PathEx[
+            AnnotatedStr,
+            P(description="path_ex description"),
+        ],
+    ):
+        return path_ex
+
+else:
+    with pytest.raises(NotImplementedError, match="3.9+"):
+
+        @api.get("/test-pathex/{path_ex}", response=AnnotatedStr)
+        def method_pathex(
+            request,
+            path_ex: PathEx[
+                AnnotatedStr,
+                P(description="path_ex description"),
+            ],
+        ):
+            return path_ex
+
+
 @api.post("/test-form", response=Response)
 def method_form(request, data: Payload = Form(...)):
     return dict(i=data.i, f=data.f)
@@ -433,7 +460,7 @@ def test_schema_body_schema(schema):
 
 
 def test_schema_path(schema):
-    method_list = schema["paths"]["/api/test-path/{i}/{f}/{path_ex}"]["get"]
+    method_list = schema["paths"]["/api/test-path/{i}/{f}"]["get"]
 
     assert "requestBody" not in method_list
 
@@ -450,6 +477,30 @@ def test_schema_path(schema):
             "schema": {"title": "F", "type": "number"},
             "required": True,
         },
+    ]
+
+    assert method_list["responses"] == {
+        200: {
+            "content": {
+                "application/json": {
+                    "schema": {"$ref": "#/components/schemas/Response"},
+                },
+            },
+            "description": "OK",
+        }
+    }
+
+
+@pytest.mark.skipif(
+    version_info < (3, 9),
+    reason="requires py3.9+ for Annotated[] at the route definition site",
+)
+def test_schema_pathex(schema):
+    method_list = schema["paths"]["/api/test-pathex/{path_ex}"]["get"]
+
+    assert "requestBody" not in method_list
+
+    assert method_list["parameters"] == [
         {
             "in": "path",
             "name": "path_ex",
@@ -470,7 +521,12 @@ def test_schema_path(schema):
         200: {
             "content": {
                 "application/json": {
-                    "schema": {"$ref": "#/components/schemas/Response"},
+                    "schema": {
+                        "example": "example_string",
+                        "format": "custom-format",
+                        "title": "Response",
+                        "type": "string",
+                    },
                 },
             },
             "description": "OK",
@@ -650,7 +706,7 @@ def test_schema_title_description(schema):
                 "schema": {
                     "properties": {
                         "file": {
-                            "description": "file " "param " "desc",
+                            "description": "file param desc",
                             "format": "binary",
                             "title": "File",
                             "type": "string",

tests/test_path.py

@@ -1,3 +1,5 @@
+from sys import version_info
+
 import pytest
 from main import router
 
@@ -221,9 +223,6 @@ def test_text_get():
         ("/path/bool/true", 200, True),
         ("/path/bool/False", 200, False),
         ("/path/bool/false", 200, False),
-        ("/path/param_ex/True", 422, response_not_valid_int),
-        ("/path/param_ex/0", 422, response_not_valid_custom),
-        ("/path/param_ex/42", 200, 42),
         ("/path/param/foo", 200, "foo"),
         ("/path/param-required/foo", 200, "foo"),
         ("/path/param-minlength/foo", 200, "foo"),
@@ -288,6 +287,25 @@ def test_get_path(path, expected_status, expected_response):
     assert response.json() == expected_response
 
 
+@pytest.mark.skipif(
+    version_info < (3, 9),
+    reason="requires py3.9+ for Annotated[] at the route definition site",
+)
+@pytest.mark.parametrize(
+    "path,expected_status,expected_response",
+    [
+        ("/path/param_ex/True", 422, response_not_valid_int),
+        ("/path/param_ex/0", 422, response_not_valid_custom),
+        ("/path/param_ex/42", 200, 42),
+    ],
+)
+def test_get_pathex(path, expected_status, expected_response):
+    response = client.get(path)
+    print(path, response.json())
+    assert response.status_code == expected_status
+    assert response.json() == expected_response
+
+
 @pytest.mark.parametrize(
     "path,expected_status,expected_response",
     [