← or20_submission

fastapi_14794

resolved RESOLVED PASS · 8 tool calls · 67 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 (9)

#ToolArgumentsResult
1run_command
{
 "command": "grep -rn \"analyze_param\" fastapi | head -20"
}
{"status": "ok", "stdout": "fastapi/dependencies/utils.py:281: param_details = analyze_param(\nfastapi/dependencies/utils.py:362:def analyze_param(\n", "exit_co
full
{"status": "ok", "stdout": "fastapi/dependencies/utils.py:281:        param_details = analyze_param(\nfastapi/dependencies/utils.py:362:def analyze_param(\n", "exit_code": 0}
2read_file
{
 "filepath": "fastapi/dependencies/utils.py",
 "start_line": 362
}
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": "def analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_
full
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": "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
3run_command
{
 "command": "python3 -c \"\nfrom fastapi import FastAPI, Depends, Response\nfrom typing import Annotated\nimport pytest\n\napp = FastAPI()\n\ndef modify_response(response: Response):\n    response.headers['X-Custom'] = 'value'\n    return response\n\n@app.get('/')\ndef endpoint(response: Annotated[Response, Depends(modify_response)]):\n    return {'message': 'hello'}\n\ntry:\n    from fastapi.dependencies.utils import analyze_param\n    import inspect\n    # Mocking the call to analyze_param as it is used inside FastAPI's route setup\n    # We can just try to create the app and see if it fails during startup/route registration\n    # But since we already created the app, let's see if it worked.\n    print('App created successfully')\nexcept Exception as e:\n    print(f'Error: {e}')\n\""
}
{"status": "error", "error_type": "CommandError", "error_message": "Command failed with exit code 1", "details": {"stdout": "", "stderr": "Traceback (most recen
full
{"status": "error", "error_type": "CommandError", "error_message": "Command failed with exit code 1", "details": {"stdout": "", "stderr": "Traceback (most recent call last):\n  File \"<string>\", line 12, in <module>\n    @app.get('/')\n     ~~~~~~~^^^^^\n  File \"/private/workspace/fastapi/routing.py\", line 1063, in decorator\n    self.add_api_route(\n    ~~~~~~~~~~~~~~~~~~^\n        path,\n        ^^^^^\n    ...<23 lines>...\n        generate_unique_id_function=generate_unique_id_function,\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n    )\n    ^\n  File \"/private/workspace/fastapi/routing.py\", line 1002, in add_api_route\n    route = route_class(\n        self.prefix + path,\n    ...<24 lines>...\n        generate_unique_id_function=current_generate_unique_id,\n    )\n  File \"/private/workspace/fastapi/routing.py\", line 621, in __init__\n    self.dependant = get_dependant(\n                     ~~~~~~~~~~~~~^\n        path=self.path_format, call=self.endpoint, scope=\"function\"\n        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n    )\n    ^\n  File \"/private/workspace/fastapi/dependencies/utils.py\", line 281, in get_dependant\n    param_details = analyze_param(\n        param_name=param_name,\n    ...<2 lines>...\n        is_path_param=is_path_param,\n    )\n  File \"/private/workspace/fastapi/dependencies/utils.py\", line 463, in analyze_param\n    assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n           ^^^^^^^^^^^^^^^\nAssertionError: Cannot specify `Depends` for type <class 'starlette.responses.Response'>\n", "exit_code": 1}}
4read_file
{
 "filepath": "fastapi/dependencies/utils.py",
 "start_line": 455,
 "end_line": 470
}
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": " Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n Sec
full
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": "            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", "start_line": 455, "end_line": 470, "total_lines": 1026, "is_truncated": false}
5edit_file
{
 "filepath": "fastapi/dependencies/utils.py",
 "new_string": "    # 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        )\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:",
 "old_string": "    # 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:"
}
{"status": "error", "error_type": "FileEditError", "error_message": "old_string not found in file (tried exact, flexible and regex matching)"}
full
{"status": "error", "error_type": "FileEditError", "error_message": "old_string not found in file (tried exact, flexible and regex matching)"}
6read_file
{
 "end_line": 468,
 "filepath": "fastapi/dependencies/utils.py",
 "start_line": 450
}
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": "\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_an
full
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "content": "\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", "start_line": 450, "end_line": 468, "total_lines": 1026, "is_truncated": false}
7edit_file
{
 "filepath": "fastapi/dependencies/utils.py",
 "new_string": "    # 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        )\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:",
 "old_string": "    # 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:"
}
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/dependencies/utils.py\n+++ b/fastapi
full
{"status": "ok", "filepath": "fastapi/dependencies/utils.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/dependencies/utils.py\n+++ b/fastapi/dependencies/utils.py\n@@ -449,7 +449,7 @@\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 @@\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", "is_truncated": false}
8run_command
{
 "command": "python3 -c \"\nfrom fastapi import FastAPI, Depends, Response\nfrom typing import Annotated\n\napp = FastAPI()\n\ndef modify_response(response: Response):\n    response.headers['X-Custom'] = 'value'\n    return response\n\n@app.get('/')\ndef endpoint(response: Annotated[Response, Depends(modify_response)]):\n    return {'message': 'hello'}\n\n@app.get('/2')\ndef endpoint2(response: Response = Depends(modify_response)):\n    return {'message': 'hello'}\n\n@app.get('/3')\ndef endpoint3(response: Response):\n    return {'message': 'hello'}\n\nprint('App created successfully')\n\""
}
{"status": "ok", "stdout": "App created successfully\n", "exit_code": 0}
full
{"status": "ok", "stdout": "App created successfully\n", "exit_code": 0}
9submit_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.43s