Compare commits

..

4 Commits

16 changed files with 32 additions and 224 deletions

1
.github/labeler.yml vendored
View File

@@ -31,7 +31,6 @@ internal:
- .pre-commit-config.yaml - .pre-commit-config.yaml
- pdm_build.py - pdm_build.py
- requirements*.txt - requirements*.txt
- uv.lock
- docs/en/data/sponsors.yml - docs/en/data/sponsors.yml
- docs/en/overrides/main.html - docs/en/overrides/main.html
- all-globs-to-all-files: - all-globs-to-all-files:

View File

@@ -164,8 +164,6 @@ $ pip install "fastapi[standard]"
Create a file `main.py` with: Create a file `main.py` with:
```Python ```Python
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@@ -177,7 +175,7 @@ def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None): def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}
``` ```
@@ -186,9 +184,7 @@ def read_item(item_id: int, q: Union[str, None] = None):
If your code uses `async` / `await`, use `async def`: If your code uses `async` / `await`, use `async def`:
```Python hl_lines="9 14" ```Python hl_lines="7 12"
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@@ -200,7 +196,7 @@ async def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
async def read_item(item_id: int, q: Union[str, None] = None): async def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}
``` ```
@@ -291,9 +287,7 @@ Now modify the file `main.py` to receive a body from a `PUT` request.
Declare the body using standard Python types, thanks to Pydantic. Declare the body using standard Python types, thanks to Pydantic.
```Python hl_lines="4 9-12 25-27" ```Python hl_lines="2 7-10 23-25"
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
from pydantic import BaseModel from pydantic import BaseModel
@@ -303,7 +297,7 @@ app = FastAPI()
class Item(BaseModel): class Item(BaseModel):
name: str name: str
price: float price: float
is_offer: Union[bool, None] = None is_offer: bool | None = None
@app.get("/") @app.get("/")
@@ -312,7 +306,7 @@ def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None): def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}

View File

@@ -145,8 +145,6 @@ There are other formats and tools to define and install package dependencies.
* Create a `main.py` file with: * Create a `main.py` file with:
```Python ```Python
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@@ -158,7 +156,7 @@ def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None): def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}
``` ```

View File

@@ -161,8 +161,6 @@ $ pip install "fastapi[standard]"
Create a file `main.py` with: Create a file `main.py` with:
```Python ```Python
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@@ -174,7 +172,7 @@ def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None): def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}
``` ```
@@ -183,9 +181,7 @@ def read_item(item_id: int, q: Union[str, None] = None):
If your code uses `async` / `await`, use `async def`: If your code uses `async` / `await`, use `async def`:
```Python hl_lines="9 14" ```Python hl_lines="7 12"
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
app = FastAPI() app = FastAPI()
@@ -197,7 +193,7 @@ async def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
async def read_item(item_id: int, q: Union[str, None] = None): async def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}
``` ```
@@ -288,9 +284,7 @@ Now modify the file `main.py` to receive a body from a `PUT` request.
Declare the body using standard Python types, thanks to Pydantic. Declare the body using standard Python types, thanks to Pydantic.
```Python hl_lines="4 9-12 25-27" ```Python hl_lines="2 7-10 23-25"
from typing import Union
from fastapi import FastAPI from fastapi import FastAPI
from pydantic import BaseModel from pydantic import BaseModel
@@ -300,7 +294,7 @@ app = FastAPI()
class Item(BaseModel): class Item(BaseModel):
name: str name: str
price: float price: float
is_offer: Union[bool, None] = None is_offer: bool | None = None
@app.get("/") @app.get("/")
@@ -309,7 +303,7 @@ def read_root():
@app.get("/items/{item_id}") @app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None): def read_item(item_id: int, q: str | None = None):
return {"item_id": item_id, "q": q} return {"item_id": item_id, "q": q}

View File

@@ -2,8 +2,6 @@
You can declare a parameter in a *path operation function* or dependency to be of type `Request` and then you can access the raw request object directly, without any validation, etc. You can declare a parameter in a *path operation function* or dependency to be of type `Request` and then you can access the raw request object directly, without any validation, etc.
Read more about it in the [FastAPI docs about using Request directly](https://fastapi.tiangolo.com/advanced/using-request-directly/)
You can import it directly from `fastapi`: You can import it directly from `fastapi`:
```python ```python

View File

@@ -4,8 +4,6 @@ You can declare a parameter in a *path operation function* or dependency to be o
You can also use it directly to create an instance of it and return it from your *path operations*. You can also use it directly to create an instance of it and return it from your *path operations*.
Read more about it in the [FastAPI docs about returning a custom Response](https://fastapi.tiangolo.com/advanced/response-directly/#returning-a-custom-response)
You can import it directly from `fastapi`: You can import it directly from `fastapi`:
```python ```python

View File

@@ -56,8 +56,6 @@ There are a couple of custom FastAPI response classes, you can use them to optim
## Starlette Responses ## Starlette Responses
You can read more about all of them in the [FastAPI docs for Custom Response](https://fastapi.tiangolo.com/advanced/custom-response/) and in the [Starlette docs about Responses](https://starlette.dev/responses/).
::: fastapi.responses.FileResponse ::: fastapi.responses.FileResponse
options: options:
members: members:

View File

@@ -28,8 +28,6 @@ from fastapi.security import (
) )
``` ```
Read more about them in the [FastAPI docs about Security](https://fastapi.tiangolo.com/tutorial/security/).
## API Key Security Schemes ## API Key Security Schemes
::: fastapi.security.APIKeyCookie ::: fastapi.security.APIKeyCookie

View File

@@ -2,8 +2,6 @@
When defining WebSockets, you normally declare a parameter of type `WebSocket` and with it you can read data from the client and send data to it. When defining WebSockets, you normally declare a parameter of type `WebSocket` and with it you can read data from the client and send data to it.
Read more about it in the [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/)
It is provided directly by Starlette, but you can import it from `fastapi`: It is provided directly by Starlette, but you can import it from `fastapi`:
```python ```python
@@ -46,6 +44,16 @@ When you want to define dependencies that should be compatible with both HTTP an
- send_json - send_json
- close - close
When a client disconnects, a `WebSocketDisconnect` exception is raised, you can catch it.
You can import it directly form `fastapi`:
```python
from fastapi import WebSocketDisconnect
```
::: fastapi.WebSocketDisconnect
## WebSockets - additional classes ## WebSockets - additional classes
Additional classes for handling WebSockets. Additional classes for handling WebSockets.
@@ -58,16 +66,4 @@ from fastapi.websockets import WebSocketDisconnect, WebSocketState
::: fastapi.websockets.WebSocketDisconnect ::: fastapi.websockets.WebSocketDisconnect
When a client disconnects, a `WebSocketDisconnect` exception is raised, you can catch it.
You can import it directly form `fastapi`:
```python
from fastapi import WebSocketDisconnect
```
Read more about it in the [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/#handling-disconnections-and-multiple-clients)
::: fastapi.websockets.WebSocketState ::: fastapi.websockets.WebSocketState
`WebSocketState` is an enumeration of the possible states of a WebSocket connection.

View File

@@ -36,7 +36,6 @@ hide:
### Internal ### Internal
* 🔧 Ensure that an edit to `uv.lock` gets the `internal` label. PR [#14759](https://github.com/fastapi/fastapi/pull/14759) by [@svlandeg](https://github.com/svlandeg).
* 🔧 Update sponsors: remove Requestly. PR [#14735](https://github.com/fastapi/fastapi/pull/14735) by [@tiangolo](https://github.com/tiangolo). * 🔧 Update sponsors: remove Requestly. PR [#14735](https://github.com/fastapi/fastapi/pull/14735) by [@tiangolo](https://github.com/tiangolo).
* 🔧 Update sponsors, LambdaTest changes to TestMu AI. PR [#14734](https://github.com/fastapi/fastapi/pull/14734) by [@tiangolo](https://github.com/tiangolo). * 🔧 Update sponsors, LambdaTest changes to TestMu AI. PR [#14734](https://github.com/fastapi/fastapi/pull/14734) by [@tiangolo](https://github.com/tiangolo).
* ⬆ Bump actions/cache from 4 to 5. PR [#14511](https://github.com/fastapi/fastapi/pull/14511) by [@dependabot[bot]](https://github.com/apps/dependabot). * ⬆ Bump actions/cache from 4 to 5. PR [#14511](https://github.com/fastapi/fastapi/pull/14511) by [@dependabot[bot]](https://github.com/apps/dependabot).

View File

@@ -102,15 +102,16 @@ Of course, you can also declare additional query parameters whenever you need, a
As, by default, singular values are interpreted as query parameters, you don't have to explicitly add a `Query`, you can just do: As, by default, singular values are interpreted as query parameters, you don't have to explicitly add a `Query`, you can just do:
```Python
q: str | None = None
```
Or in Python 3.9:
```Python ```Python
q: Union[str, None] = None q: Union[str, None] = None
``` ```
Or in Python 3.10 and above:
```Python
q: str | None = None
```
For example: For example:

View File

@@ -672,7 +672,7 @@ class FastAPI(Starlette):
in the autogenerated OpenAPI using the `root_path`. in the autogenerated OpenAPI using the `root_path`.
Read more about it in the Read more about it in the
[FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#disable-automatic-server-from-root-path). [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#disable-automatic-server-from-root_path).
**Example** **Example**
@@ -739,7 +739,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the Read more about it in the
[FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#deprecate-a-path-operation). [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
""" """
), ),
] = None, ] = None,
@@ -812,9 +812,6 @@ class FastAPI(Starlette):
In this case, there would be two different schemas, one for input and In this case, there would be two different schemas, one for input and
another one for output. another one for output.
Read more about it in the
[FastAPI docs about how to separate schemas for input and output](https://fastapi.tiangolo.com/how-to/separate-openapi-schemas)
""" """
), ),
] = True, ] = True,

View File

@@ -49,9 +49,6 @@ class HTTPException(StarletteHTTPException):
Doc( Doc(
""" """
HTTP status code to send to the client. HTTP status code to send to the client.
Read more about it in the
[FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/#use-httpexception)
""" """
), ),
], ],
@@ -61,9 +58,6 @@ class HTTPException(StarletteHTTPException):
""" """
Any data to be sent to the client in the `detail` key of the JSON Any data to be sent to the client in the `detail` key of the JSON
response. response.
Read more about it in the
[FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/#use-httpexception)
""" """
), ),
] = None, ] = None,
@@ -72,10 +66,6 @@ class HTTPException(StarletteHTTPException):
Doc( Doc(
""" """
Any headers to send to the client in the response. Any headers to send to the client in the response.
Read more about it in the
[FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/#add-custom-headers)
""" """
), ),
] = None, ] = None,

View File

@@ -33,9 +33,6 @@ def get_swagger_ui_html(
This is normally done automatically by FastAPI using the default URL This is normally done automatically by FastAPI using the default URL
`/openapi.json`. `/openapi.json`.
Read more about it in the
[FastAPI docs for Conditional OpenAPI](https://fastapi.tiangolo.com/how-to/conditional-openapi/#conditional-openapi-from-settings-and-env-vars)
""" """
), ),
], ],
@@ -44,9 +41,6 @@ def get_swagger_ui_html(
Doc( Doc(
""" """
The HTML `<title>` content, normally shown in the browser tab. The HTML `<title>` content, normally shown in the browser tab.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
], ],
@@ -57,9 +51,6 @@ def get_swagger_ui_html(
The URL to use to load the Swagger UI JavaScript. The URL to use to load the Swagger UI JavaScript.
It is normally set to a CDN URL. It is normally set to a CDN URL.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js", ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js",
@@ -70,9 +61,6 @@ def get_swagger_ui_html(
The URL to use to load the Swagger UI CSS. The URL to use to load the Swagger UI CSS.
It is normally set to a CDN URL. It is normally set to a CDN URL.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css", ] = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css",
@@ -89,9 +77,6 @@ def get_swagger_ui_html(
Doc( Doc(
""" """
The OAuth2 redirect URL, it is normally automatically handled by FastAPI. The OAuth2 redirect URL, it is normally automatically handled by FastAPI.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
] = None, ] = None,
@@ -100,9 +85,6 @@ def get_swagger_ui_html(
Doc( Doc(
""" """
A dictionary with Swagger UI OAuth2 initialization configurations. A dictionary with Swagger UI OAuth2 initialization configurations.
Read more about the available configuration options in the
[Swagger UI docs](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/).
""" """
), ),
] = None, ] = None,
@@ -113,9 +95,6 @@ def get_swagger_ui_html(
Configuration parameters for Swagger UI. Configuration parameters for Swagger UI.
It defaults to [swagger_ui_default_parameters][fastapi.openapi.docs.swagger_ui_default_parameters]. It defaults to [swagger_ui_default_parameters][fastapi.openapi.docs.swagger_ui_default_parameters].
Read more about it in the
[FastAPI docs about how to Configure Swagger UI](https://fastapi.tiangolo.com/how-to/configure-swagger-ui/).
""" """
), ),
] = None, ] = None,
@@ -189,9 +168,6 @@ def get_redoc_html(
This is normally done automatically by FastAPI using the default URL This is normally done automatically by FastAPI using the default URL
`/openapi.json`. `/openapi.json`.
Read more about it in the
[FastAPI docs for Conditional OpenAPI](https://fastapi.tiangolo.com/how-to/conditional-openapi/#conditional-openapi-from-settings-and-env-vars)
""" """
), ),
], ],
@@ -200,9 +176,6 @@ def get_redoc_html(
Doc( Doc(
""" """
The HTML `<title>` content, normally shown in the browser tab. The HTML `<title>` content, normally shown in the browser tab.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
], ],
@@ -213,9 +186,6 @@ def get_redoc_html(
The URL to use to load the ReDoc JavaScript. The URL to use to load the ReDoc JavaScript.
It is normally set to a CDN URL. It is normally set to a CDN URL.
Read more about it in the
[FastAPI docs for Custom Docs UI Static Assets](https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/)
""" """
), ),
] = "https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js", ] = "https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js",

View File

@@ -79,9 +79,6 @@ def Path( # noqa: N802
Doc( Doc(
""" """
Human-readable title. Human-readable title.
Read more about it in the
[FastAPI docs for Path Parameters and Numeric Validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#declare-metadata)
""" """
), ),
] = None, ] = None,
@@ -99,9 +96,6 @@ def Path( # noqa: N802
""" """
Greater than. If set, value must be greater than this. Only applicable to Greater than. If set, value must be greater than this. Only applicable to
numbers. numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -111,9 +105,6 @@ def Path( # noqa: N802
""" """
Greater than or equal. If set, value must be greater than or equal to Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers. this. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -122,9 +113,6 @@ def Path( # noqa: N802
Doc( Doc(
""" """
Less than. If set, value must be less than this. Only applicable to numbers. Less than. If set, value must be less than this. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -134,9 +122,6 @@ def Path( # noqa: N802
""" """
Less than or equal. If set, value must be less than or equal to this. Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -228,9 +213,6 @@ def Path( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -361,9 +343,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Default value if the parameter field is not set. Default value if the parameter field is not set.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#alternative-old-query-as-the-default-value)
""" """
), ),
] = Undefined, ] = Undefined,
@@ -388,9 +367,6 @@ def Query( # noqa: N802
This will be used to extract the data and for the generated OpenAPI. This will be used to extract the data and for the generated OpenAPI.
It is particularly useful when you can't use the name you want because it It is particularly useful when you can't use the name you want because it
is a Python reserved keyword or similar. is a Python reserved keyword or similar.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#alias-parameters)
""" """
), ),
] = None, ] = None,
@@ -426,9 +402,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Human-readable title. Human-readable title.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata)
""" """
), ),
] = None, ] = None,
@@ -437,9 +410,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Human-readable description. Human-readable description.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata)
""" """
), ),
] = None, ] = None,
@@ -449,9 +419,6 @@ def Query( # noqa: N802
""" """
Greater than. If set, value must be greater than this. Only applicable to Greater than. If set, value must be greater than this. Only applicable to
numbers. numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -461,9 +428,6 @@ def Query( # noqa: N802
""" """
Greater than or equal. If set, value must be greater than or equal to Greater than or equal. If set, value must be greater than or equal to
this. Only applicable to numbers. this. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -472,9 +436,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Less than. If set, value must be less than this. Only applicable to numbers. Less than. If set, value must be less than this. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -484,9 +445,6 @@ def Query( # noqa: N802
""" """
Less than or equal. If set, value must be less than or equal to this. Less than or equal. If set, value must be less than or equal to this.
Only applicable to numbers. Only applicable to numbers.
Read more about it in the
[FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
""" """
), ),
] = None, ] = None,
@@ -495,9 +453,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Minimum length for strings. Minimum length for strings.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/)
""" """
), ),
] = None, ] = None,
@@ -506,9 +461,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Maximum length for strings. Maximum length for strings.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/)
""" """
), ),
] = None, ] = None,
@@ -517,9 +469,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
RegEx pattern for strings. RegEx pattern for strings.
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#add-regular-expressions
""" """
), ),
] = None, ] = None,
@@ -587,9 +536,6 @@ def Query( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -624,9 +570,6 @@ def Query( # noqa: N802
Mark this parameter field as deprecated. Mark this parameter field as deprecated.
It will affect the generated OpenAPI (e.g. visible at `/docs`). It will affect the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#deprecating-parameters)
""" """
), ),
] = None, ] = None,
@@ -638,9 +581,6 @@ def Query( # noqa: N802
You probably don't need it, but it's available. You probably don't need it, but it's available.
This affects the generated OpenAPI (e.g. visible at `/docs`). This affects the generated OpenAPI (e.g. visible at `/docs`).
Read more about it in the
[FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi
""" """
), ),
] = True, ] = True,
@@ -909,9 +849,6 @@ def Header( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -1215,9 +1152,6 @@ def Cookie( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -1543,9 +1477,6 @@ def Body( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -1859,9 +1790,6 @@ def Form( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -2174,9 +2102,6 @@ def File( # noqa: N802
Doc( Doc(
""" """
Example values for this field. Example values for this field.
Read more about it in the
[FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
""" """
), ),
] = None, ] = None,
@@ -2290,9 +2215,6 @@ def Depends( # noqa: N802
Don't call it directly, FastAPI will call it for you, just pass the object Don't call it directly, FastAPI will call it for you, just pass the object
directly. directly.
Read more about it in the
[FastAPI docs for Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/)
""" """
), ),
] = None, ] = None,
@@ -2308,9 +2230,6 @@ def Depends( # noqa: N802
Set `use_cache` to `False` to disable this behavior and ensure the Set `use_cache` to `False` to disable this behavior and ensure the
dependency is called again (if declared more than once) in the same request. dependency is called again (if declared more than once) in the same request.
Read more about it in the
[FastAPI docs about sub-dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/sub-dependencies/#using-the-same-dependency-multiple-times)
""" """
), ),
] = True, ] = True,
@@ -2331,9 +2250,6 @@ def Depends( # noqa: N802
that handles the request (similar to when using `"function"`), but end that handles the request (similar to when using `"function"`), but end
**after** the response is sent back to the client. So, the dependency **after** the response is sent back to the client. So, the dependency
function will be executed **around** the **request** and response cycle. function will be executed **around** the **request** and response cycle.
Read more about it in the
[FastAPI docs for FastAPI Dependencies with yield](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#early-exit-and-scope)
""" """
), ),
] = None, ] = None,
@@ -2379,9 +2295,6 @@ def Security( # noqa: N802
Don't call it directly, FastAPI will call it for you, just pass the object Don't call it directly, FastAPI will call it for you, just pass the object
directly. directly.
Read more about it in the
[FastAPI docs for Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/)
""" """
), ),
] = None, ] = None,
@@ -2399,9 +2312,7 @@ def Security( # noqa: N802
These scopes are integrated with OpenAPI (and the API docs at `/docs`). These scopes are integrated with OpenAPI (and the API docs at `/docs`).
So they are visible in the OpenAPI specification. So they are visible in the OpenAPI specification.
)
Read more about it in the
[FastAPI docs about OAuth2 scopes](https://fastapi.tiangolo.com/advanced/security/oauth2-scopes/)
""" """
), ),
] = None, ] = None,
@@ -2416,9 +2327,6 @@ def Security( # noqa: N802
Set `use_cache` to `False` to disable this behavior and ensure the Set `use_cache` to `False` to disable this behavior and ensure the
dependency is called again (if declared more than once) in the same request. dependency is called again (if declared more than once) in the same request.
Read more about it in the
[FastAPI docs about sub-dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/sub-dependencies/#using-the-same-dependency-multiple-times)
""" """
), ),
] = True, ] = True,

View File

@@ -68,9 +68,6 @@ class OAuth2PasswordRequestForm:
"password". Nevertheless, this dependency class is permissive and "password". Nevertheless, this dependency class is permissive and
allows not passing it. If you want to enforce it, use instead the allows not passing it. If you want to enforce it, use instead the
`OAuth2PasswordRequestFormStrict` dependency. `OAuth2PasswordRequestFormStrict` dependency.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
] = None, ] = None,
@@ -81,9 +78,6 @@ class OAuth2PasswordRequestForm:
""" """
`username` string. The OAuth2 spec requires the exact field name `username` string. The OAuth2 spec requires the exact field name
`username`. `username`.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -94,9 +88,6 @@ class OAuth2PasswordRequestForm:
""" """
`password` string. The OAuth2 spec requires the exact field name `password` string. The OAuth2 spec requires the exact field name
`password`. `password`.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -121,9 +112,6 @@ class OAuth2PasswordRequestForm:
* `users:read` * `users:read`
* `profile` * `profile`
* `openid` * `openid`
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
] = "", ] = "",
@@ -234,9 +222,6 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
"password". This dependency is strict about it. If you want to be "password". This dependency is strict about it. If you want to be
permissive, use instead the `OAuth2PasswordRequestForm` dependency permissive, use instead the `OAuth2PasswordRequestForm` dependency
class. class.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -247,9 +232,6 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
""" """
`username` string. The OAuth2 spec requires the exact field name `username` string. The OAuth2 spec requires the exact field name
`username`. `username`.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -260,9 +242,6 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
""" """
`password` string. The OAuth2 spec requires the exact field name `password` string. The OAuth2 spec requires the exact field name
`password`. `password`.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -287,9 +266,6 @@ class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):
* `users:read` * `users:read`
* `profile` * `profile`
* `openid` * `openid`
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
] = "", ] = "",
@@ -447,9 +423,6 @@ class OAuth2PasswordBearer(OAuth2):
""" """
The URL to obtain the OAuth2 token. This would be the *path operation* The URL to obtain the OAuth2 token. This would be the *path operation*
that has `OAuth2PasswordRequestForm` as a dependency. that has `OAuth2PasswordRequestForm` as a dependency.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
], ],
@@ -469,9 +442,6 @@ class OAuth2PasswordBearer(OAuth2):
""" """
The OAuth2 scopes that would be required by the *path operations* that The OAuth2 scopes that would be required by the *path operations* that
use this dependency. use this dependency.
Read more about it in the
[FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
""" """
), ),
] = None, ] = None,