← pod_r5_v1h

fastapi_14794

resolved RESOLVED PASS · 23 tool calls · 105 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 (24)

#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 \"Cannot specify\" ."
}
{"status": "ok", "stdout": "./tests/test_ambiguous_params.py:44: \"Cannot specify `Depends` in `Annotated` and default value\"\n./tests/test_ambiguous_params.py
full
{"status": "ok", "stdout": "./tests/test_ambiguous_params.py:44:            \"Cannot specify `Depends` in `Annotated` and default value\"\n./tests/test_ambiguous_params.py:56:            \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n./fastapi/dependencies/utils.py:320:                f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n./fastapi/dependencies/utils.py:427:            \"Cannot specify `Depends` in `Annotated` and default value\"\n./fastapi/dependencies/utils.py:431:            \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n./fastapi/dependencies/utils.py:438:            \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n./fastapi/dependencies/utils.py:463:        assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n./fastapi/dependencies/utils.py:465:            f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n", "stderr": "", "exit_code": 0}
5run_command
{
 "command": "sed -n '450,470p' fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": "\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPCo
full
{"status": "ok", "stdout": "\n    # Handle non-param type annotations like Request\n    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        )\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", "stderr": "", "exit_code": 0}
6run_command
{
 "command": "sed -n '410,470p' fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": " assert (\n field_info.default == Undefined or field_info.default == RequiredParam\n ), (\n f\"`{field_info.__class__.__name__}` def
full
{"status": "ok", "stdout": "            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:\n                assert not is_path_param, \"Path parameters cannot have default values\"\n                field_info.default = value\n            else:\n                field_info.default = RequiredParam\n        # Get Annotated Depends\n        elif isinstance(fastapi_annotation, params.Depends):\n            depends = fastapi_annotation\n    # Get Depends from default value\n    if isinstance(value, params.Depends):\n        assert depends is None, (\n            \"Cannot specify `Depends` in `Annotated` and default value\"\n            f\" together for {param_name!r}\"\n        )\n        assert field_info is None, (\n            \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n            f\" default value together for {param_name!r}\"\n        )\n        depends = value\n    # Get FieldInfo from default value\n    elif isinstance(value, FieldInfo):\n        assert field_info is None, (\n            \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n            f\" together for {param_name!r}\"\n        )\n        field_info = value\n        if isinstance(field_info, FieldInfo):\n            field_info.annotation = type_annotation\n\n    # Get Depends from type annotation\n    if depends is not None and depends.dependency is None:\n        # Copy `depends` before mutating it\n        depends = copy(depends)\n        depends = dataclasses.replace(depends, dependency=type_annotation)\n\n    # Handle non-param type annotations like Request\n    if lenient_issubclass(\n        type_annotation,\n        (\n            Re
7run_command
{
 "command": "cat > /tmp/repro.py <<'PY'\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nfrom typing import Annotated\nimport inspect\n\ndef modify_response(response: Response):\n    return response\n\napp = FastAPI()\n\ndef test_response_dependency():\n    # This should now work\n    def endpoint(response: Annotated[Response, Depends(modify_response)]):\n        return response\n\n    # In a real app, analyze_param is called during route registration\n    # We need to see if it raises AssertionError\n    try:\n        analyze_param(\"response\", Annotated[Response, Depends(modify_response)], \n                      inspect.Signature.empty, None, False, None, None)\n        print(\"Success\")\n    except AssertionError as e:\n        print(f\"AssertionError: {e}\")\n\nif __name__ == \"__main__\":\n    test_response_dependency()\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
8run_command
{
 "command": "python3 /tmp/repro.py"
}
{"status": "error", "error_type": "CommandError", "error_message": "Traceback (most recent call last):\n File \"/tmp/repro.py\", line 26, in <module>\n test_res
full
{"status": "error", "error_type": "CommandError", "error_message": "Traceback (most recent call last):\n  File \"/tmp/repro.py\", line 26, in <module>\n    test_response_dependency()\n    ~~~~~~~~~~~~~~~~~~~~~~~~^^\n  File \"/tmp/repro.py\", line 19, in test_response_dependency\n    analyze_param(\"response\", Annotated[Response, Depends(modify_response)],\n    ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n                  inspect.Signature.empty, None, False, None, None)\n                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nTypeError: analyze_param() takes 0 positional arguments but 7 were given\n", "details": {"stdout": "", "stderr": "Traceback (most recent call last):\n  File \"/tmp/repro.py\", line 26, in <module>\n    test_response_dependency()\n    ~~~~~~~~~~~~~~~~~~~~~~~~^^\n  File \"/tmp/repro.py\", line 19, in test_response_dependency\n    analyze_param(\"response\", Annotated[Response, Depends(modify_response)],\n    ~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n                  inspect.Signature.empty, None, False, None, None)\n                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nTypeError: analyze_param() takes 0 positional arguments but 7 were given\n", "exit_code": 1}}
9run_command
{
 "command": "grep -n \"def analyze_param\" fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": "362:def analyze_param(\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "362:def analyze_param(\n", "stderr": "", "exit_code": 0}
10run_command
{
 "command": "sed -n '362,380p' 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", "stderr": "", "exit_code": 0}
11run_command
{
 "command": "cat > /tmp/repro.py <<'PY'\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nfrom typing import Annotated\nimport inspect\n\ndef modify_response(response: Response):\n    return response\n\ndef test_response_dependency():\n    # This should now work\n    def endpoint(response: Annotated[Response, Depends(modify_response)]):\n        return response\n\n    try:\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(\"Success\")\n    except AssertionError as e:\n        print(f\"AssertionError: {e}\")\n\nif __name__ == \"__main__\":\n    test_response_dependency()\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
12run_command
{
 "command": "python3 /tmp/repro.py"
}
{"status": "ok", "stdout": "AssertionError: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "AssertionError: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\n", "stderr": "", "exit_code": 0}
13run_command
{
 "command": "sed -n '450,470p' fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": "\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPCo
full
{"status": "ok", "stdout": "\n    # Handle non-param type annotations like Request\n    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        )\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", "stderr": "", "exit_code": 0}
14run_command
{
 "command": "cd /workspace && python3 - <<'PY'\nfrom pathlib import Path\np = Path(\"fastapi/dependencies/utils.py\")\ns = p.read_text()\nold = \"\"\"    # Handle non-param type annotations like Request\n    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 = \"\"\"    # Handle non-param type annotations like Request\n    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        )\"\"\"\nt = s.replace(old, new)\np.write_text(t)\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
15run_command
{
 "command": "python3 /tmp/repro.py"
}
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
16run_command
{
 "command": "cat > /tmp/repro_regular_injection.py <<'PY'\nfrom fastapi import FastAPI, Response\nfrom fastapi.dependencies.utils import analyze_param\nfrom typing import Annotated\nimport inspect\n\ndef test_regular_injection():\n    # Regular injection should still work\n    try:\n        analyze_param(\n            param_name=\"response\", \n            annotation=Response, \n            value=inspect.Signature.empty, \n            is_path_param=False\n        )\n        print(\"Success\")\n    except AssertionError as e:\n        print(f\"AssertionError: {e}\")\n\nif __name__ == \"__main__\":\n    test_regular_injection()\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
17run_command
{
 "command": "python3 /tmp/repro_regular_injection.py"
}
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
18run_command
{
 "command": "cat > /tmp/repro_default_value.py <<'PY'\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nfrom typing import Annotated\nimport inspect\n\ndef modify_response(response: Response):\n    return response\n\ndef test_response_dependency_default():\n    # response: Response = Depends(modify_response)\n    try:\n        analyze_param(\n            param_name=\"response\", \n            annotation=Response, \n            value=Depends(modify_response), \n            is_path_param=False\n        )\n        print(\"Success\")\n    except AssertionError as e:\n        print(f\"AssertionError: {e}\")\n\nif __name__ == \"__main__\":\n    test_response_dependency_default()\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
19run_command
{
 "command": "python3 /tmp/repro_default_value.py"
}
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "Success\n", "stderr": "", "exit_code": 0}
20run_command
{
 "command": "cat > /tmp/repro_invalid.py <<'PY'\nfrom fastapi import FastAPI, Response, Depends\nfrom fastapi.dependencies.utils import analyze_param\nfrom typing import Annotated\nimport inspect\n\ndef test_invalid_response_annotation():\n    # We should still fail if it's just Response and some other FastAPI annotation (not Depends)\n    # Since field_info is used for other FastAPI annotations, let's try something that sets field_info.\n    # For example, using a FastAPI annotation in Annotated.\n    # Actually, the only other thing that sets field_info is if it's a FieldInfo or similar.\n    # Let's try to see if any other FastAPI annotation should still fail.\n    \n    # Let's try something like: response: Annotated[Response, SomeOtherFastAPIAnnotation()]\n    # Since we don't have a 'SomeOtherFastAPIAnnotation' easily, let's just check if \n    # the logic for field_info is still there.\n    pass\n\nif __name__ == \"__main__\":\n    test_invalid_response_annotation()\nPY\n"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
21run_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}
22run_command
{
 "command": "python3 -m py_compile fastapi/dependencies/utils.py"
}
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
full
{"status": "ok", "stdout": "", "stderr": "", "exit_code": 0}
23run_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}}
24submit_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.57s