fastapi 0.115.11__tar.gz → 0.115.12__tar.gz

{fastapi-0.115.11 → fastapi-0.115.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi
-Version: 0.115.11
+Version: 0.115.12
 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

fastapi-0.115.12/docs_src/header_param_models/tutorial003.py

@@ -0,0 +1,19 @@
+from typing import List, Union
+
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: Union[str, None] = None
+    traceparent: Union[str, None] = None
+    x_tag: List[str] = []
+
+
+@app.get("/items/")
+async def read_items(headers: CommonHeaders = Header(convert_underscores=False)):
+    return headers

fastapi-0.115.12/docs_src/header_param_models/tutorial003_an.py

@@ -0,0 +1,22 @@
+from typing import List, Union
+
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+from typing_extensions import Annotated
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: Union[str, None] = None
+    traceparent: Union[str, None] = None
+    x_tag: List[str] = []
+
+
+@app.get("/items/")
+async def read_items(
+    headers: Annotated[CommonHeaders, Header(convert_underscores=False)],
+):
+    return headers

fastapi-0.115.12/docs_src/header_param_models/tutorial003_an_py310.py

@@ -0,0 +1,21 @@
+from typing import Annotated
+
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: str | None = None
+    traceparent: str | None = None
+    x_tag: list[str] = []
+
+
+@app.get("/items/")
+async def read_items(
+    headers: Annotated[CommonHeaders, Header(convert_underscores=False)],
+):
+    return headers

fastapi-0.115.12/docs_src/header_param_models/tutorial003_an_py39.py

@@ -0,0 +1,21 @@
+from typing import Annotated, Union
+
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: Union[str, None] = None
+    traceparent: Union[str, None] = None
+    x_tag: list[str] = []
+
+
+@app.get("/items/")
+async def read_items(
+    headers: Annotated[CommonHeaders, Header(convert_underscores=False)],
+):
+    return headers

fastapi-0.115.12/docs_src/header_param_models/tutorial003_py310.py

@@ -0,0 +1,17 @@
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: str | None = None
+    traceparent: str | None = None
+    x_tag: list[str] = []
+
+
+@app.get("/items/")
+async def read_items(headers: CommonHeaders = Header(convert_underscores=False)):
+    return headers

fastapi-0.115.12/docs_src/header_param_models/tutorial003_py39.py

@@ -0,0 +1,19 @@
+from typing import Union
+
+from fastapi import FastAPI, Header
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class CommonHeaders(BaseModel):
+    host: str
+    save_data: bool
+    if_modified_since: Union[str, None] = None
+    traceparent: Union[str, None] = None
+    x_tag: list[str] = []
+
+
+@app.get("/items/")
+async def read_items(headers: CommonHeaders = Header(convert_underscores=False)):
+    return headers

{fastapi-0.115.11 → fastapi-0.115.12}/fastapi/__init__.py

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

{fastapi-0.115.11 → fastapi-0.115.12}/fastapi/dependencies/utils.py

@@ -133,9 +133,9 @@ def get_param_sub_dependant(
 
 
 def get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:
-    assert callable(
-        depends.dependency
-    ), "A parameter-less dependency must have a callable dependency"
+    assert callable(depends.dependency), (
+        "A parameter-less dependency must have a callable dependency"
+    )
     return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)
 
 
@@ -302,9 +302,9 @@ def get_dependant(
             type_annotation=param_details.type_annotation,
             dependant=dependant,
         ):
-            assert (
-                param_details.field is None
-            ), f"Cannot specify multiple FastAPI annotations for {param_name!r}"
+            assert param_details.field is None, (
+                f"Cannot specify multiple FastAPI annotations for {param_name!r}"
+            )
             continue
         assert param_details.field is not None
         if isinstance(param_details.field.field_info, params.Body):
@@ -439,9 +439,9 @@ def analyze_param(
         ),
     ):
         assert depends is None, f"Cannot specify `Depends` for type {type_annotation!r}"
-        assert (
-            field_info is None
-        ), f"Cannot specify FastAPI annotation for type {type_annotation!r}"
+        assert field_info is None, (
+            f"Cannot specify FastAPI annotation for type {type_annotation!r}"
+        )
     # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value
     elif field_info is None and depends is None:
         default_value = value if value is not inspect.Signature.empty else RequiredParam
@@ -494,9 +494,9 @@ def analyze_param(
             field_info=field_info,
         )
         if is_path_param:
-            assert is_scalar_field(
-                field=field
-            ), "Path params must be of one of the supported types"
+            assert is_scalar_field(field=field), (
+                "Path params must be of one of the supported types"
+            )
         elif isinstance(field_info, params.Query):
             assert (
                 is_scalar_field(field)
@@ -521,9 +521,9 @@ def add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:
     elif field_info_in == params.ParamTypes.header:
         dependant.header_params.append(field)
     else:
-        assert (
-            field_info_in == params.ParamTypes.cookie
-        ), f"non-body parameters must be in path, query, header or cookie: {field.name}"
+        assert field_info_in == params.ParamTypes.cookie, (
+            f"non-body parameters must be in path, query, header or cookie: {field.name}"
+        )
         dependant.cookie_params.append(field)
 
 
@@ -750,9 +750,15 @@ def request_params_to_args(
     first_field = fields[0]
     fields_to_extract = fields
     single_not_embedded_field = False
+    default_convert_underscores = True
     if len(fields) == 1 and lenient_issubclass(first_field.type_, BaseModel):
         fields_to_extract = get_cached_model_fields(first_field.type_)
         single_not_embedded_field = True
+        # If headers are in a Pydantic model, the way to disable convert_underscores
+        # would be with Header(convert_underscores=False) at the Pydantic model level
+        default_convert_underscores = getattr(
+            first_field.field_info, "convert_underscores", True
+        )
 
     params_to_process: Dict[str, Any] = {}
 
@@ -763,7 +769,9 @@ def request_params_to_args(
         if isinstance(received_params, Headers):
             # Handle fields extracted from a Pydantic Model for a header, each field
             # doesn't have a FieldInfo of type Header with the default convert_underscores=True
-            convert_underscores = getattr(field.field_info, "convert_underscores", True)
+            convert_underscores = getattr(
+                field.field_info, "convert_underscores", default_convert_underscores
+            )
             if convert_underscores:
                 alias = (
                     field.alias
@@ -782,9 +790,9 @@ def request_params_to_args(
 
     if single_not_embedded_field:
         field_info = first_field.field_info
-        assert isinstance(
-            field_info, params.Param
-        ), "Params must be subclasses of Param"
+        assert isinstance(field_info, params.Param), (
+            "Params must be subclasses of Param"
+        )
         loc: Tuple[str, ...] = (field_info.in_.value,)
         v_, errors_ = _validate_value_with_model_field(
             field=first_field, value=params_to_process, values=values, loc=loc
@@ -794,9 +802,9 @@ def request_params_to_args(
     for field in fields:
         value = _get_multidict_value(field, received_params)
         field_info = field.field_info
-        assert isinstance(
-            field_info, params.Param
-        ), "Params must be subclasses of Param"
+        assert isinstance(field_info, params.Param), (
+            "Params must be subclasses of Param"
+        )
         loc = (field_info.in_.value, field.alias)
         v_, errors_ = _validate_value_with_model_field(
             field=field, value=value, values=values, loc=loc

{fastapi-0.115.11 → fastapi-0.115.12}/fastapi/openapi/utils.py

@@ -32,6 +32,7 @@ from fastapi.utils import (
     generate_operation_id_for_path,
     is_body_allowed_for_status_code,
 )
+from pydantic import BaseModel
 from starlette.responses import JSONResponse
 from starlette.routing import BaseRoute
 from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY
@@ -113,6 +114,13 @@ def _get_openapi_operation_parameters(
         (ParamTypes.header, header_params),
         (ParamTypes.cookie, cookie_params),
     ]
+    default_convert_underscores = True
+    if len(flat_dependant.header_params) == 1:
+        first_field = flat_dependant.header_params[0]
+        if lenient_issubclass(first_field.type_, BaseModel):
+            default_convert_underscores = getattr(
+                first_field.field_info, "convert_underscores", True
+            )
     for param_type, param_group in parameter_groups:
         for param in param_group:
             field_info = param.field_info
@@ -126,8 +134,21 @@ def _get_openapi_operation_parameters(
                 field_mapping=field_mapping,
                 separate_input_output_schemas=separate_input_output_schemas,
             )
+            name = param.alias
+            convert_underscores = getattr(
+                param.field_info,
+                "convert_underscores",
+                default_convert_underscores,
+            )
+            if (
+                param_type == ParamTypes.header
+                and param.alias == param.name
+                and convert_underscores
+            ):
+                name = param.name.replace("_", "-")
+
             parameter = {
-                "name": param.alias,
+                "name": name,
                 "in": param_type.value,
                 "required": param.required,
                 "schema": param_schema,
@@ -364,9 +385,9 @@ def get_openapi_path(
                     openapi_response = operation_responses.setdefault(
                         status_code_key, {}
                     )
-                    assert isinstance(
-                        process_response, dict
-                    ), "An additional response must be a dict"
+                    assert isinstance(process_response, dict), (
+                        "An additional response must be a dict"
+                    )
                     field = route.response_fields.get(additional_status_code)
                     additional_field_schema: Optional[Dict[str, Any]] = None
                     if field:
@@ -434,9 +455,9 @@ def get_fields_from_routes(
             route, routing.APIRoute
         ):
             if route.body_field:
-                assert isinstance(
-                    route.body_field, ModelField
-                ), "A request body must be a Pydantic Field"
+                assert isinstance(route.body_field, ModelField), (
+                    "A request body must be a Pydantic Field"
+                )
                 body_fields_from_routes.append(route.body_field)
             if route.response_field:
                 responses_from_routes.append(route.response_field)

{fastapi-0.115.11 → fastapi-0.115.12}/fastapi/routing.py

@@ -504,9 +504,9 @@ class APIRoute(routing.Route):
             status_code = int(status_code)
         self.status_code = status_code
         if self.response_model:
-            assert is_body_allowed_for_status_code(
-                status_code
-            ), f"Status code {status_code} must not have a response body"
+            assert is_body_allowed_for_status_code(status_code), (
+                f"Status code {status_code} must not have a response body"
+            )
             response_name = "Response_" + self.unique_id
             self.response_field = create_model_field(
                 name=response_name,
@@ -537,9 +537,9 @@ class APIRoute(routing.Route):
             assert isinstance(response, dict), "An additional response must be a dict"
             model = response.get("model")
             if model:
-                assert is_body_allowed_for_status_code(
-                    additional_status_code
-                ), f"Status code {additional_status_code} must not have a response body"
+                assert is_body_allowed_for_status_code(additional_status_code), (
+                    f"Status code {additional_status_code} must not have a response body"
+                )
                 response_name = f"Response_{additional_status_code}_{self.unique_id}"
                 response_field = create_model_field(
                     name=response_name, type_=model, mode="serialization"
@@ -844,9 +844,9 @@ class APIRouter(routing.Router):
         )
         if prefix:
             assert prefix.startswith("/"), "A path prefix must start with '/'"
-            assert not prefix.endswith(
-                "/"
-            ), "A path prefix must not end with '/', as the routes will start with '/'"
+            assert not prefix.endswith("/"), (
+                "A path prefix must not end with '/', as the routes will start with '/'"
+            )
         self.prefix = prefix
         self.tags: List[Union[str, Enum]] = tags or []
         self.dependencies = list(dependencies or [])
@@ -1256,9 +1256,9 @@ class APIRouter(routing.Router):
         """
         if prefix:
             assert prefix.startswith("/"), "A path prefix must start with '/'"
-            assert not prefix.endswith(
-                "/"
-            ), "A path prefix must not end with '/', as the routes will start with '/'"
+            assert not prefix.endswith("/"), (
+                "A path prefix must not end with '/', as the routes will start with '/'"
+            )
         else:
             for r in router.routes:
                 path = getattr(r, "path")  # noqa: B009

{fastapi-0.115.11 → fastapi-0.115.12}/pyproject.toml

@@ -49,7 +49,7 @@ dependencies = [
     "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.115.11"
+version = "0.115.12"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/fastapi"

{fastapi-0.115.11 → fastapi-0.115.12}/requirements-docs-tests.txt

@@ -1,4 +1,4 @@
 # For mkdocstrings and tests
 httpx >=0.23.0,<0.28.0
 # For linting and generating docs versions
-ruff ==0.6.4
+ruff ==0.9.4

{fastapi-0.115.11 → fastapi-0.115.12}/requirements-docs.txt

@@ -14,6 +14,6 @@ cairosvg==2.7.1
 mkdocstrings[python]==0.26.1
 griffe-typingdoc==0.2.7
 # For griffe, it formats with black
-black==24.10.0
+black==25.1.0
 mkdocs-macros-plugin==1.3.7
 markdown-include-variants==0.0.4

{fastapi-0.115.11 → fastapi-0.115.12}/requirements-tests.txt

@@ -4,7 +4,7 @@ pytest >=7.1.3,<9.0.0
 coverage[toml] >= 6.5.0,< 8.0
 mypy ==1.8.0
 dirty-equals ==0.8.0
-sqlmodel==0.0.22
+sqlmodel==0.0.23
 flask >=1.1.2,<4.0.0
 anyio[trio] >=3.2.1,<5.0.0
 PyJWT==2.8.0

fastapi-0.115.12/requirements-translations.txt

@@ -0,0 +1 @@
+pydantic-ai==0.0.30

{fastapi-0.115.11 → fastapi-0.115.12}/scripts/translate.py

@@ -38,9 +38,9 @@ def get_langs() -> dict[str, str]:
 
 def generate_lang_path(*, lang: str, path: Path) -> Path:
     en_docs_path = Path("docs/en/docs")
-    assert str(path).startswith(
-        str(en_docs_path)
-    ), f"Path must be inside {en_docs_path}"
+    assert str(path).startswith(str(en_docs_path)), (
+        f"Path must be inside {en_docs_path}"
+    )
     lang_docs_path = Path(f"docs/{lang}/docs")
     out_path = Path(str(path).replace(str(en_docs_path), str(lang_docs_path)))
     return out_path
@@ -56,9 +56,9 @@ def translate_page(*, lang: str, path: Path) -> None:
     lang_prompt_content = lang_prompt_path.read_text()
 
     en_docs_path = Path("docs/en/docs")
-    assert str(path).startswith(
-        str(en_docs_path)
-    ), f"Path must be inside {en_docs_path}"
+    assert str(path).startswith(str(en_docs_path)), (
+        f"Path must be inside {en_docs_path}"
+    )
     out_path = generate_lang_path(lang=lang, path=path)
     out_path.parent.mkdir(parents=True, exist_ok=True)
     original_content = path.read_text()

{fastapi-0.115.11 → fastapi-0.115.12}/tests/test_enforce_once_required_parameter.py

@@ -48,7 +48,7 @@ expected_schema = {
                         "type": "array",
                     },
                     "msg": {"title": "Message", "type": "string"},
-                    "type": {"title": "Error " "Type", "type": "string"},
+                    "type": {"title": "Error Type", "type": "string"},
                 },
                 "required": ["loc", "msg", "type"],
                 "title": "ValidationError",
@@ -73,7 +73,7 @@ expected_schema = {
                 "responses": {
                     "200": {
                         "content": {"application/json": {"schema": {}}},
-                        "description": "Successful " "Response",
+                        "description": "Successful Response",
                     },
                     "422": {
                         "content": {
@@ -83,7 +83,7 @@ expected_schema = {
                                 }
                             }
                         },
-                        "description": "Validation " "Error",
+                        "description": "Validation Error",
                     },
                 },
                 "summary": "Foo Handler",

{fastapi-0.115.11 → fastapi-0.115.12}/tests/test_generic_parameterless_depends.py

@@ -55,7 +55,7 @@ def test_openapi_schema():
                     "responses": {
                         "200": {
                             "content": {"application/json": {"schema": {}}},
-                            "description": "Successful " "Response",
+                            "description": "Successful Response",
                         }
                     },
                     "summary": "A",
@@ -67,7 +67,7 @@ def test_openapi_schema():
                     "responses": {
                         "200": {
                             "content": {"application/json": {"schema": {}}},
-                            "description": "Successful " "Response",
+                            "description": "Successful Response",
                         }
                     },
                     "summary": "B",

{fastapi-0.115.11 → fastapi-0.115.12}/tests/test_repeated_dependency_schema.py

@@ -41,7 +41,7 @@ schema = {
                         "type": "array",
                     },
                     "msg": {"title": "Message", "type": "string"},
-                    "type": {"title": "Error " "Type", "type": "string"},
+                    "type": {"title": "Error Type", "type": "string"},
                 },
                 "required": ["loc", "msg", "type"],
                 "title": "ValidationError",
@@ -66,7 +66,7 @@ schema = {
                 "responses": {
                     "200": {
                         "content": {"application/json": {"schema": {}}},
-                        "description": "Successful " "Response",
+                        "description": "Successful Response",
                     },
                     "422": {
                         "content": {
@@ -76,7 +76,7 @@ schema = {
                                 }
                             }
                         },
-                        "description": "Validation " "Error",
+                        "description": "Validation Error",
                     },
                 },
                 "summary": "Get Deps",

fastapi-0.115.12/tests/test_tutorial/test_configure_swagger_ui/test_tutorial001.py

@@ -0,0 +1,41 @@
+from fastapi.testclient import TestClient
+
+from docs_src.configure_swagger_ui.tutorial001 import app
+
+client = TestClient(app)
+
+
+def test_swagger_ui():
+    response = client.get("/docs")
+    assert response.status_code == 200, response.text
+    assert '"syntaxHighlight": false' in response.text, (
+        "syntaxHighlight should be included and converted to JSON"
+    )
+    assert '"dom_id": "#swagger-ui"' in response.text, (
+        "default configs should be preserved"
+    )
+    assert "presets: [" in response.text, "default configs should be preserved"
+    assert "SwaggerUIBundle.presets.apis," in response.text, (
+        "default configs should be preserved"
+    )
+    assert "SwaggerUIBundle.SwaggerUIStandalonePreset" in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"layout": "BaseLayout",' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"deepLinking": true,' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showCommonExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+
+
+def test_get_users():
+    response = client.get("/users/foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {"message": "Hello foo"}

fastapi-0.115.12/tests/test_tutorial/test_configure_swagger_ui/test_tutorial002.py

@@ -0,0 +1,44 @@
+from fastapi.testclient import TestClient
+
+from docs_src.configure_swagger_ui.tutorial002 import app
+
+client = TestClient(app)
+
+
+def test_swagger_ui():
+    response = client.get("/docs")
+    assert response.status_code == 200, response.text
+    assert '"syntaxHighlight": false' not in response.text, (
+        "not used parameters should not be included"
+    )
+    assert '"syntaxHighlight": {"theme": "obsidian"}' in response.text, (
+        "parameters with middle dots should be included in a JSON compatible way"
+    )
+    assert '"dom_id": "#swagger-ui"' in response.text, (
+        "default configs should be preserved"
+    )
+    assert "presets: [" in response.text, "default configs should be preserved"
+    assert "SwaggerUIBundle.presets.apis," in response.text, (
+        "default configs should be preserved"
+    )
+    assert "SwaggerUIBundle.SwaggerUIStandalonePreset" in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"layout": "BaseLayout",' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"deepLinking": true,' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showCommonExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+
+
+def test_get_users():
+    response = client.get("/users/foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {"message": "Hello foo"}

fastapi-0.115.12/tests/test_tutorial/test_configure_swagger_ui/test_tutorial003.py

@@ -0,0 +1,44 @@
+from fastapi.testclient import TestClient
+
+from docs_src.configure_swagger_ui.tutorial003 import app
+
+client = TestClient(app)
+
+
+def test_swagger_ui():
+    response = client.get("/docs")
+    assert response.status_code == 200, response.text
+    assert '"deepLinking": false,' in response.text, (
+        "overridden configs should be preserved"
+    )
+    assert '"deepLinking": true' not in response.text, (
+        "overridden configs should not include the old value"
+    )
+    assert '"syntaxHighlight": false' not in response.text, (
+        "not used parameters should not be included"
+    )
+    assert '"dom_id": "#swagger-ui"' in response.text, (
+        "default configs should be preserved"
+    )
+    assert "presets: [" in response.text, "default configs should be preserved"
+    assert "SwaggerUIBundle.presets.apis," in response.text, (
+        "default configs should be preserved"
+    )
+    assert "SwaggerUIBundle.SwaggerUIStandalonePreset" in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"layout": "BaseLayout",' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+    assert '"showCommonExtensions": true,' in response.text, (
+        "default configs should be preserved"
+    )
+
+
+def test_get_users():
+    response = client.get("/users/foo")
+    assert response.status_code == 200, response.text
+    assert response.json() == {"message": "Hello foo"}