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

📝 Update includes in `docs/en/docs/tutorial/dependencies/index.md` (#12615)

This commit is contained in:
Abdul Hadi Bharara 2024-10-28 16:18:17 +05:00 committed by GitHub
parent efb99a2bb4
commit cb2c56008d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

180
docs/en/docs/tutorial/dependencies/index.md
View File

@ -31,57 +31,7 @@ Let's first focus on the dependency.
It is just a function that can take all the same parameters that a *path operation function* can take: It is just a function that can take all the same parameters that a *path operation function* can take:
//// tab | Python 3.10+ {* ../../docs_src/dependencies/tutorial001_an_py310.py hl[8:9] *}
```Python hl_lines="8-9"
{!> ../../docs_src/dependencies/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="8-11"
{!> ../../docs_src/dependencies/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="9-12"
{!> ../../docs_src/dependencies/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="6-7"
{!> ../../docs_src/dependencies/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="8-11"
{!> ../../docs_src/dependencies/tutorial001.py!}
```
////
That's it. That's it.
@ -113,113 +63,13 @@ Make sure you [Upgrade the FastAPI version](../../deployment/versions.md#upgradi
### Import `Depends` ### Import `Depends`
//// tab | Python 3.10+ {* ../../docs_src/dependencies/tutorial001_an_py310.py hl[3] *}
```Python hl_lines="3"
{!> ../../docs_src/dependencies/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="3"
{!> ../../docs_src/dependencies/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="3"
{!> ../../docs_src/dependencies/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="1"
{!> ../../docs_src/dependencies/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="3"
{!> ../../docs_src/dependencies/tutorial001.py!}
```
////
### Declare the dependency, in the "dependant" ### Declare the dependency, in the "dependant"
The same way you use `Body`, `Query`, etc. with your *path operation function* parameters, use `Depends` with a new parameter: The same way you use `Body`, `Query`, etc. with your *path operation function* parameters, use `Depends` with a new parameter:
//// tab | Python 3.10+ {* ../../docs_src/dependencies/tutorial001_an_py310.py hl[13,18] *}
```Python hl_lines="13 18"
{!> ../../docs_src/dependencies/tutorial001_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="15 20"
{!> ../../docs_src/dependencies/tutorial001_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="16 21"
{!> ../../docs_src/dependencies/tutorial001_an.py!}
```
////
//// tab | Python 3.10+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="11 16"
{!> ../../docs_src/dependencies/tutorial001_py310.py!}
```
////
//// tab | Python 3.8+ non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="15 20"
{!> ../../docs_src/dependencies/tutorial001.py!}
```
////
Although you use `Depends` in the parameters of your function the same way you use `Body`, `Query`, etc, `Depends` works a bit differently. Although you use `Depends` in the parameters of your function the same way you use `Body`, `Query`, etc, `Depends` works a bit differently.
@ -276,29 +126,7 @@ commons: Annotated[dict, Depends(common_parameters)]
But because we are using `Annotated`, we can store that `Annotated` value in a variable and use it in multiple places: But because we are using `Annotated`, we can store that `Annotated` value in a variable and use it in multiple places:
//// tab | Python 3.10+ {* ../../docs_src/dependencies/tutorial001_02_an_py310.py hl[12,16,21] *}
```Python hl_lines="12 16 21"
{!> ../../docs_src/dependencies/tutorial001_02_an_py310.py!}
```
////
//// tab | Python 3.9+
```Python hl_lines="14 18 23"
{!> ../../docs_src/dependencies/tutorial001_02_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="15 19 24"
{!> ../../docs_src/dependencies/tutorial001_02_an.py!}
```
////
/// tip /// tip