fastapi 0.112.0__tar.gz → 0.112.2__tar.gz

{fastapi-0.112.0 → fastapi-0.112.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi
-Version: 0.112.0
+Version: 0.112.2
 Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 Classifier: Intended Audience :: Information Technology
@@ -33,15 +33,17 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Project-URL: Homepage, https://github.com/fastapi/fastapi
 Project-URL: Documentation, https://fastapi.tiangolo.com/
 Project-URL: Repository, https://github.com/fastapi/fastapi
+Project-URL: Issues, https://github.com/fastapi/fastapi/issues
+Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/
 Requires-Python: >=3.8
-Requires-Dist: starlette<0.38.0,>=0.37.2
+Requires-Dist: starlette<0.39.0,>=0.37.2
 Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4
 Requires-Dist: typing-extensions>=4.8.0
 Requires-Dist: fastapi-cli[standard]>=0.0.5; extra == "standard"
 Requires-Dist: httpx>=0.23.0; extra == "standard"
 Requires-Dist: jinja2>=2.11.2; extra == "standard"
 Requires-Dist: python-multipart>=0.0.7; extra == "standard"
-Requires-Dist: email_validator>=2.0.0; extra == "standard"
+Requires-Dist: email-validator>=2.0.0; extra == "standard"
 Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
 Requires-Dist: fastapi-cli[standard]>=0.0.5; extra == "all"
 Requires-Dist: httpx>=0.23.0; extra == "all"
@@ -51,7 +53,7 @@ Requires-Dist: itsdangerous>=1.1.0; extra == "all"
 Requires-Dist: pyyaml>=5.3.1; extra == "all"
 Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,>=4.0.1; extra == "all"
 Requires-Dist: orjson>=3.2.1; extra == "all"
-Requires-Dist: email_validator>=2.0.0; extra == "all"
+Requires-Dist: email-validator>=2.0.0; extra == "all"
 Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
 Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
 Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
@@ -193,6 +195,8 @@ FastAPI stands on the shoulders of giants:
 
 ## Installation
 
+Create and activate a <a href="https://fastapi.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a> and then install FastAPI:
+
 <div class="termy">
 
 ```console
@@ -523,7 +527,7 @@ When you install FastAPI with `pip install "fastapi[standard]"` it comes the `st
 
 Used by Pydantic:
 
-* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a> - for email validation.
+* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - for email validation.
 
 Used by Starlette:
 

{fastapi-0.112.0 → fastapi-0.112.2}/README.md

@@ -132,6 +132,8 @@ FastAPI stands on the shoulders of giants:
 
 ## Installation
 
+Create and activate a <a href="https://fastapi.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a> and then install FastAPI:
+
 <div class="termy">
 
 ```console
@@ -462,7 +464,7 @@ When you install FastAPI with `pip install "fastapi[standard]"` it comes the `st
 
 Used by Pydantic:
 
-* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email_validator</code></a> - for email validation.
+* <a href="https://github.com/JoshData/python-email-validator" target="_blank"><code>email-validator</code></a> - for email validation.
 
 Used by Starlette:
 

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/advanced_middleware/tutorial003.py

@@ -3,7 +3,7 @@ from fastapi.middleware.gzip import GZipMiddleware
 
 app = FastAPI()
 
-app.add_middleware(GZipMiddleware, minimum_size=1000)
+app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5)
 
 
 @app.get("/")

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/app_testing/app_b_an/main.py

@@ -34,6 +34,6 @@ async def create_item(item: Item, x_token: Annotated[str, Header()]):
     if x_token != fake_secret_token:
         raise HTTPException(status_code=400, detail="Invalid X-Token header")
     if item.id in fake_db:
-        raise HTTPException(status_code=400, detail="Item already exists")
+        raise HTTPException(status_code=409, detail="Item already exists")
     fake_db[item.id] = item
     return item

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/app_testing/app_b_an_py310/main.py

@@ -33,6 +33,6 @@ async def create_item(item: Item, x_token: Annotated[str, Header()]):
     if x_token != fake_secret_token:
         raise HTTPException(status_code=400, detail="Invalid X-Token header")
     if item.id in fake_db:
-        raise HTTPException(status_code=400, detail="Item already exists")
+        raise HTTPException(status_code=409, detail="Item already exists")
     fake_db[item.id] = item
     return item

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/app_testing/app_b_an_py310/test_main.py

@@ -61,5 +61,5 @@ def test_create_existing_item():
             "description": "There goes my stealer",
         },
     )
-    assert response.status_code == 400
+    assert response.status_code == 409
     assert response.json() == {"detail": "Item already exists"}

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/app_testing/app_b_an_py39/main.py

@@ -33,6 +33,6 @@ async def create_item(item: Item, x_token: Annotated[str, Header()]):
     if x_token != fake_secret_token:
         raise HTTPException(status_code=400, detail="Invalid X-Token header")
     if item.id in fake_db:
-        raise HTTPException(status_code=400, detail="Item already exists")
+        raise HTTPException(status_code=409, detail="Item already exists")
     fake_db[item.id] = item
     return item

{fastapi-0.112.0 → fastapi-0.112.2}/docs_src/app_testing/app_b_an_py39/test_main.py

@@ -61,5 +61,5 @@ def test_create_existing_item():
             "description": "There goes my stealer",
         },
     )
-    assert response.status_code == 400
+    assert response.status_code == 409
     assert response.json() == {"detail": "Item already exists"}

fastapi-0.112.2/docs_src/app_testing/app_b_py310/test_main.py

@@ -0,0 +1,65 @@
+from fastapi.testclient import TestClient
+
+from .main import app
+
+client = TestClient(app)
+
+
+def test_read_item():
+    response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
+    assert response.status_code == 200
+    assert response.json() == {
+        "id": "foo",
+        "title": "Foo",
+        "description": "There goes my hero",
+    }
+
+
+def test_read_item_bad_token():
+    response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
+    assert response.status_code == 400
+    assert response.json() == {"detail": "Invalid X-Token header"}
+
+
+def test_read_nonexistent_item():
+    response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
+    assert response.status_code == 404
+    assert response.json() == {"detail": "Item not found"}
+
+
+def test_create_item():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "coneofsilence"},
+        json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
+    )
+    assert response.status_code == 200
+    assert response.json() == {
+        "id": "foobar",
+        "title": "Foo Bar",
+        "description": "The Foo Barters",
+    }
+
+
+def test_create_item_bad_token():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "hailhydra"},
+        json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
+    )
+    assert response.status_code == 400
+    assert response.json() == {"detail": "Invalid X-Token header"}
+
+
+def test_create_existing_item():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "coneofsilence"},
+        json={
+            "id": "foo",
+            "title": "The Foo ID Stealers",
+            "description": "There goes my stealer",
+        },
+    )
+    assert response.status_code == 409
+    assert response.json() == {"detail": "Item already exists"}

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.112.0"
+__version__ = "0.112.2"
 
 from starlette import status as status
 

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/applications.py

@@ -1056,7 +1056,7 @@ class FastAPI(Starlette):
     def add_api_route(
         self,
         path: str,
-        endpoint: Callable[..., Coroutine[Any, Any, Response]],
+        endpoint: Callable[..., Any],
         *,
         response_model: Any = Default(None),
         status_code: Optional[int] = None,

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/dependencies/utils.py

@@ -342,9 +342,9 @@ def analyze_param(
             if isinstance(arg, (params.Param, params.Body, params.Depends))
         ]
         if fastapi_specific_annotations:
-            fastapi_annotation: Union[
-                FieldInfo, params.Depends, None
-            ] = fastapi_specific_annotations[-1]
+            fastapi_annotation: Union[FieldInfo, params.Depends, None] = (
+                fastapi_specific_annotations[-1]
+            )
         else:
             fastapi_annotation = None
         if isinstance(fastapi_annotation, FieldInfo):

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/param_functions.py

@@ -2343,7 +2343,7 @@ def Security(  # noqa: N802
     ```python
     from typing import Annotated
 
-    from fastapi import Depends, FastAPI
+    from fastapi import Security, FastAPI
 
     from .db import User
     from .security import get_current_active_user

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/params.py

@@ -91,7 +91,7 @@ class Param(FieldInfo):
             max_length=max_length,
             discriminator=discriminator,
             multiple_of=multiple_of,
-            allow_nan=allow_inf_nan,
+            allow_inf_nan=allow_inf_nan,
             max_digits=max_digits,
             decimal_places=decimal_places,
             **extra,
@@ -547,7 +547,7 @@ class Body(FieldInfo):
             max_length=max_length,
             discriminator=discriminator,
             multiple_of=multiple_of,
-            allow_nan=allow_inf_nan,
+            allow_inf_nan=allow_inf_nan,
             max_digits=max_digits,
             decimal_places=decimal_places,
             **extra,

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/routing.py

@@ -3,14 +3,16 @@ import dataclasses
 import email.message
 import inspect
 import json
-from contextlib import AsyncExitStack
+from contextlib import AsyncExitStack, asynccontextmanager
 from enum import Enum, IntEnum
 from typing import (
     Any,
+    AsyncIterator,
     Callable,
     Coroutine,
     Dict,
     List,
+    Mapping,
     Optional,
     Sequence,
     Set,
@@ -67,7 +69,7 @@ from starlette.routing import (
     websocket_session,
 )
 from starlette.routing import Mount as Mount  # noqa
-from starlette.types import ASGIApp, Lifespan, Scope
+from starlette.types import AppType, ASGIApp, Lifespan, Scope
 from starlette.websockets import WebSocket
 from typing_extensions import Annotated, Doc, deprecated
 
@@ -119,6 +121,23 @@ def _prepare_response_content(
     return res
 
 
+def _merge_lifespan_context(
+    original_context: Lifespan[Any], nested_context: Lifespan[Any]
+) -> Lifespan[Any]:
+    @asynccontextmanager
+    async def merged_lifespan(
+        app: AppType,
+    ) -> AsyncIterator[Optional[Mapping[str, Any]]]:
+        async with original_context(app) as maybe_original_state:
+            async with nested_context(app) as maybe_nested_state:
+                if maybe_nested_state is None and maybe_original_state is None:
+                    yield None  # old ASGI compatibility
+                else:
+                    yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}
+
+    return merged_lifespan  # type: ignore[return-value]
+
+
 async def serialize_response(
     *,
     field: Optional[ModelField] = None,
@@ -454,9 +473,9 @@ class APIRoute(routing.Route):
             methods = ["GET"]
         self.methods: Set[str] = {method.upper() for method in methods}
         if isinstance(generate_unique_id_function, DefaultPlaceholder):
-            current_generate_unique_id: Callable[
-                ["APIRoute"], str
-            ] = generate_unique_id_function.value
+            current_generate_unique_id: Callable[[APIRoute], str] = (
+                generate_unique_id_function.value
+            )
         else:
             current_generate_unique_id = generate_unique_id_function
         self.unique_id = self.operation_id or current_generate_unique_id(self)
@@ -482,9 +501,9 @@ class APIRoute(routing.Route):
             # By being a new field, no inheritance will be passed as is. A new model
             # will always be created.
             # TODO: remove when deprecating Pydantic v1
-            self.secure_cloned_response_field: Optional[
-                ModelField
-            ] = create_cloned_field(self.response_field)
+            self.secure_cloned_response_field: Optional[ModelField] = (
+                create_cloned_field(self.response_field)
+            )
         else:
             self.response_field = None  # type: ignore
             self.secure_cloned_response_field = None
@@ -1308,6 +1327,10 @@ class APIRouter(routing.Router):
             self.add_event_handler("startup", handler)
         for handler in router.on_shutdown:
             self.add_event_handler("shutdown", handler)
+        self.lifespan_context = _merge_lifespan_context(
+            self.lifespan_context,
+            router.lifespan_context,
+        )
 
     def get(
         self,

{fastapi-0.112.0 → fastapi-0.112.2}/fastapi/utils.py

@@ -34,9 +34,9 @@ if TYPE_CHECKING:  # pragma: nocover
     from .routing import APIRoute
 
 # Cache for `create_cloned_field`
-_CLONED_TYPES_CACHE: MutableMapping[
-    Type[BaseModel], Type[BaseModel]
-] = WeakKeyDictionary()
+_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (
+    WeakKeyDictionary()
+)
 
 
 def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:

{fastapi-0.112.0 → fastapi-0.112.2}/pyproject.toml

@@ -43,16 +43,18 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP",
 ]
 dependencies = [
-    "starlette>=0.37.2,<0.38.0",
+    "starlette>=0.37.2,<0.39.0",
     "pydantic>=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0",
     "typing-extensions>=4.8.0",
 ]
-version = "0.112.0"
+version = "0.112.2"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/fastapi"
 Documentation = "https://fastapi.tiangolo.com/"
 Repository = "https://github.com/fastapi/fastapi"
+Issues = "https://github.com/fastapi/fastapi/issues"
+Changelog = "https://fastapi.tiangolo.com/release-notes/"
 
 [project.optional-dependencies]
 standard = [
@@ -60,7 +62,7 @@ standard = [
     "httpx >=0.23.0",
     "jinja2 >=2.11.2",
     "python-multipart >=0.0.7",
-    "email_validator >=2.0.0",
+    "email-validator >=2.0.0",
     "uvicorn[standard] >=0.12.0",
 ]
 all = [
@@ -72,7 +74,7 @@ all = [
     "pyyaml >=5.3.1",
     "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0",
     "orjson >=3.2.1",
-    "email_validator >=2.0.0",
+    "email-validator >=2.0.0",
     "uvicorn[standard] >=0.12.0",
     "pydantic-settings >=2.0.0",
     "pydantic-extra-types >=2.0.0",
@@ -129,30 +131,35 @@ xfail_strict = true
 junit_family = "xunit2"
 filterwarnings = [
     "error",
-    "ignore:The loop argument is deprecated since Python 3\\.8, and scheduled for removal in Python 3\\.10:DeprecationWarning:asyncio",
     "ignore:starlette.middleware.wsgi is deprecated and will be removed in a future release\\..*:DeprecationWarning:starlette",
-    "ignore:'cgi' is deprecated:DeprecationWarning",
     "ignore:'crypt' is deprecated and slated for removal in Python 3.13:DeprecationWarning",
     "ignore:You seem to already have a custom.*:RuntimeWarning:trio",
-    "ignore::trio.TrioDeprecationWarning",
-    "ignore::pytest.PytestDeprecationWarning:pytest_cov",
     "ignore:datetime\\.datetime\\.utcfromtimestamp\\(\\) is deprecated and scheduled for removal in a future version\\..*:DeprecationWarning:sqlalchemy",
-    "ignore:datetime\\.datetime\\.utcnow\\(\\) is deprecated and scheduled for removal in a future version\\..*:DeprecationWarning:jose",
+    "ignore:The `hash` argument is deprecated*:DeprecationWarning:trio",
 ]
 
 [tool.coverage.run]
 parallel = true
+data_file = "coverage/.coverage"
 source = [
     "docs_src",
     "tests",
     "fastapi",
 ]
 context = "${CONTEXT}"
+dynamic_context = "test_function"
 omit = [
     "docs_src/response_model/tutorial003_04.py",
     "docs_src/response_model/tutorial003_04_py310.py",
 ]
 
+[tool.coverage.report]
+show_missing = true
+sort = "-Cover"
+
+[tool.coverage.html]
+show_contexts = true
+
 [tool.ruff.lint]
 select = [
     "E",

fastapi-0.112.2/requirements-docs-insiders.txt

@@ -0,0 +1,3 @@
+git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
+git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
+git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

{fastapi-0.112.0 → fastapi-0.112.2}/requirements-docs.txt

@@ -3,16 +3,16 @@
 mkdocs-material==9.5.18
 mdx-include >=1.4.1,<2.0.0
 mkdocs-redirects>=1.2.1,<1.3.0
-typer >=0.12.0
+typer == 0.12.3
 pyyaml >=5.3.1,<7.0.0
 # For Material for MkDocs, Chinese search
 jieba==0.42.1
 # For image processing by Material for MkDocs
 pillow==10.3.0
 # For image processing by Material for MkDocs
-cairosvg==2.7.0
-mkdocstrings[python]==0.24.3
-griffe-typingdoc==0.2.2
+cairosvg==2.7.1
+mkdocstrings[python]==0.25.1
+griffe-typingdoc==0.2.6
 # For griffe, it formats with black
 black==24.3.0
 mkdocs-macros-plugin==1.0.5

{fastapi-0.112.0 → fastapi-0.112.2}/requirements-tests.txt

@@ -3,11 +3,11 @@
 pytest >=7.1.3,<8.0.0
 coverage[toml] >= 6.5.0,< 8.0
 mypy ==1.8.0
-ruff ==0.2.0
+ruff ==0.6.1
 dirty-equals ==0.6.0
 # TODO: once removing databases from tutorial, upgrade SQLAlchemy
 # probably when including SQLModel
-sqlalchemy >=1.3.18,<1.4.43
+sqlalchemy >=1.3.18,<2.0.33
 databases[sqlite] >=0.3.2,<0.7.0
 flask >=1.1.2,<3.0.0
 anyio[trio] >=3.2.1,<4.0.0

fastapi-0.112.2/scripts/deploy_docs_status.py

@@ -0,0 +1,107 @@
+import logging
+import re
+
+from github import Github
+from pydantic import SecretStr
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    github_token: SecretStr
+    deploy_url: str | None = None
+    commit_sha: str
+    run_id: int
+    is_done: bool = False
+
+
+def main():
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+
+    logging.info(f"Using config: {settings.model_dump_json()}")
+    g = Github(settings.github_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    use_pr = next(
+        (pr for pr in repo.get_pulls() if pr.head.sha == settings.commit_sha), None
+    )
+    if not use_pr:
+        logging.error(f"No PR found for hash: {settings.commit_sha}")
+        return
+    commits = list(use_pr.get_commits())
+    current_commit = [c for c in commits if c.sha == settings.commit_sha][0]
+    run_url = f"https://github.com/{settings.github_repository}/actions/runs/{settings.run_id}"
+    if settings.is_done and not settings.deploy_url:
+        current_commit.create_status(
+            state="success",
+            description="No Docs Changes",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No docs changes found")
+        return
+    if not settings.deploy_url:
+        current_commit.create_status(
+            state="pending",
+            description="Deploying Docs",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No deploy URL available yet")
+        return
+    current_commit.create_status(
+        state="success",
+        description="Docs Deployed",
+        context="deploy-docs",
+        target_url=run_url,
+    )
+
+    files = list(use_pr.get_files())
+    docs_files = [f for f in files if f.filename.startswith("docs/")]
+
+    deploy_url = settings.deploy_url.rstrip("/")
+    lang_links: dict[str, list[str]] = {}
+    for f in docs_files:
+        match = re.match(r"docs/([^/]+)/docs/(.*)", f.filename)
+        if not match:
+            continue
+        lang = match.group(1)
+        path = match.group(2)
+        if path.endswith("index.md"):
+            path = path.replace("index.md", "")
+        else:
+            path = path.replace(".md", "/")
+        if lang == "en":
+            link = f"{deploy_url}/{path}"
+        else:
+            link = f"{deploy_url}/{lang}/{path}"
+        lang_links.setdefault(lang, []).append(link)
+
+    links: list[str] = []
+    en_links = lang_links.get("en", [])
+    en_links.sort()
+    links.extend(en_links)
+
+    langs = list(lang_links.keys())
+    langs.sort()
+    for lang in langs:
+        if lang == "en":
+            continue
+        current_lang_links = lang_links[lang]
+        current_lang_links.sort()
+        links.extend(current_lang_links)
+
+    message = f"📝 Docs preview for commit {settings.commit_sha} at: {deploy_url}"
+
+    if links:
+        message += "\n\n### Modified Pages\n\n"
+        message += "\n".join([f"* {link}" for link in links])
+
+    print(message)
+    use_pr.as_issue().create_comment(message)
+
+    logging.info("Finished")
+
+
+if __name__ == "__main__":
+    main()