📝 Update all docs to use Annotated as the main recommendation, with new examples and tests (#9268)

* 🍱 Add new source examples with Annotated for Query Params and String Validations

* 📝 Add new docs with Annotated for Query Params and String Validations

* 🚚 Rename incorrectly named tests for Query Params and str validations

* ✅ Add new tests with Annotated for Query Params and Sring Validations examples

* 🍱 Add new examples with Annotated for Intro to Python Types

* 📝 Update Python Types Intro, include Annotated

* 🎨 Fix formatting in Query params and string validation, and highlight

* 🍱 Add new Annotated source examples for Path Params and Numeric Validations

* 📝 Update docs for Path Params and Numeric Validations with Annotated

* 🍱 Add new source examples with Annotated for Body - Multiple Params

* 📝 Update docs with Annotated for Body - Multiple Parameters

* ✅ Add test for new Annotated examples in Body - Multiple Parameters

* 🍱 Add new Annotated source examples for Body Fields

* 📝 Update docs for Body Fields with new Annotated examples

* ✅ Add new tests for new Annotated examples for Body Fields

* 🍱 Add new Annotated source examples for Schema Extra (Example Data)

* 📝 Update docs for Schema Extra with Annotated

* ✅ Add tests for new Annotated examples for Schema Extra

* 🍱 Add new Annnotated source examples for Extra Data Types

* 📝 Update docs with Annotated for Extra Data Types

* ✅ Add tests for new Annotated examples for Extra Data Types

* 🍱 Add new Annotated source examples for Cookie Parameters

* 📝 Update docs for Cookie Parameters with Annotated examples

* ✅ Add tests for new Annotated source examples in Cookie Parameters

* 🍱 Add new Annotated examples for Header Params

* 📝 Update docs with Annotated examples for Header Parameters

* ✅ Add tests for new Annotated examples for Header Params

* 🍱 Add new Annotated examples for Form Data

* 📝 Update Annotated docs for Form Data

* ✅ Add tests for new Annotated examples in Form Data

* 🍱 Add new Annotated source examples for Request Files

* 📝 Update Annotated docs for Request Files

* ✅ Test new Annotated examples for Request Files

* 🍱 Add new Annotated source examples for Request Forms and Files

* ✅ Add tests for new Anotated examples for Request Forms and Files

* 🍱 Add new Annotated source examples for Dependencies and Advanced Dependencies

* ✅ Add tests for new Annotated dependencies

* 📝 Add new docs for using Annotated with dependencies including type aliases

* 📝 Update docs for Classes as Dependencies with Annotated

* 📝 Update docs for Sub-dependencies with Annotated

* 📝 Update docs for Dependencies in path operation decorators with Annotated

* 📝 Update docs for Global Dependencies with Annotated

* 📝 Update docs for Dependencies with yield with Annotated

* 🎨 Update format in example for dependencies with Annotated

* 🍱 Add source examples with Annotated for Security

* ✅ Add tests for new Annotated examples for security

* 📝 Update docs for Security - First Steps with Annotated

* 📝 Update docs for Security: Get Current User with Annotated

* 📝 Update docs for Simple OAuth2 with Password and Bearer with Annotated

* 📝 Update docs for OAuth2 with Password (and hashing), Bearer with JWT tokens with Annotated

* 📝 Update docs for Request Forms and Files with Annotated

* 🍱 Add new source examples for Bigger Applications with Annotated

* ✅ Add new tests for Bigger Applications with Annotated

* 📝 Update docs for Bigger Applications - Multiple Files with Annotated

* 🍱 Add source examples for background tasks with Annotated

* 📝 Update docs for Background Tasks with Annotated

* ✅ Add test for Background Tasks with Anotated

* 🍱 Add new source examples for docs for Testing with Annotated

* 📝 Update docs for Testing with Annotated

* ✅ Add tests for Annotated examples for Testing

* 🍱 Add new source examples for Additional Status Codes with Annotated

* ✅ Add tests for new Annotated examples for Additional Status Codes

* 📝 Update docs for Additional Status Codes with Annotated

* 📝 Update docs for Advanced Dependencies with Annotated

* 📝 Update docs for OAuth2 scopes with Annotated

* 📝 Update docs for HTTP Basic Auth with Annotated

* 🍱 Add source examples with Annotated for WebSockets

* ✅ Add tests for new Annotated examples for WebSockets

* 📝 Update docs for WebSockets with new Annotated examples

* 🍱 Add source examples with Annotated for Settings and Environment Variables

* 📝 Update docs for Settings and Environment Variables with Annotated

* 🍱 Add new source examples for testing dependencies with Annotated

* ✅ Add tests for new examples for testing dependencies

* 📝 Update docs for testing dependencies with new Annotated examples

* ✅ Update and fix marker for Python 3.9 test

* 🔧 Update Ruff ignores for source examples in docs

* ✅ Fix some tests in the grid for Python 3.9 (incorrectly testing 3.10)

* 🔥 Remove source examples and tests for (non existent) docs section about Annotated, as it's covered in all the rest of the docs

tests/test_tutorial/test_testing_dependencies/test_tutorial001_an.py

@@ -0,0 +1,56 @@
+from docs_src.dependency_testing.tutorial001_an import (
+    app,
+    client,
+    test_override_in_items,
+    test_override_in_items_with_params,
+    test_override_in_items_with_q,
+)
+
+
+def test_override_in_items_run():
+    test_override_in_items()
+
+
+def test_override_in_items_with_q_run():
+    test_override_in_items_with_q()
+
+
+def test_override_in_items_with_params_run():
+    test_override_in_items_with_params()
+
+
+def test_override_in_users():
+    response = client.get("/users/")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": None, "skip": 5, "limit": 10},
+    }
+
+
+def test_override_in_users_with_q():
+    response = client.get("/users/?q=foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+def test_override_in_users_with_params():
+    response = client.get("/users/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+def test_normal_app():
+    app.dependency_overrides = None
+    response = client.get("/items/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Items!",
+        "params": {"q": "foo", "skip": 100, "limit": 200},
+    }

tests/test_tutorial/test_testing_dependencies/test_tutorial001_an_py310.py

@@ -0,0 +1,75 @@
+from ...utils import needs_py310
+
+
+@needs_py310
+def test_override_in_items_run():
+    from docs_src.dependency_testing.tutorial001_an_py310 import test_override_in_items
+
+    test_override_in_items()
+
+
+@needs_py310
+def test_override_in_items_with_q_run():
+    from docs_src.dependency_testing.tutorial001_an_py310 import (
+        test_override_in_items_with_q,
+    )
+
+    test_override_in_items_with_q()
+
+
+@needs_py310
+def test_override_in_items_with_params_run():
+    from docs_src.dependency_testing.tutorial001_an_py310 import (
+        test_override_in_items_with_params,
+    )
+
+    test_override_in_items_with_params()
+
+
+@needs_py310
+def test_override_in_users():
+    from docs_src.dependency_testing.tutorial001_an_py310 import client
+
+    response = client.get("/users/")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": None, "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_override_in_users_with_q():
+    from docs_src.dependency_testing.tutorial001_an_py310 import client
+
+    response = client.get("/users/?q=foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_override_in_users_with_params():
+    from docs_src.dependency_testing.tutorial001_an_py310 import client
+
+    response = client.get("/users/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_normal_app():
+    from docs_src.dependency_testing.tutorial001_an_py310 import app, client
+
+    app.dependency_overrides = None
+    response = client.get("/items/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Items!",
+        "params": {"q": "foo", "skip": 100, "limit": 200},
+    }

tests/test_tutorial/test_testing_dependencies/test_tutorial001_an_py39.py

@@ -0,0 +1,75 @@
+from ...utils import needs_py39
+
+
+@needs_py39
+def test_override_in_items_run():
+    from docs_src.dependency_testing.tutorial001_an_py39 import test_override_in_items
+
+    test_override_in_items()
+
+
+@needs_py39
+def test_override_in_items_with_q_run():
+    from docs_src.dependency_testing.tutorial001_an_py39 import (
+        test_override_in_items_with_q,
+    )
+
+    test_override_in_items_with_q()
+
+
+@needs_py39
+def test_override_in_items_with_params_run():
+    from docs_src.dependency_testing.tutorial001_an_py39 import (
+        test_override_in_items_with_params,
+    )
+
+    test_override_in_items_with_params()
+
+
+@needs_py39
+def test_override_in_users():
+    from docs_src.dependency_testing.tutorial001_an_py39 import client
+
+    response = client.get("/users/")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": None, "skip": 5, "limit": 10},
+    }
+
+
+@needs_py39
+def test_override_in_users_with_q():
+    from docs_src.dependency_testing.tutorial001_an_py39 import client
+
+    response = client.get("/users/?q=foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py39
+def test_override_in_users_with_params():
+    from docs_src.dependency_testing.tutorial001_an_py39 import client
+
+    response = client.get("/users/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py39
+def test_normal_app():
+    from docs_src.dependency_testing.tutorial001_an_py39 import app, client
+
+    app.dependency_overrides = None
+    response = client.get("/items/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Items!",
+        "params": {"q": "foo", "skip": 100, "limit": 200},
+    }

tests/test_tutorial/test_testing_dependencies/test_tutorial001_py310.py

@@ -0,0 +1,75 @@
+from ...utils import needs_py310
+
+
+@needs_py310
+def test_override_in_items_run():
+    from docs_src.dependency_testing.tutorial001_py310 import test_override_in_items
+
+    test_override_in_items()
+
+
+@needs_py310
+def test_override_in_items_with_q_run():
+    from docs_src.dependency_testing.tutorial001_py310 import (
+        test_override_in_items_with_q,
+    )
+
+    test_override_in_items_with_q()
+
+
+@needs_py310
+def test_override_in_items_with_params_run():
+    from docs_src.dependency_testing.tutorial001_py310 import (
+        test_override_in_items_with_params,
+    )
+
+    test_override_in_items_with_params()
+
+
+@needs_py310
+def test_override_in_users():
+    from docs_src.dependency_testing.tutorial001_py310 import client
+
+    response = client.get("/users/")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": None, "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_override_in_users_with_q():
+    from docs_src.dependency_testing.tutorial001_py310 import client
+
+    response = client.get("/users/?q=foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_override_in_users_with_params():
+    from docs_src.dependency_testing.tutorial001_py310 import client
+
+    response = client.get("/users/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Users!",
+        "params": {"q": "foo", "skip": 5, "limit": 10},
+    }
+
+
+@needs_py310
+def test_normal_app():
+    from docs_src.dependency_testing.tutorial001_py310 import app, client
+
+    app.dependency_overrides = None
+    response = client.get("/items/?q=foo&skip=100&limit=200")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "message": "Hello Items!",
+        "params": {"q": "foo", "skip": 100, "limit": 200},
+    }