feat: avoid mypy cheat and tests

Author: skokado

ninja/params/__init__.py

@@ -43,7 +43,6 @@ def __getitem__(self, args: Any) -> Any:
     Cookie = Annotated[T, param_functions.Cookie()]
     File = Annotated[T, param_functions.File()]
     Form = Annotated[T, param_functions.Form()]
-    Header = Annotated[T, param_functions.Header()]
     Path = Annotated[T, param_functions.Path()]
     Query = Annotated[T, param_functions.Query()]
     # mypy does not like to extend already annotated params
@@ -52,15 +51,13 @@ def __getitem__(self, args: Any) -> Any:
     from typing_extensions import Annotated as CookieEx
     from typing_extensions import Annotated as FileEx
     from typing_extensions import Annotated as FormEx
-    from typing_extensions import Annotated as HeaderEx
     from typing_extensions import Annotated as PathEx
     from typing_extensions import Annotated as QueryEx
 else:
     Body = ParamShortcut(param_functions.Body)
     Cookie = ParamShortcut(param_functions.Cookie)
     File = ParamShortcut(param_functions.File)
     Form = ParamShortcut(param_functions.Form)
-    Header = ParamShortcut(param_functions.Header)
     Path = ParamShortcut(param_functions.Path)
     Query = ParamShortcut(param_functions.Query)
     # mypy does not like to extend already annotated params
@@ -69,11 +66,14 @@ def __getitem__(self, args: Any) -> Any:
     CookieEx = Cookie
     FileEx = File
     FormEx = Form
-    HeaderEx = Header
     PathEx = Path
     QueryEx = Query
 
 
+Header = ParamShortcut(param_functions.Header)
+HeaderEx = Header
+
+
 def P(
     *,
     alias: Optional[str] = None,

tests/test_request.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Annotated, Optional
 
 import pytest
 from pydantic import ConfigDict
@@ -26,26 +26,53 @@ def headers1(request, user_agent: str = Header(...)):
     return user_agent
 
 
+@router.get("/headers1_annotated")
+def headers1_annotated(request, user_agent: Annotated[str, Header(...)]):
+    return user_agent
+
+
 @router.get("/headers2")
 def headers2(request, ua: str = Header(..., alias="User-Agent")):
     return ua
 
 
+@router.get("/headers2_annotated")
+def headers2_annotated(request, ua: Annotated[str, Header(..., alias="User-Agent")]):
+    return ua
+
+
 @router.get("/headers3")
 def headers3(request, content_length: int = Header(...)):
     return content_length
 
 
+@router.get("/headers3_annotated")
+def headers3_annotated(request, content_length: Annotated[int, Header(...)]):
+    return content_length
+
+
 @router.get("/headers4")
 def headers4(request, c_len: int = Header(..., alias="Content-length")):
     return c_len
 
 
+@router.get("/headers4_annotated")
+def headers4_annotated(
+    request, c_len: Annotated[int, Header(..., alias="Content-length")]
+):
+    return c_len
+
+
 @router.get("/headers5")
 def headers5(request, missing: int = Header(...)):
     return missing
 
 
+@router.get("/headers5_annotated")
+def headers5_annotated(request, missing: Annotated[int, Header(...)]):
+    return missing
+
+
 @router.get("/cookies1")
 def cookies1(request, weapon: str = Cookie(...)):
     return weapon
@@ -68,9 +95,13 @@ def schema(request, payload: ExtraForbidSchema = Body(...)):
     "path,expected_status,expected_response",
     [
         ("/headers1", 200, "Ninja"),
+        ("/headers1_annotated", 200, "Ninja"),
         ("/headers2", 200, "Ninja"),
+        ("/headers2_annotated", 200, "Ninja"),
         ("/headers3", 200, 10),
+        ("/headers3_annotated", 200, 10),
         ("/headers4", 200, 10),
+        ("/headers4_annotated", 200, 10),
         (
             "/headers5",
             422,
@@ -84,6 +115,19 @@ def schema(request, payload: ExtraForbidSchema = Body(...)):
                 ]
             },
         ),
+        (
+            "/headers5_annotated",
+            422,
+            {
+                "detail": [
+                    {
+                        "type": "missing",
+                        "loc": ["header", "missing"],
+                        "msg": "Field required",
+                    }
+                ]
+            },
+        ),
         ("/cookies1", 200, "shuriken"),
         ("/cookies2", 200, "shuriken"),
     ],