happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

➖ Remove orjson and ujson from default dependencies (#11842)

This commit is contained in:
Sebastián Ramírez 2024-07-14 12:46:40 -05:00 committed by GitHub
parent 7a9396c839
commit 4d3ef06029
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -468,12 +468,15 @@ Used by Starlette:
Used by FastAPI / 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://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. * `fastapi-cli` - to provide the `fastapi` command.
When you install `fastapi` it comes these standard dependencies. 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` ## `fastapi-slim`
If you don't want the extra standard optional dependencies, install `fastapi-slim` instead. If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.

8
docs/en/docs/advanced/custom-response.md
View 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. And it will be documented as such in OpenAPI.
!!! tip !!! tip
The `ORJSONResponse` is currently only available in FastAPI, not in Starlette. The `ORJSONResponse` is only available in FastAPI, not in Starlette.
## HTML Response ## 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. 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` ### `UJSONResponse`
An alternative JSON response using <a href="https://github.com/ultrajson/ultrajson" class="external-link" target="_blank">`ujson`</a>. 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 !!! warning
`ujson` is less careful than Python's built-in implementation in how it handles some edge-cases. `ujson` is less careful than Python's built-in implementation in how it handles some edge-cases.

7
docs/en/docs/index.md
View File

@ -466,12 +466,15 @@ Used by Starlette:
Used by FastAPI / 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://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. * `fastapi-cli` - to provide the `fastapi` command.
When you install `fastapi` it comes these standard dependencies. 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` ## `fastapi-slim`
If you don't want the extra standard optional dependencies, install `fastapi-slim` instead. If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.

4
pyproject.toml
View File

@ -61,10 +61,6 @@ standard = [
"jinja2 >=2.11.2", "jinja2 >=2.11.2",
# For forms and file uploads # For forms and file uploads
"python-multipart >=0.0.7", "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 # To validate email fields
"email_validator >=2.0.0", "email_validator >=2.0.0",
# Uvicorn with uvloop # Uvicorn with uvloop