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

📝 Update includes for `docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md` (#12815) 

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Baldeep Singh Handa 2024-11-10 16:45:28 +00:00 committed by GitHub
parent 370f4f9980
commit b2236d080a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md
View File

@ -14,35 +14,7 @@ The *path operation decorator* receives an optional argument `dependencies`.
It should be a `list` of `Depends()`:
//// tab | Python 3.9+
```Python hl_lines="19"
{!> ../../docs_src/dependencies/tutorial006_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="18"
{!> ../../docs_src/dependencies/tutorial006_an.py!}
```
////
//// tab | Python 3.8 non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="17"
{!> ../../docs_src/dependencies/tutorial006.py!}
```
////
{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[19] *}
These dependencies will be executed/solved the same way as normal dependencies. But their value (if they return any) won't be passed to your *path operation function*.
@ -72,69 +44,13 @@ You can use the same dependency *functions* you use normally.
They can declare request requirements (like headers) or other sub-dependencies:
//// tab | Python 3.9+
```Python hl_lines="8 13"
{!> ../../docs_src/dependencies/tutorial006_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="7 12"
{!> ../../docs_src/dependencies/tutorial006_an.py!}
```
////
//// tab | Python 3.8 non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="6 11"
{!> ../../docs_src/dependencies/tutorial006.py!}
```
////
{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[8,13] *}
### Raise exceptions
These dependencies can `raise` exceptions, the same as normal dependencies:
//// tab | Python 3.9+
```Python hl_lines="10 15"
{!> ../../docs_src/dependencies/tutorial006_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="9 14"
{!> ../../docs_src/dependencies/tutorial006_an.py!}
```
////
//// tab | Python 3.8 non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="8 13"
{!> ../../docs_src/dependencies/tutorial006.py!}
```
////
{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[10,15] *}
### Return values
@ -142,35 +58,7 @@ And they can return values or not, the values won't be used.
So, you can reuse a normal dependency (that returns a value) you already use somewhere else, and even though the value won't be used, the dependency will be executed:
//// tab | Python 3.9+
```Python hl_lines="11 16"
{!> ../../docs_src/dependencies/tutorial006_an_py39.py!}
```
////
//// tab | Python 3.8+
```Python hl_lines="10 15"
{!> ../../docs_src/dependencies/tutorial006_an.py!}
```
////
//// tab | Python 3.8 non-Annotated
/// tip
Prefer to use the `Annotated` version if possible.
///
```Python hl_lines="9 14"
{!> ../../docs_src/dependencies/tutorial006.py!}
```
////
{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[11,16] *}
## Dependencies for a group of *path operations*