]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
➖ Remove orjson and ujson from default dependencies (#11842)
authorSebastián Ramírez <tiangolo@gmail.com>
Sun, 14 Jul 2024 17:46:40 +0000 (12:46 -0500)
committerGitHub <noreply@github.com>
Sun, 14 Jul 2024 17:46:40 +0000 (12:46 -0500)
README.md
docs/en/docs/advanced/custom-response.md
docs/en/docs/index.md
pyproject.toml

index ea722d57a368a8cd73cee2f1f8726c829fccac74..e344f97adc816d97ac833a158f98789d4d9f0f2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -468,12 +468,15 @@ Used by Starlette:
 Used by FastAPI / Starlette:
 
 * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
-* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
-* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
 * `fastapi-cli` - to provide the `fastapi` command.
 
 When you install `fastapi` it comes these standard dependencies.
 
+Additional optional dependencies:
+
+* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
+* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
+
 ## `fastapi-slim`
 
 If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.
index 45c7c7bd50b9aaf60989bc0f381b462f443f92a3..1d12173a1053fd5f3d847dce303755cbf63c72d5 100644 (file)
@@ -39,7 +39,7 @@ But if you are certain that the content that you are returning is **serializable
     And it will be documented as such in OpenAPI.
 
 !!! tip
-    The `ORJSONResponse` is currently only available in FastAPI, not in Starlette.
+    The `ORJSONResponse` is only available in FastAPI, not in Starlette.
 
 ## HTML Response
 
@@ -149,10 +149,16 @@ This is the default response used in **FastAPI**, as you read above.
 
 A fast alternative JSON response using <a href="https://github.com/ijl/orjson" class="external-link" target="_blank">`orjson`</a>, as you read above.
 
+!!! info
+    This requires installing `orjson` for example with `pip install orjson`.
+
 ### `UJSONResponse`
 
 An alternative JSON response using <a href="https://github.com/ultrajson/ultrajson" class="external-link" target="_blank">`ujson`</a>.
 
+!!! info
+    This requires installing `ujson` for example with `pip install ujson`.
+
 !!! warning
     `ujson` is less careful than Python's built-in implementation in how it handles some edge-cases.
 
index 434c708934436686867a3d07ea61ece2d23d2da5..8b54f175fea9848c2918626d2ad2264ef85eec67 100644 (file)
@@ -466,12 +466,15 @@ Used by Starlette:
 Used by FastAPI / Starlette:
 
 * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
-* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
-* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
 * `fastapi-cli` - to provide the `fastapi` command.
 
 When you install `fastapi` it comes these standard dependencies.
 
+Additional optional dependencies:
+
+* <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - Required if you want to use `ORJSONResponse`.
+* <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
+
 ## `fastapi-slim`
 
 If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.
index a79845646342bec9f71b37454af67c1cae46f327..dbaa42149897a2ee9829ae6a42b812b09408a615 100644 (file)
@@ -61,10 +61,6 @@ standard = [
     "jinja2 >=2.11.2",
     # For forms and file uploads
     "python-multipart >=0.0.7",
-    # For UJSONResponse
-    "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0",
-    # For ORJSONResponse
-    "orjson >=3.2.1",
     # To validate email fields
     "email_validator >=2.0.0",
     # Uvicorn with uvloop