← eval7_submission_v1n

fastapi_14964

failed WRONG_FIX wrong_fix · 11 tool calls · 142 s · fastapi/fastapi

Task input

🗑️ Deprecate `ORJSONResponse` and `UJSONResponse`

🗑️ Deprecate `ORJSONResponse` and `UJSONResponse`

Now that there's better performance by default, with response models: https://github.com/fastapi/fastapi/pull/14962

This removes `ujson` and `orjson` from the `"fastapi[all]"` extras.

To use these responses, `ujson` or `orjson` need to be explicitly installed.

Tool calls (12)

#ToolArgumentsResult
1run_command
{
 "command": "grep -rn \"ORJSONResponse\" fastapi | head -20"
}
{"status": "ok", "stdout": "fastapi/applications.py:369: from fastapi.responses import ORJSONResponse\nfastapi/applications.py:371: app = FastAPI(default_respon
full
{"status": "ok", "stdout": "fastapi/applications.py:369:                from fastapi.responses import ORJSONResponse\nfastapi/applications.py:371:                app = FastAPI(default_response_class=ORJSONResponse)\nfastapi/applications.py:1461:                from fastapi.responses import ORJSONResponse\nfastapi/applications.py:1469:                    default_response_class=ORJSONResponse,\nfastapi/responses.py:36:class ORJSONResponse(JSONResponse):\nfastapi/responses.py:45:        assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"\n", "stderr": "", "exit_code": 0}
2run_command
{
 "command": "grep -rn \"UJSONResponse\" fastapi | head -20"
}
{"status": "ok", "stdout": "fastapi/responses.py:23:class UJSONResponse(JSONResponse):\nfastapi/responses.py:32: assert ujson is not None, \"ujson must be insta
full
{"status": "ok", "stdout": "fastapi/responses.py:23:class UJSONResponse(JSONResponse):\nfastapi/responses.py:32:        assert ujson is not None, \"ujson must be installed to use UJSONResponse\"\n", "stderr": "", "exit_code": 0}
3run_command
{
 "command": "grep -rn \"warnings\" fastapi/responses.py"
}
{"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": "cat fastapi/responses.py"
}
{"status": "ok", "stdout": "from typing import Any\n\nfrom starlette.responses import FileResponse as FileResponse # noqa\nfrom starlette.responses import HTMLR
full
{"status": "ok", "stdout": "from typing import Any\n\nfrom starlette.responses import FileResponse as FileResponse  # noqa\nfrom starlette.responses import HTMLResponse as HTMLResponse  # noqa\nfrom starlette.responses import JSONResponse as JSONResponse  # noqa\nfrom starlette.responses import PlainTextResponse as PlainTextResponse  # noqa\nfrom starlette.responses import RedirectResponse as RedirectResponse  # noqa\nfrom starlette.responses import Response as Response  # noqa\nfrom starlette.responses import StreamingResponse as StreamingResponse  # noqa\n\ntry:\n    import ujson\nexcept ImportError:  # pragma: nocover\n    ujson = None  # type: ignore\n\n\ntry:\n    import orjson\nexcept ImportError:  # pragma: nocover\n    orjson = None  # type: ignore\n\n\nclass UJSONResponse(JSONResponse):\n    \"\"\"\n    JSON response using the high-performance ujson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \"\"\"\n\n    def render(self, content: Any) -> bytes:\n        assert ujson is not None, \"ujson must be installed to use UJSONResponse\"\n        return ujson.dumps(content, ensure_ascii=False).encode(\"utf-8\")\n\n\nclass ORJSONResponse(JSONResponse):\n    \"\"\"\n    JSON response using the high-performance orjson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \"\"\"\n\n    def render(self, content: Any) -> bytes:\n        assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"\n        return orjson.dumps(\n            content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY\n        )\n", "stderr": "", "exit_code": 0}
5run_command
{
 "command": "grep -rn \"warnings\" fastapi | head -20"
}
{"status": "ok", "stdout": "fastapi/_compat/shared.py:3:import warnings\nfastapi/_compat/shared.py:182: with warnings.catch_warnings():\nfastapi/_compat/shared.
full
{"status": "ok", "stdout": "fastapi/_compat/shared.py:3:import warnings\nfastapi/_compat/shared.py:182:        with warnings.catch_warnings():\nfastapi/_compat/shared.py:183:            warnings.simplefilter(\"ignore\", UserWarning)\nfastapi/_compat/shared.py:194:        with warnings.catch_warnings():\nfastapi/_compat/shared.py:195:            warnings.simplefilter(\"ignore\", UserWarning)\nfastapi/_compat/v2.py:2:import warnings\nfastapi/_compat/v2.py:129:        with warnings.catch_warnings():\nfastapi/_compat/v2.py:135:                from pydantic.warnings import UnsupportedFieldAttributeWarning\nfastapi/_compat/v2.py:137:                warnings.simplefilter(\nfastapi/exceptions.py:255:    Ref: https://sethmlarson.dev/deprecations-via-warnings-dont-work-for-python-libraries\nfastapi/utils.py:2:import warnings\nfastapi/utils.py:83:    warnings.warn(\nfastapi/params.py:1:import warnings\nfastapi/params.py:76:            warnings.warn(\nfastapi/params.py:106:            warnings.warn(\nfastapi/params.py:521:            warnings.warn(\nfastapi/params.py:551:            warnings.warn(\nfastapi/openapi/utils.py:4:import warnings\nfastapi/openapi/utils.py:218:    warnings.warn(\nfastapi/openapi/utils.py:254:        warnings.warn(message, stacklevel=1)\n", "stderr": "", "exit_code": 0}
6edit_file
{
 "filepath": "fastapi/responses.py",
 "new_string": "from typing import Any\n\nimport warnings\n\nfrom starlette.responses import FileResponse as FileResponse  # noqa\nfrom starlette.responses import HTMLResponse as HTMLResponse  # noqa\nfrom starlette.responses import JSONResponse as JSONResponse  # noqa\nfrom starlette.responses import PlainTextResponse as PlainTextResponse  # noqa\nfrom starlette.responses import RedirectResponse as RedirectResponse  # noqa\nfrom starlette.responses import Response as Response  # noqa\nfrom starlette.responses import StreamingResponse as StreamingResponse  # noqa\n\ntry:\n    import ujson\nexcept ImportError:  # pragma: nocover\n    ujson = None  # type: ignore\n\n\ntry:\n    import orjson\nexcept ImportError:  # pragma: nocover\n    orjson = None  # type: ignore\n\n\nclass UJSONResponse(JSONResponse):\n    \\\"\\\"\\\"\n    JSON response using the high-performance ujson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \\\"\\\"\\\"\n\n    def render(self, content: Any) -> bytes:\n        warnings.warn(\n            \\\"UJSONResponse is deprecated. Use JSONResponse instead.\\\",\n            DeprecationWarning,\n            stacklevel=2,\n        )\n        assert ujson is not None, \\\"ujson must be installed to use UJSONResponse\\\"\n        return ujson.dumps(content, ensure_ascii=False).encode(\\\"utf-8\\\")\n\n\nclass ORJSONResponse(JSONResponse):\n    \\\"\\\"\\\"\n    JSON response using the high-performance orjson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \\\"\\\"\\\"\n\n    def render(self, content: Any) -> bytes:\n        warnings.warn(\n            \\\"ORJSONResponse is deprecated. Use JSONResponse instead.\\\",\n            DeprecationWarning,\n            stacklevel=2,\n        )\n        assert orjson is not None, \\\"orjson must be installed to use ORJSONResponse\\\"\n        return orjson.dumps(\n            content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY\n        )\n",
 "old_string": "from typing import Any\n\nfrom starlette.responses import FileResponse as FileResponse  # noqa\nfrom starlette.responses import HTMLResponse as HTMLResponse  # noqa\nfrom starlette.responses import JSONResponse as JSONResponse  # noqa\nfrom starlette.responses import PlainTextResponse as PlainTextResponse  # noqa\nfrom starlette.responses import RedirectResponse as RedirectResponse  # noqa\nfrom starlette.responses import Response as Response  # noqa\nfrom starlette.responses import StreamingResponse as StreamingResponse  # noqa\n\ntry:\n    import ujson\nexcept ImportError:  # pragma: nocover\n    ujson = None  # type: ignore\n\n\ntry:\n    import orjson\nexcept ImportError:  # pragma: nocover\n    orjson = None  # type: ignore\n\n\nclass UJSONResponse(JSONResponse):\n    \\\"\\\"\\\"\n    JSON response using the high-performance ujson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \\\"\\\"\\\"\n\n    def render(self, content: Any) -> bytes:\n        assert ujson is not None, \\\"ujson must be installed to use UJSONResponse\\\"\n        return ujson.dumps(content, ensure_ascii=False).encode(\\\"utf-8\\\")\n\n\nclass ORJSONResponse(JSONResponse):\n    \\\"\\\"\\\"\n    JSON response using the high-performance orjson library to serialize data to JSON.\n\n    Read more about it in the\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).\n    \\\"\\\"\\\"\n\n    def render(self, content: Any) -> bytes:\n        assert orjson is not None, \\\"orjson must
{"status": "error", "error_type": "FileEditError", "error_message": "Failed to replace: old_string not found. Ensure you're not escaping content incorrectly and
full
{"status": "error", "error_type": "FileEditError", "error_message": "Failed to replace: old_string not found. Ensure you're not escaping content incorrectly and check whitespace, indentation, and context."}
7run_command
{
 "command": "cat -A fastapi/responses.py | head -50"
}
{"status": "ok", "stdout": "from typing import Any$\n$\nfrom starlette.responses import FileResponse as FileResponse # noqa$\nfrom starlette.responses import HT
full
{"status": "ok", "stdout": "from typing import Any$\n$\nfrom starlette.responses import FileResponse as FileResponse  # noqa$\nfrom starlette.responses import HTMLResponse as HTMLResponse  # noqa$\nfrom starlette.responses import JSONResponse as JSONResponse  # noqa$\nfrom starlette.responses import PlainTextResponse as PlainTextResponse  # noqa$\nfrom starlette.responses import RedirectResponse as RedirectResponse  # noqa$\nfrom starlette.responses import Response as Response  # noqa$\nfrom starlette.responses import StreamingResponse as StreamingResponse  # noqa$\n$\ntry:$\n    import ujson$\nexcept ImportError:  # pragma: nocover$\n    ujson = None  # type: ignore$\n$\n$\ntry:$\n    import orjson$\nexcept ImportError:  # pragma: nocover$\n    orjson = None  # type: ignore$\n$\n$\nclass UJSONResponse(JSONResponse):$\n    \"\"\"$\n    JSON response using the high-performance ujson library to serialize data to JSON.$\n$\n    Read more about it in the$\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).$\n    \"\"\"$\n$\n    def render(self, content: Any) -> bytes:$\n        assert ujson is not None, \"ujson must be installed to use UJSONResponse\"$\n        return ujson.dumps(content, ensure_ascii=False).encode(\"utf-8\")$\n$\n$\nclass ORJSONResponse(JSONResponse):$\n    \"\"\"$\n    JSON response using the high-performance orjson library to serialize data to JSON.$\n$\n    Read more about it in the$\n    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).$\n    \"\"\"$\n$\n    def render(self, content: Any) -> bytes:$\n        assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"$\n        return orjson.dumps($\n            content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY$\n        )$\n", "stderr": "", "exit_code": 0}
8edit_file
{
 "filepath": "fastapi/responses.py",
 "new_string": "from typing import Any\n\nimport warnings\n\nfrom starlette.responses import FileResponse as FileResponse  # noqa\n",
 "old_string": "from typing import Any\n\nfrom starlette.responses import FileResponse as FileResponse  # noqa\n"
}
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@
full
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@ -1,4 +1,6 @@\n from typing import Any\n+\n+import warnings\n \n from starlette.responses import FileResponse as FileResponse  # noqa\n from starlette.responses import HTMLResponse as HTMLResponse  # noqa\n", "is_truncated": false}
9edit_file
{
 "filepath": "fastapi/responses.py",
 "new_string": "    def render(self, content: Any) -> bytes:\n        warnings.warn(\n            \"UJSONResponse is deprecated. Use JSONResponse instead.\",\n            DeprecationWarning,\n            stacklevel=2,\n        )\n        assert ujson is not None, \"ujson must be installed to use UJSONResponse\"\n        return ujson.dumps(content, ensure_ascii=False).encode(\"utf-8\")\n",
 "old_string": "    def render(self, content: Any) -> bytes:\n        assert ujson is not None, \"ujson must be installed to use UJSONResponse\"\n        return ujson.dumps(content, ensure_ascii=False).encode(\"utf-8\")\n"
}
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@
full
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@ -31,6 +31,11 @@\n     \"\"\"\n \n     def render(self, content: Any) -> bytes:\n+        warnings.warn(\n+            \"UJSONResponse is deprecated. Use JSONResponse instead.\",\n+            DeprecationWarning,\n+            stacklevel=2,\n+        )\n         assert ujson is not None, \"ujson must be installed to use UJSONResponse\"\n         return ujson.dumps(content, ensure_ascii=False).encode(\"utf-8\")\n \n", "is_truncated": false}
10edit_file
{
 "filepath": "fastapi/responses.py",
 "new_string": "    def render(self, content: Any) -> bytes:\n        warnings.warn(\n            \"ORJSONResponse is deprecated. Use JSONResponse instead.\",\n            DeprecationWarning,\n            stacklevel=2,\n        )\n        assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"\n        return orjson.dumps(\n            content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY\n        )\n",
 "old_string": "    def render(self, content: Any) -> bytes:\n        assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"\n        return orjson.dumps(\n            content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY\n        )\n"
}
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@
full
{"status": "ok", "filepath": "fastapi/responses.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/responses.py\n+++ b/fastapi/responses.py\n@@ -49,6 +49,11 @@\n     \"\"\"\n \n     def render(self, content: Any) -> bytes:\n+        warnings.warn(\n+            \"ORJSONResponse is deprecated. Use JSONResponse instead.\",\n+            DeprecationWarning,\n+            stacklevel=2,\n+        )\n         assert orjson is not None, \"orjson must be installed to use ORJSONResponse\"\n         return orjson.dumps(\n             content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY\n", "is_truncated": false}
11run_command
{
 "command": "python3 -c \"import warnings; from fastapi.responses import UJSONResponse, ORJSONResponse; import json; \n\n# Mocking ujson and orjson if not installed for the test\nimport sys\nfrom unittest.mock import MagicMock\nsys.modules['ujson'] = MagicMock()\nsys.modules['orjson'] = MagicMock()\nimport ujson\nimport orjson\n\nwith warnings.catch_warnings(record=True) as w:\n    warnings.simplefilter('always')\n    # We need to instantiate and call render\n    u_resp = UJSONResponse({'foo': 'bar'})\n    u_resp.render({'foo': 'bar'})\n    print(f'UJSONResponse warning: {w[-1].message}')\n\nwith warnings.catch_warnings(record=True) as w:\n    warnings.simplefilter('always')\n    o_resp = ORJSONResponse({'foo': 'bar'})\n    o_resp.render({'foo': 'bar'})\n    print(f'ORJSONResponse warning: {w[-1].message}')\n\""
}
{"status": "ok", "stdout": "UJSONResponse warning: UJSONResponse is deprecated. Use JSONResponse instead.\nORJSONResponse warning: ORJSONResponse is deprecated.
full
{"status": "ok", "stdout": "UJSONResponse warning: UJSONResponse is deprecated. Use JSONResponse instead.\nORJSONResponse warning: ORJSONResponse is deprecated. Use JSONResponse instead.\n", "stderr": "", "exit_code": 0}
12submit_patch
{}
{"status": "ok", "patch_size": 1324, "files_changed": 1}
full
{"status": "ok", "patch_size": 1324, "files_changed": 1}

Patch

diff --git a/fastapi/responses.py b/fastapi/responses.py
index 6c8db6f3..8da97341 100644
--- a/fastapi/responses.py
+++ b/fastapi/responses.py
@@ -1,5 +1,7 @@
 from typing import Any
 
+import warnings
+
 from starlette.responses import FileResponse as FileResponse  # noqa
 from starlette.responses import HTMLResponse as HTMLResponse  # noqa
 from starlette.responses import JSONResponse as JSONResponse  # noqa
@@ -29,6 +31,11 @@ class UJSONResponse(JSONResponse):
     """
 
     def render(self, content: Any) -> bytes:
+        warnings.warn(
+            "UJSONResponse is deprecated. Use JSONResponse instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         assert ujson is not None, "ujson must be installed to use UJSONResponse"
         return ujson.dumps(content, ensure_ascii=False).encode("utf-8")
 
@@ -42,6 +49,11 @@ class ORJSONResponse(JSONResponse):
     """
 
     def render(self, content: Any) -> bytes:
+        warnings.warn(
+            "ORJSONResponse is deprecated. Use JSONResponse instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         assert orjson is not None, "orjson must be installed to use ORJSONResponse"
         return orjson.dumps(
             content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY

Test output

show
.F
=================================== FAILURES ===================================
________________ test_orjson_response_emits_deprecation_warning ________________

    def test_orjson_response_emits_deprecation_warning():
>       with pytest.warns(FastAPIDeprecationWarning, match="ORJSONResponse is deprecated"):
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
E       Failed: DID NOT WARN. No warnings of type (<class 'fastapi.exceptions.FastAPIDeprecationWarning'>,) were emitted.
E        Emitted warnings: [DeprecationWarning('ORJSONResponse is deprecated. Use JSONResponse instead.')].

tests/test_deprecated_responses.py:42: Failed
=============================== warnings summary ===============================
../../../../../../kaggle/tmp/envs/overlays/starlette-0.52.1-py3-none-any/starlette/testclient.py:45
  /kaggle/tmp/envs/overlays/starlette-0.52.1-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]]

tests/test_deprecated_responses.py::test_orjson_response_returns_correct_data
tests/test_deprecated_responses.py::test_orjson_response_emits_deprecation_warning
  /kaggle/tmp/envs/overlays/starlette-0.52.1-py3-none-any/starlette/responses.py:46: DeprecationWarning: ORJSONResponse is deprecated. Use JSONResponse instead.
    self.body = self.render(content)

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
1 failed, 1 passed, 3 warnings in 3.80s