← pod_r4_v1g

fastapi_14794

resolved RESOLVED PASS · 11 tool calls · 84 s · fastapi/fastapi

Task input

✨ Allow `Response` type hint as dependency annotation

## Summary
Fixes #10127

Using `Response` as a type hint with `Depends` would fail with an assertion error:
```python
def endpoint(response: Annotated[Response, Depends(modify_response)]):
    # AssertionError: Cannot specify \`Depends\` for type Response
```

## Changes
Modified the type annotation handling in `analyze_param()` to check for `Depends` before applying special type handling. When a `Depends` is specified, the dependency is called normally and its return value used.

## Usage
Now supports:
- `response: Annotated[Response, Depends(modify_response)]`
- `response: Response = Depends(modify_response)`

While still supporting regular injection:
- `response: Response`

## Testing
Added comprehensive tests in `tests/test_response_dependency.py`

Tool calls (12)

#ToolArgumentsResult
1run_command
{
 "command": "grep -rn \"Cannot specify \\`Depends\\` for type Response\" ."
}
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
full
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
2run_command
{
 "command": "grep -rn \"Cannot specify `Depends` for type Response\" ."
}
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: Depends: command not found\n", "details": {"stdout": "", "stderr": "/bin/bash: De
full
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: Depends: command not found\n", "details": {"stdout": "", "stderr": "/bin/bash: Depends: command not found\n", "exit_code": 1}}
3run_command
{
 "command": "grep -rn \"Cannot specify\" . | grep \"Response\""
}
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
full
{"status": "error", "error_type": "CommandError", "error_message": "", "details": {"stdout": "", "stderr": "", "exit_code": 1}}
4run_command
{
 "command": "grep -rn \"analyze_param\" ."
}
{"status": "ok", "stdout": "./docs/en/docs/release-notes.md:1909:* \u267b\ufe0f Refactor and simplify internal `analyze_param()` to structure data with dataclas
full
{"status": "ok", "stdout": "./docs/en/docs/release-notes.md:1909:* \u267b\ufe0f Refactor and simplify internal `analyze_param()` to structure data with dataclasses instead of tuple. PR [#12099](https://github.com/fastapi/fastapi/pull/12099) by [@tiangolo](https://github.com/tiangolo).\n./fastapi/dependencies/utils.py:281:        param_details = analyze_param(\n./fastapi/dependencies/utils.py:362:def analyze_param(\n", "stderr": "", "exit_code": 0}
5run_command
{
 "command": "sed -n '362,500p' fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": "def analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info
full
{"status": "ok", "stdout": "def analyze_param(\n    *,\n    param_name: str,\n    annotation: Any,\n    value: Any,\n    is_path_param: bool,\n) -> ParamDetails:\n    field_info = None\n    depends = None\n    type_annotation: Any = Any\n    use_annotation: Any = Any\n    if annotation is not inspect.Signature.empty:\n        use_annotation = annotation\n        type_annotation = annotation\n    # Extract Annotated info\n    if get_origin(use_annotation) is Annotated:\n        annotated_args = get_args(annotation)\n        type_annotation = annotated_args[0]\n        fastapi_annotations = [\n            arg\n            for arg in annotated_args[1:]\n            if isinstance(arg, (FieldInfo, params.Depends))\n        ]\n        fastapi_specific_annotations = [\n            arg\n            for arg in fastapi_annotations\n            if isinstance(\n                arg,\n                (\n                    params.Param,\n                    params.Body,\n                    params.Depends,\n                ),\n            )\n        ]\n        if fastapi_specific_annotations:\n            fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n                fastapi_specific_annotations[-1]\n            )\n        else:\n            fastapi_annotation = None\n        # Set default for Annotated FieldInfo\n        if isinstance(fastapi_annotation, FieldInfo):\n            # Copy `field_info` because we mutate `field_info.default` below.\n            field_info = copy_field_info(\n                field_info=fastapi_annotation,\n                annotation=use_annotation,\n            )\n            assert (\n                field_info.default == Undefined or field_info.default == RequiredParam\n            ), (\n                f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n                f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n            )\n            if value is not inspect.Signature.empty:
6run_command
{
 "command": "sed -n '460,475p' fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": " SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert field_info
full
{"status": "ok", "stdout": "            SecurityScopes,\n        ),\n    ):\n        assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n        assert field_info is None, (\n            f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n        )\n    # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n    elif field_info is None and depends is None:\n        default_value = value if value is not inspect.Signature.empty else RequiredParam\n        if is_path_param:\n            # We might check here that `default_value is RequiredParam`, but the fact is that the same\n            # parameter might sometimes be a path parameter and sometimes not. See\n            # `tests/test_infer_param_optionality.py` for an example.\n            field_info = params.Path(annotation=use_annotation)\n        elif is_uploadfile_or_nonable_uploadfile_annotation(\n", "stderr": "", "exit_code": 0}
7run_command
{
 "command": "cd /workspace && python3 - <<'PY'\nfrom typing import Annotated, Any\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nimport inspect\n\ndef modify_response():\n    return Response(content=\"modified\")\n\n# Mocking the environment for analyze_param\n# analyze_param(param_name, annotation, value, is_path_param)\n\n# Case 1: response: Annotated[Response, Depends(modify_response)]\ntry:\n    print(\"Testing Case 1...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Annotated[Response, Depends(modify_response)],\n        value=inspect.Signature.empty,\n        is_path_param=False\n    )\n    print(\"Case 1 passed\")\nexcept AssertionError as e:\n    print(f\"Case 1 failed: {e}\")\n\n# Case 2: response: Response = Depends(modify_response)\ntry:\n    print(\"Testing Case 2...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Response,\n        value=Depends(modify_response),\n        is_path_param=False\n    )\n    print(\"Case 2 passed\")\nexcept AssertionError as e:\n    print(f\"Case 2 failed: {e}\")\n\n# Case 3: response: Response (Regular injection)\ntry:\n    print(\"Testing Case 3...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Response,\n        value=inspect.Signature.empty,\n        is_path_param=False\n    )\n    print(\"Case 3 passed\")\nexcept AssertionError as e:\n    print(f\"Case 3 failed: {e}\")\nPY\n"
}
{"status": "ok", "stdout": "Testing Case 1...\nCase 1 failed: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\nTesting Case 2...\nCase
full
{"status": "ok", "stdout": "Testing Case 1...\nCase 1 failed: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\nTesting Case 2...\nCase 2 failed: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\nTesting Case 3...\nCase 3 passed\n", "stderr": "", "exit_code": 0}
8run_command
{
 "command": "cd /workspace && python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"fastapi/dependencies/utils.py\"); s = p.read_text()\nold = \"\"\"    if lenient_issubclass(\n        type_annotation,\n        (\n            Request,\n            WebSocket,\n            HTTPConnection,\n            Response,\n            StarletteBackgroundTasks,\n            SecurityScopes,\n        ),\n    ):\n        assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n        assert field_info is None, (\n            f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n        )\"\"\"\nnew = \"\"\"    if depends is None and lenient_issubclass(\n        type_annotation,\n        (\n            Request,\n            WebSocket,\n            HTTPConnection,\n            Response,\n            StarletteBackgroundTasks,\n            SecurityScopes,\n        ),\n    ):\n        assert field_info is None, (\n            f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n        )\"\"\"\nassert s.count(old) == 1, (\"old text found this many times:\", s.count(old))\nt = s.replace(old, new); compile(t, str(p), \"exec\"); p.write_text(t)\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
9run_command
{
 "command": "cd /workspace && python3 - <<'PY'\nfrom typing import Annotated, Any\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nimport inspect\n\ndef modify_response():\n    return Response(content=\"modified\")\n\n# Mocking the environment for analyze_param\n# analyze_param(param_name, annotation, value, is_path_param)\n\n# Case 1: response: Annotated[Response, Depends(modify_response)]\ntry:\n    print(\"Testing Case 1...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Annotated[Response, Depends(modify_response)],\n        value=inspect.Signature.empty,\n        is_path_param=False\n    )\n    print(\"Case 1 passed\")\nexcept AssertionError as e:\n    print(f\"Case 1 failed: {e}\")\n\n# Case 2: response: Response = Depends(modify_response)\ntry:\n    print(\"Testing Case 2...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Response,\n        value=Depends(modify_response),\n        is_path_param=False\n    )\n    print(\"Case 2 passed\")\nexcept AssertionError as e:\n    print(f\"Case 2 failed: {e}\")\n\n# Case 3: response: Response (Regular injection)\ntry:\n    print(\"Testing Case 3...\")\n    analyze_param(\n        param_name=\"response\",\n        annotation=Response,\n        value=inspect.Signature.empty,\n        is_path_param=False\n    )\n    print(\"Case 3 passed\")\nexcept AssertionError as e:\n    print(f\"Case 3 failed: {e}\")\nPY\n"
}
{"status": "ok", "stdout": "Testing Case 1...\nCase 1 passed\nTesting Case 2...\nCase 2 passed\nTesting Case 3...\nCase 3 passed\n", "stderr": "", "exit_code":
full
{"status": "ok", "stdout": "Testing Case 1...\nCase 1 passed\nTesting Case 2...\nCase 2 passed\nTesting Case 3...\nCase 3 passed\n", "stderr": "", "exit_code": 0}
10run_command
{
 "command": "git diff"
}
{"status": "ok", "stdout": "diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py\nindex fc5dfed8..883f9b74 100644\n--- a/fastapi/dependenc
full
{"status": "ok", "stdout": "diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py\nindex fc5dfed8..883f9b74 100644\n--- a/fastapi/dependencies/utils.py\n+++ b/fastapi/dependencies/utils.py\n@@ -449,7 +449,7 @@ def analyze_param(\n         depends = dataclasses.replace(depends, dependency=type_annotation)\n \n     # Handle non-param type annotations like Request\n-    if lenient_issubclass(\n+    if depends is None and lenient_issubclass(\n         type_annotation,\n         (\n             Request,\n@@ -460,7 +460,6 @@ def analyze_param(\n             SecurityScopes,\n         ),\n     ):\n-        assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n         assert field_info is None, (\n             f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n         )\n", "stderr": "", "exit_code": 0}
11run_command
{
 "command": "submit_patch"
}
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: submit_patch: command not found\n", "details": {"stdout": "", "stderr": "/bin/bas
full
{"status": "error", "error_type": "CommandError", "error_message": "/bin/bash: submit_patch: command not found\n", "details": {"stdout": "", "stderr": "/bin/bash: submit_patch: command not found\n", "exit_code": 127}}
12submit_patch
{}
{"status": "ok", "patch_size": 791, "files_changed": 1}
full
{"status": "ok", "patch_size": 791, "files_changed": 1}

Patch

diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py
index fc5dfed8..883f9b74 100644
--- a/fastapi/dependencies/utils.py
+++ b/fastapi/dependencies/utils.py
@@ -449,7 +449,7 @@ def analyze_param(
         depends = dataclasses.replace(depends, dependency=type_annotation)
 
     # Handle non-param type annotations like Request
-    if lenient_issubclass(
+    if depends is None and lenient_issubclass(
         type_annotation,
         (
             Request,
@@ -460,7 +460,6 @@ def analyze_param(
             SecurityScopes,
         ),
     ):
-        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}"
         )

Test output

show
.......                                                                  [100%]
=============================== warnings summary ===============================
../../../../../../../Users/jp/repos/kaggle-gemini-coding-agent-post-training/.envs/overlays/starlette-0.50.0-py3-none-any/starlette/testclient.py:45
  /Users/jp/repos/kaggle-gemini-coding-agent-post-training/.envs/overlays/starlette-0.50.0-py3-none-any/starlette/testclient.py:45: DeprecationWarning: The anyio.abc.BlockingPortal alias is deprecated, use anyio.from_thread.BlockingPortal instead.
    _PortalFactoryType = Callable[[], AbstractContextManager[anyio.abc.BlockingPortal]]

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
7 passed, 1 warning in 0.46s