Sync fastapi docs from b5ca1324 on 2025-12-07

tests/test_tutorial/test_custom_request_and_route/test_tutorial001.py

@@ -0,0 +1,35 @@
+import gzip
+import json
+
+import pytest
+from fastapi import Request
+from fastapi.testclient import TestClient
+
+from docs_src.custom_request_and_route.tutorial001 import app
+
+
+@app.get("/check-class")
+async def check_gzip_request(request: Request):
+    return {"request_class": type(request).__name__}
+
+
+client = TestClient(app)
+
+
+@pytest.mark.parametrize("compress", [True, False])
+def test_gzip_request(compress):
+    n = 1000
+    headers = {}
+    body = [1] * n
+    data = json.dumps(body).encode()
+    if compress:
+        data = gzip.compress(data)
+        headers["Content-Encoding"] = "gzip"
+    headers["Content-Type"] = "application/json"
+    response = client.post("/sum", content=data, headers=headers)
+    assert response.json() == {"sum": n}
+
+
+def test_request_class():
+    response = client.get("/check-class")
+    assert response.json() == {"request_class": "GzipRequest"}

tests/test_tutorial/test_custom_request_and_route/test_tutorial002.py

@@ -0,0 +1,46 @@
+from dirty_equals import IsDict, IsOneOf
+from fastapi.testclient import TestClient
+
+from docs_src.custom_request_and_route.tutorial002 import app
+
+client = TestClient(app)
+
+
+def test_endpoint_works():
+    response = client.post("/", json=[1, 2, 3])
+    assert response.json() == 6
+
+
+def test_exception_handler_body_access():
+    response = client.post("/", json={"numbers": [1, 2, 3]})
+    assert response.json() == IsDict(
+        {
+            "detail": {
+                "errors": [
+                    {
+                        "type": "list_type",
+                        "loc": ["body"],
+                        "msg": "Input should be a valid list",
+                        "input": {"numbers": [1, 2, 3]},
+                    }
+                ],
+                # httpx 0.28.0 switches to compact JSON https://github.com/encode/httpx/issues/3363
+                "body": IsOneOf('{"numbers": [1, 2, 3]}', '{"numbers":[1,2,3]}'),
+            }
+        }
+    ) | IsDict(
+        # TODO: remove when deprecating Pydantic v1
+        {
+            "detail": {
+                # httpx 0.28.0 switches to compact JSON https://github.com/encode/httpx/issues/3363
+                "body": IsOneOf('{"numbers": [1, 2, 3]}', '{"numbers":[1,2,3]}'),
+                "errors": [
+                    {
+                        "loc": ["body"],
+                        "msg": "value is not a valid list",
+                        "type": "type_error.list",
+                    }
+                ],
+            }
+        }
+    )

tests/test_tutorial/test_custom_request_and_route/test_tutorial003.py

@@ -0,0 +1,18 @@
+from fastapi.testclient import TestClient
+
+from docs_src.custom_request_and_route.tutorial003 import app
+
+client = TestClient(app)
+
+
+def test_get():
+    response = client.get("/")
+    assert response.json() == {"message": "Not timed"}
+    assert "X-Response-Time" not in response.headers
+
+
+def test_get_timed():
+    response = client.get("/timed")
+    assert response.json() == {"message": "It's the time of my life"}
+    assert "X-Response-Time" in response.headers
+    assert float(response.headers["X-Response-Time"]) >= 0