diff --git a/docs/es/docs/features.md b/docs/es/docs/features.md
index 3c59eb88c..5d6b6509a 100644
--- a/docs/es/docs/features.md
+++ b/docs/es/docs/features.md
@@ -167,7 +167,7 @@ Con **FastAPI** obtienes todas las características de **Starlette** (porque Fas
* Soporte para **GraphQL**.
* Tareas en background.
* Eventos de startup y shutdown.
-* Cliente de pruebas construido con `requests`.
+* Cliente de pruebas construido con HTTPX.
* **CORS**, GZip, Static Files, Streaming responses.
* Soporte para **Session and Cookie**.
* Cobertura de pruebas al 100%.
diff --git a/docs/es/docs/index.md b/docs/es/docs/index.md
index aa3fa2228..727a6617b 100644
--- a/docs/es/docs/index.md
+++ b/docs/es/docs/index.md
@@ -418,7 +418,7 @@ Para un ejemplo más completo que incluye más características ve el requests - Requerido si quieres usar el `TestClient`.
+*
httpx - Requerido si quieres usar el `TestClient`.
*
jinja2 - Requerido si quieres usar la configuración por defecto de templates.
*
python-multipart - Requerido si quieres dar soporte a
"parsing" de formularios, con `request.form()`.
*
itsdangerous - Requerido para dar soporte a `SessionMiddleware`.
diff --git a/docs/fa/docs/index.md b/docs/fa/docs/index.md
index 0f7cd569a..dfc4d24e3 100644
--- a/docs/fa/docs/index.md
+++ b/docs/fa/docs/index.md
@@ -421,7 +421,7 @@ item: Item
* قابلیتهای اضافی دیگر (بر اساس Starlette) شامل:
* **
وبسوکت**
* **GraphQL**
- * تستهای خودکار آسان مبتنی بر `requests` و `pytest`
+ * تستهای خودکار آسان مبتنی بر HTTPX و `pytest`
* **CORS**
* **Cookie Sessions**
* و موارد بیشمار دیگر.
@@ -441,7 +441,7 @@ item: Item
استفاده شده توسط Starlette:
-*
requests - در صورتی که میخواهید از `TestClient` استفاده کنید.
+*
HTTPX - در صورتی که میخواهید از `TestClient` استفاده کنید.
*
aiofiles - در صورتی که میخواهید از `FileResponse` و `StaticFiles` استفاده کنید.
*
jinja2 - در صورتی که بخواهید از پیکربندی پیشفرض برای قالبها استفاده کنید.
*
python-multipart - در صورتی که بخواهید با استفاده از `request.form()` از قابلیت
"تجزیه (parse)" فرم استفاده کنید.
diff --git a/docs/fr/docs/advanced/additional-responses.md b/docs/fr/docs/advanced/additional-responses.md
new file mode 100644
index 000000000..35b57594d
--- /dev/null
+++ b/docs/fr/docs/advanced/additional-responses.md
@@ -0,0 +1,240 @@
+# Réponses supplémentaires dans OpenAPI
+
+!!! Attention
+ Ceci concerne un sujet plutôt avancé.
+
+ Si vous débutez avec **FastAPI**, vous n'en aurez peut-être pas besoin.
+
+Vous pouvez déclarer des réponses supplémentaires, avec des codes HTTP, des types de médias, des descriptions, etc.
+
+Ces réponses supplémentaires seront incluses dans le schéma OpenAPI, elles apparaîtront donc également dans la documentation de l'API.
+
+Mais pour ces réponses supplémentaires, vous devez vous assurer de renvoyer directement une `Response` comme `JSONResponse`, avec votre code HTTP et votre contenu.
+
+## Réponse supplémentaire avec `model`
+
+Vous pouvez ajouter à votre décorateur de *paramètre de chemin* un paramètre `responses`.
+
+Il prend comme valeur un `dict` dont les clés sont des codes HTTP pour chaque réponse, comme `200`, et la valeur de ces clés sont d'autres `dict` avec des informations pour chacun d'eux.
+
+Chacun de ces `dict` de réponse peut avoir une clé `model`, contenant un modèle Pydantic, tout comme `response_model`.
+
+**FastAPI** prendra ce modèle, générera son schéma JSON et l'inclura au bon endroit dans OpenAPI.
+
+Par exemple, pour déclarer une autre réponse avec un code HTTP `404` et un modèle Pydantic `Message`, vous pouvez écrire :
+
+```Python hl_lines="18 22"
+{!../../../docs_src/additional_responses/tutorial001.py!}
+```
+
+!!! Remarque
+ Gardez à l'esprit que vous devez renvoyer directement `JSONResponse`.
+
+!!! Info
+ La clé `model` ne fait pas partie d'OpenAPI.
+
+ **FastAPI** prendra le modèle Pydantic à partir de là, générera le `JSON Schema` et le placera au bon endroit.
+
+ Le bon endroit est :
+
+ * Dans la clé `content`, qui a pour valeur un autre objet JSON (`dict`) qui contient :
+ * Une clé avec le type de support, par ex. `application/json`, qui contient comme valeur un autre objet JSON, qui contient :
+ * Une clé `schema`, qui a pour valeur le schéma JSON du modèle, voici le bon endroit.
+ * **FastAPI** ajoute ici une référence aux schémas JSON globaux à un autre endroit de votre OpenAPI au lieu de l'inclure directement. De cette façon, d'autres applications et clients peuvent utiliser ces schémas JSON directement, fournir de meilleurs outils de génération de code, etc.
+
+Les réponses générées au format OpenAPI pour cette *opération de chemin* seront :
+
+```JSON hl_lines="3-12"
+{
+ "responses": {
+ "404": {
+ "description": "Additional Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Item"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+}
+```
+
+Les schémas sont référencés à un autre endroit du modèle OpenAPI :
+
+```JSON hl_lines="4-16"
+{
+ "components": {
+ "schemas": {
+ "Message": {
+ "title": "Message",
+ "required": [
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "title": "Message",
+ "type": "string"
+ }
+ }
+ },
+ "Item": {
+ "title": "Item",
+ "required": [
+ "id",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "title": "Id",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value",
+ "type": "string"
+ }
+ }
+ },
+ "ValidationError": {
+ "title": "ValidationError",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "loc": {
+ "title": "Location",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "msg": {
+ "title": "Message",
+ "type": "string"
+ },
+ "type": {
+ "title": "Error Type",
+ "type": "string"
+ }
+ }
+ },
+ "HTTPValidationError": {
+ "title": "HTTPValidationError",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "title": "Detail",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+}
+```
+
+## Types de médias supplémentaires pour la réponse principale
+
+Vous pouvez utiliser ce même paramètre `responses` pour ajouter différents types de médias pour la même réponse principale.
+
+Par exemple, vous pouvez ajouter un type de média supplémentaire `image/png`, en déclarant que votre *opération de chemin* peut renvoyer un objet JSON (avec le type de média `application/json`) ou une image PNG :
+
+```Python hl_lines="19-24 28"
+{!../../../docs_src/additional_responses/tutorial002.py!}
+```
+
+!!! Remarque
+ Notez que vous devez retourner l'image en utilisant directement un `FileResponse`.
+
+!!! Info
+ À moins que vous ne spécifiiez explicitement un type de média différent dans votre paramètre `responses`, FastAPI supposera que la réponse a le même type de média que la classe de réponse principale (par défaut `application/json`).
+
+ Mais si vous avez spécifié une classe de réponse personnalisée avec `None` comme type de média, FastAPI utilisera `application/json` pour toute réponse supplémentaire associée à un modèle.
+
+## Combinaison d'informations
+
+Vous pouvez également combiner des informations de réponse provenant de plusieurs endroits, y compris les paramètres `response_model`, `status_code` et `responses`.
+
+Vous pouvez déclarer un `response_model`, en utilisant le code HTTP par défaut `200` (ou un code personnalisé si vous en avez besoin), puis déclarer des informations supplémentaires pour cette même réponse dans `responses`, directement dans le schéma OpenAPI.
+
+**FastAPI** conservera les informations supplémentaires des `responses` et les combinera avec le schéma JSON de votre modèle.
+
+Par exemple, vous pouvez déclarer une réponse avec un code HTTP `404` qui utilise un modèle Pydantic et a une `description` personnalisée.
+
+Et une réponse avec un code HTTP `200` qui utilise votre `response_model`, mais inclut un `example` personnalisé :
+
+```Python hl_lines="20-31"
+{!../../../docs_src/additional_responses/tutorial003.py!}
+```
+
+Tout sera combiné et inclus dans votre OpenAPI, et affiché dans la documentation de l'API :
+
+
+
+## Combinez les réponses prédéfinies et les réponses personnalisées
+
+Vous voulez peut-être avoir des réponses prédéfinies qui s'appliquent à de nombreux *paramètre de chemin*, mais vous souhaitez les combiner avec des réponses personnalisées nécessaires à chaque *opération de chemin*.
+
+Dans ces cas, vous pouvez utiliser la technique Python "d'affection par décomposition" (appelé _unpacking_ en anglais) d'un `dict` avec `**dict_to_unpack` :
+
+``` Python
+old_dict = {
+ "old key": "old value",
+ "second old key": "second old value",
+}
+new_dict = {**old_dict, "new key": "new value"}
+```
+
+Ici, `new_dict` contiendra toutes les paires clé-valeur de `old_dict` plus la nouvelle paire clé-valeur :
+
+``` Python
+{
+ "old key": "old value",
+ "second old key": "second old value",
+ "new key": "new value",
+}
+```
+
+Vous pouvez utiliser cette technique pour réutiliser certaines réponses prédéfinies dans vos *paramètres de chemin* et les combiner avec des réponses personnalisées supplémentaires.
+
+Par exemple:
+
+```Python hl_lines="13-17 26"
+{!../../../docs_src/additional_responses/tutorial004.py!}
+```
+
+## Plus d'informations sur les réponses OpenAPI
+
+Pour voir exactement ce que vous pouvez inclure dans les réponses, vous pouvez consulter ces sections dans la spécification OpenAPI :
+
+*
Objet Responses de OpenAPI , il inclut le `Response Object`.
+*
Objet Response de OpenAPI , vous pouvez inclure n'importe quoi directement dans chaque réponse à l'intérieur de votre paramètre `responses`. Y compris `description`, `headers`, `content` (à l'intérieur de cela, vous déclarez différents types de médias et schémas JSON) et `links`.
diff --git a/docs/fr/docs/advanced/additional-status-codes.md b/docs/fr/docs/advanced/additional-status-codes.md
new file mode 100644
index 000000000..e7b003707
--- /dev/null
+++ b/docs/fr/docs/advanced/additional-status-codes.md
@@ -0,0 +1,37 @@
+# Codes HTTP supplémentaires
+
+Par défaut, **FastAPI** renverra les réponses à l'aide d'une structure de données `JSONResponse`, en plaçant la réponse de votre *chemin d'accès* à l'intérieur de cette `JSONResponse`.
+
+Il utilisera le code HTTP par défaut ou celui que vous avez défini dans votre *chemin d'accès*.
+
+## Codes HTTP supplémentaires
+
+Si vous souhaitez renvoyer des codes HTTP supplémentaires en plus du code principal, vous pouvez le faire en renvoyant directement une `Response`, comme une `JSONResponse`, et en définissant directement le code HTTP supplémentaire.
+
+Par exemple, disons que vous voulez avoir un *chemin d'accès* qui permet de mettre à jour les éléments et renvoie les codes HTTP 200 "OK" en cas de succès.
+
+Mais vous voulez aussi qu'il accepte de nouveaux éléments. Et lorsque les éléments n'existaient pas auparavant, il les crée et renvoie un code HTTP de 201 "Créé".
+
+Pour y parvenir, importez `JSONResponse` et renvoyez-y directement votre contenu, en définissant le `status_code` que vous souhaitez :
+
+```Python hl_lines="4 25"
+{!../../../docs_src/additional_status_codes/tutorial001.py!}
+```
+
+!!! Attention
+ Lorsque vous renvoyez une `Response` directement, comme dans l'exemple ci-dessus, elle sera renvoyée directement.
+
+ Elle ne sera pas sérialisée avec un modèle.
+
+ Assurez-vous qu'il contient les données souhaitées et que les valeurs soient dans un format JSON valides (si vous utilisez une `JSONResponse`).
+
+!!! note "Détails techniques"
+ Vous pouvez également utiliser `from starlette.responses import JSONResponse`.
+
+ Pour plus de commodités, **FastAPI** fournit les objets `starlette.responses` sous forme d'un alias accessible par `fastapi.responses`. Mais la plupart des réponses disponibles proviennent directement de Starlette. Il en est de même avec l'objet `statut`.
+
+## Documents OpenAPI et API
+
+Si vous renvoyez directement des codes HTTP et des réponses supplémentaires, ils ne seront pas inclus dans le schéma OpenAPI (la documentation de l'API), car FastAPI n'a aucun moyen de savoir à l'avance ce que vous allez renvoyer.
+
+Mais vous pouvez documenter cela dans votre code, en utilisant : [Réponses supplémentaires dans OpenAPI](additional-responses.md){.internal-link target=_blank}.
diff --git a/docs/fr/docs/deployment/deta.md b/docs/fr/docs/deployment/deta.md
new file mode 100644
index 000000000..cceb7b058
--- /dev/null
+++ b/docs/fr/docs/deployment/deta.md
@@ -0,0 +1,245 @@
+# Déployer FastAPI sur Deta
+
+Dans cette section, vous apprendrez à déployer facilement une application **FastAPI** sur
Deta en utilisant le plan tarifaire gratuit. 🎁
+
+Cela vous prendra environ **10 minutes**.
+
+!!! info
+
Deta sponsorise **FastAPI**. 🎉
+
+## Une application **FastAPI** de base
+
+* Créez un répertoire pour votre application, par exemple `./fastapideta/` et déplacez-vous dedans.
+
+### Le code FastAPI
+
+* Créer un fichier `main.py` avec :
+
+```Python
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+ return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int):
+ return {"item_id": item_id}
+```
+
+### Dépendances
+
+Maintenant, dans le même répertoire, créez un fichier `requirements.txt` avec :
+
+```text
+fastapi
+```
+
+!!! tip "Astuce"
+ Il n'est pas nécessaire d'installer Uvicorn pour déployer sur Deta, bien qu'il soit probablement souhaitable de l'installer localement pour tester votre application.
+
+### Structure du répertoire
+
+Vous aurez maintenant un répertoire `./fastapideta/` avec deux fichiers :
+
+```
+.
+└── main.py
+└── requirements.txt
+```
+
+## Créer un compte gratuit sur Deta
+
+Créez maintenant un
compte gratuit
+sur Deta, vous avez juste besoin d'une adresse email et d'un mot de passe.
+
+Vous n'avez même pas besoin d'une carte de crédit.
+
+## Installer le CLI (Interface en Ligne de Commande)
+
+Une fois que vous avez votre compte, installez le
CLI de Deta :
+
+=== "Linux, macOS"
+
+
+
+ ```console
+ $ curl -fsSL https://get.deta.dev/cli.sh | sh
+ ```
+
+
+
+=== "Windows PowerShell"
+
+
+
+ ```console
+ $ iwr https://get.deta.dev/cli.ps1 -useb | iex
+ ```
+
+
+
+Après l'avoir installé, ouvrez un nouveau terminal afin que la nouvelle installation soit détectée.
+
+Dans un nouveau terminal, confirmez qu'il a été correctement installé avec :
+
+
+
+```console
+$ deta --help
+
+Deta command line interface for managing deta micros.
+Complete documentation available at https://docs.deta.sh
+
+Usage:
+ deta [flags]
+ deta [command]
+
+Available Commands:
+ auth Change auth settings for a deta micro
+
+...
+```
+
+
+
+!!! tip "Astuce"
+ Si vous rencontrez des problèmes pour installer le CLI, consultez la
documentation officielle de Deta (en anglais).
+
+## Connexion avec le CLI
+
+Maintenant, connectez-vous à Deta depuis le CLI avec :
+
+
+
+```console
+$ deta login
+
+Please, log in from the web page. Waiting..
+Logged in successfully.
+```
+
+
+
+Cela ouvrira un navigateur web et permettra une authentification automatique.
+
+## Déployer avec Deta
+
+Ensuite, déployez votre application avec le CLI de Deta :
+
+
+
+```console
+$ deta new
+
+Successfully created a new micro
+
+// Notice the "endpoint" 🔍
+
+{
+ "name": "fastapideta",
+ "runtime": "python3.7",
+ "endpoint": "https://qltnci.deta.dev",
+ "visor": "enabled",
+ "http_auth": "enabled"
+}
+
+Adding dependencies...
+
+
+---> 100%
+
+
+Successfully installed fastapi-0.61.1 pydantic-1.7.2 starlette-0.13.6
+```
+
+
+
+Vous verrez un message JSON similaire à :
+
+```JSON hl_lines="4"
+{
+ "name": "fastapideta",
+ "runtime": "python3.7",
+ "endpoint": "https://qltnci.deta.dev",
+ "visor": "enabled",
+ "http_auth": "enabled"
+}
+```
+
+!!! tip "Astuce"
+ Votre déploiement aura une URL `"endpoint"` différente.
+
+## Vérifiez
+
+Maintenant, dans votre navigateur ouvrez votre URL `endpoint`. Dans l'exemple ci-dessus, c'était
+`https://qltnci.deta.dev`, mais la vôtre sera différente.
+
+Vous verrez la réponse JSON de votre application FastAPI :
+
+```JSON
+{
+ "Hello": "World"
+}
+```
+
+Et maintenant naviguez vers `/docs` dans votre API, dans l'exemple ci-dessus ce serait `https://qltnci.deta.dev/docs`.
+
+Vous verrez votre documentation comme suit :
+
+
+
+## Activer l'accès public
+
+Par défaut, Deta va gérer l'authentification en utilisant des cookies pour votre compte.
+
+Mais une fois que vous êtes prêt, vous pouvez le rendre public avec :
+
+
+
+```console
+$ deta auth disable
+
+Successfully disabled http auth
+```
+
+
+
+Maintenant, vous pouvez partager cette URL avec n'importe qui et ils seront en mesure d'accéder à votre API. 🚀
+
+## HTTPS
+
+Félicitations ! Vous avez déployé votre application FastAPI sur Deta ! 🎉 🍰
+
+Remarquez également que Deta gère correctement HTTPS pour vous, vous n'avez donc pas à vous en occuper et pouvez être sûr que vos clients auront une connexion cryptée sécurisée. ✅ 🔒
+
+## Vérifiez le Visor
+
+À partir de l'interface graphique de votre documentation (dans une URL telle que `https://qltnci.deta.dev/docs`)
+envoyez une requête à votre *opération de chemin* `/items/{item_id}`.
+
+Par exemple avec l'ID `5`.
+
+Allez maintenant sur
https://web.deta.sh.
+
+Vous verrez qu'il y a une section à gauche appelée
"Micros" avec chacune de vos applications.
+
+Vous verrez un onglet avec "Details", et aussi un onglet "Visor", allez à l'onglet "Visor".
+
+Vous pouvez y consulter les requêtes récentes envoyées à votre application.
+
+Vous pouvez également les modifier et les relancer.
+
+
+
+## En savoir plus
+
+À un moment donné, vous voudrez probablement stocker certaines données pour votre application d'une manière qui
+persiste dans le temps. Pour cela, vous pouvez utiliser
Deta Base, il dispose également d'un généreux **plan gratuit**.
+
+Vous pouvez également en lire plus dans la
documentation Deta.
diff --git a/docs/fr/docs/deployment/https.md b/docs/fr/docs/deployment/https.md
new file mode 100644
index 000000000..ccf1f847a
--- /dev/null
+++ b/docs/fr/docs/deployment/https.md
@@ -0,0 +1,53 @@
+# À propos de HTTPS
+
+Il est facile de penser que HTTPS peut simplement être "activé" ou non.
+
+Mais c'est beaucoup plus complexe que cela.
+
+!!! tip
+ Si vous êtes pressé ou si cela ne vous intéresse pas, passez aux sections suivantes pour obtenir des instructions étape par étape afin de tout configurer avec différentes techniques.
+
+Pour apprendre les bases du HTTPS, du point de vue d'un utilisateur, consultez
https://howhttps.works/.
+
+Maintenant, du point de vue d'un développeur, voici plusieurs choses à avoir en tête en pensant au HTTPS :
+
+* Pour le HTTPS, le serveur a besoin de "certificats" générés par une tierce partie.
+ * Ces certificats sont en fait acquis auprès de la tierce partie, et non "générés".
+* Les certificats ont une durée de vie.
+ * Ils expirent.
+ * Puis ils doivent être renouvelés et acquis à nouveau auprès de la tierce partie.
+* Le cryptage de la connexion se fait au niveau du protocole TCP.
+ * C'est une couche en dessous de HTTP.
+ * Donc, le certificat et le traitement du cryptage sont faits avant HTTP.
+* TCP ne connaît pas les "domaines", seulement les adresses IP.
+ * L'information sur le domaine spécifique demandé se trouve dans les données HTTP.
+* Les certificats HTTPS "certifient" un certain domaine, mais le protocole et le cryptage se font au niveau TCP, avant de savoir quel domaine est traité.
+* Par défaut, cela signifie que vous ne pouvez avoir qu'un seul certificat HTTPS par adresse IP.
+ * Quelle que soit la taille de votre serveur ou la taille de chacune des applications qu'il contient.
+ * Il existe cependant une solution à ce problème.
+* Il existe une extension du protocole TLS (celui qui gère le cryptage au niveau TCP, avant HTTP) appelée
SNI (indication du nom du serveur).
+ * Cette extension SNI permet à un seul serveur (avec une seule adresse IP) d'avoir plusieurs certificats HTTPS et de servir plusieurs domaines/applications HTTPS.
+ * Pour que cela fonctionne, un seul composant (programme) fonctionnant sur le serveur, écoutant sur l'adresse IP publique, doit avoir tous les certificats HTTPS du serveur.
+* Après avoir obtenu une connexion sécurisée, le protocole de communication est toujours HTTP.
+ * Le contenu est crypté, même s'il est envoyé avec le protocole HTTP.
+
+Il est courant d'avoir un seul programme/serveur HTTP fonctionnant sur le serveur (la machine, l'hôte, etc.) et
+gérant toutes les parties HTTPS : envoyer les requêtes HTTP décryptées à l'application HTTP réelle fonctionnant sur
+le même serveur (dans ce cas, l'application **FastAPI**), prendre la réponse HTTP de l'application, la crypter en utilisant le certificat approprié et la renvoyer au client en utilisant HTTPS. Ce serveur est souvent appelé un
Proxy de terminaison TLS.
+
+## Let's Encrypt
+
+Avant Let's Encrypt, ces certificats HTTPS étaient vendus par des tiers de confiance.
+
+Le processus d'acquisition d'un de ces certificats était auparavant lourd, nécessitait pas mal de paperasses et les certificats étaient assez chers.
+
+Mais ensuite,
Let's Encrypt a été créé.
+
+Il s'agit d'un projet de la Fondation Linux. Il fournit des certificats HTTPS gratuitement. De manière automatisée. Ces certificats utilisent toutes les sécurités cryptographiques standard et ont une durée de vie courte (environ 3 mois), de sorte que la sécurité est en fait meilleure en raison de leur durée de vie réduite.
+
+Les domaines sont vérifiés de manière sécurisée et les certificats sont générés automatiquement. Cela permet également d'automatiser le renouvellement de ces certificats.
+
+L'idée est d'automatiser l'acquisition et le renouvellement de ces certificats, afin que vous puissiez disposer d'un HTTPS sécurisé, gratuitement et pour toujours.
diff --git a/docs/fr/docs/deployment/versions.md b/docs/fr/docs/deployment/versions.md
new file mode 100644
index 000000000..136165e9d
--- /dev/null
+++ b/docs/fr/docs/deployment/versions.md
@@ -0,0 +1,95 @@
+# À propos des versions de FastAPI
+
+**FastAPI** est déjà utilisé en production dans de nombreuses applications et systèmes. Et la couverture de test est maintenue à 100 %. Mais son développement est toujours aussi rapide.
+
+De nouvelles fonctionnalités sont ajoutées fréquemment, des bogues sont corrigés régulièrement et le code est
+amélioré continuellement.
+
+C'est pourquoi les versions actuelles sont toujours `0.x.x`, cela reflète que chaque version peut potentiellement
+recevoir des changements non rétrocompatibles. Cela suit les conventions de
versionnage sémantique.
+
+Vous pouvez créer des applications de production avec **FastAPI** dès maintenant (et vous le faites probablement depuis un certain temps), vous devez juste vous assurer que vous utilisez une version qui fonctionne correctement avec le reste de votre code.
+
+## Épinglez votre version de `fastapi`
+
+Tout d'abord il faut "épingler" la version de **FastAPI** que vous utilisez à la dernière version dont vous savez
+qu'elle fonctionne correctement pour votre application.
+
+Par exemple, disons que vous utilisez la version `0.45.0` dans votre application.
+
+Si vous utilisez un fichier `requirements.txt`, vous pouvez spécifier la version avec :
+
+```txt
+fastapi==0.45.0
+```
+
+ce qui signifierait que vous utiliseriez exactement la version `0.45.0`.
+
+Ou vous pourriez aussi l'épingler avec :
+
+```txt
+fastapi>=0.45.0,<0.46.0
+```
+
+cela signifierait que vous utiliseriez les versions `0.45.0` ou supérieures, mais inférieures à `0.46.0`, par exemple, une version `0.45.2` serait toujours acceptée.
+
+Si vous utilisez un autre outil pour gérer vos installations, comme Poetry, Pipenv, ou autres, ils ont tous un moyen que vous pouvez utiliser pour définir des versions spécifiques pour vos paquets.
+
+## Versions disponibles
+
+Vous pouvez consulter les versions disponibles (par exemple, pour vérifier quelle est la dernière version en date) dans les [Notes de version](../release-notes.md){.internal-link target=_blank}.
+
+## À propos des versions
+
+Suivant les conventions de versionnage sémantique, toute version inférieure à `1.0.0` peut potentiellement ajouter
+des changements non rétrocompatibles.
+
+FastAPI suit également la convention que tout changement de version "PATCH" est pour des corrections de bogues et
+des changements rétrocompatibles.
+
+!!! tip "Astuce"
+ Le "PATCH" est le dernier chiffre, par exemple, dans `0.2.3`, la version PATCH est `3`.
+
+Donc, vous devriez être capable d'épingler une version comme suit :
+
+```txt
+fastapi>=0.45.0,<0.46.0
+```
+
+Les changements non rétrocompatibles et les nouvelles fonctionnalités sont ajoutés dans les versions "MINOR".
+
+!!! tip "Astuce"
+ Le "MINOR" est le numéro au milieu, par exemple, dans `0.2.3`, la version MINOR est `2`.
+
+## Mise à jour des versions FastAPI
+
+Vous devriez tester votre application.
+
+Avec **FastAPI** c'est très facile (merci à Starlette), consultez la documentation : [Testing](../tutorial/testing.md){.internal-link target=_blank}
+
+Après avoir effectué des tests, vous pouvez mettre à jour la version **FastAPI** vers une version plus récente, et vous assurer que tout votre code fonctionne correctement en exécutant vos tests.
+
+Si tout fonctionne, ou après avoir fait les changements nécessaires, et que tous vos tests passent, vous pouvez
+épingler votre version de `fastapi` à cette nouvelle version récente.
+
+## À propos de Starlette
+
+Vous ne devriez pas épingler la version de `starlette`.
+
+Différentes versions de **FastAPI** utiliseront une version spécifique plus récente de Starlette.
+
+Ainsi, vous pouvez simplement laisser **FastAPI** utiliser la bonne version de Starlette.
+
+## À propos de Pydantic
+
+Pydantic inclut des tests pour **FastAPI** avec ses propres tests, ainsi les nouvelles versions de Pydantic (au-dessus
+de `1.0.0`) sont toujours compatibles avec **FastAPI**.
+
+Vous pouvez épingler Pydantic à toute version supérieure à `1.0.0` qui fonctionne pour vous et inférieure à `2.0.0`.
+
+Par exemple :
+
+```txt
+pydantic>=1.2.0,<2.0.0
+```
diff --git a/docs/fr/docs/help-fastapi.md b/docs/fr/docs/help-fastapi.md
new file mode 100644
index 000000000..0995721e1
--- /dev/null
+++ b/docs/fr/docs/help-fastapi.md
@@ -0,0 +1,122 @@
+# Help FastAPI - Obtenir de l'aide
+
+Aimez-vous **FastAPI** ?
+
+Vous souhaitez aider FastAPI, les autres utilisateurs et l'auteur ?
+
+Ou souhaitez-vous obtenir de l'aide avec le **FastAPI** ?
+
+Il existe des moyens très simples d'aider (plusieurs ne nécessitent qu'un ou deux clics).
+
+Il existe également plusieurs façons d'obtenir de l'aide.
+
+## Star **FastAPI** sur GitHub
+
+Vous pouvez "star" FastAPI dans GitHub (en cliquant sur le bouton étoile en haut à droite) :
https://github.com/tiangolo/fastapi. ⭐️
+
+En ajoutant une étoile, les autres utilisateurs pourront la trouver plus facilement et constater qu'elle a déjà été utile à d'autres.
+
+## Watch le dépôt GitHub pour les releases
+
+Vous pouvez "watch" FastAPI dans GitHub (en cliquant sur le bouton "watch" en haut à droite) :
https://github.com/tiangolo/fastapi. 👀
+
+Vous pouvez y sélectionner "Releases only".
+
+Ainsi, vous recevrez des notifications (dans votre courrier électronique) chaque fois qu'il y aura une nouvelle version de **FastAPI** avec des corrections de bugs et de nouvelles fonctionnalités.
+
+## Se rapprocher de l'auteur
+
+Vous pouvez vous rapprocher de
moi (Sebastián Ramírez / `tiangolo`), l'auteur.
+
+Vous pouvez :
+
+*
Me suivre sur **GitHub**.
+ * Voir d'autres projets Open Source que j'ai créés et qui pourraient vous aider.
+ * Suivez-moi pour voir quand je crée un nouveau projet Open Source.
+*
Me suivre sur **Twitter**.
+ * Dites-moi comment vous utilisez FastAPI (j'adore entendre ça).
+ * Entendre quand je fais des annonces ou que je lance de nouveaux outils.
+*
Vous connectez à moi sur **Linkedin**.
+ * Etre notifié quand je fais des annonces ou que je lance de nouveaux outils (bien que j'utilise plus souvent Twitte 🤷♂).
+* Lire ce que j’écris (ou me suivre) sur
**Dev.to** ou
**Medium**.
+ * Lire d'autres idées, articles, et sur les outils que j'ai créés.
+ * Suivez-moi pour lire quand je publie quelque chose de nouveau.
+
+## Tweeter sur **FastAPI**
+
+
Tweetez à propos de **FastAPI** et faites-moi savoir, ainsi qu'aux autres, pourquoi vous aimez ça. 🎉
+
+J'aime entendre parler de l'utilisation du **FastAPI**, de ce que vous avez aimé dedans, dans quel projet/entreprise l'utilisez-vous, etc.
+
+## Voter pour FastAPI
+
+*
Votez pour **FastAPI** sur Slant.
+*
Votez pour **FastAPI** sur AlternativeTo.
+*
Votez pour **FastAPI** sur awesome-rest.
+
+## Aider les autres à résoudre les problèmes dans GitHub
+
+Vous pouvez voir
les problèmes existants et essayer d'aider les autres, la plupart du temps il s'agit de questions dont vous connaissez peut-être déjà la réponse. 🤓
+
+## Watch le dépôt GitHub
+
+Vous pouvez "watch" FastAPI dans GitHub (en cliquant sur le bouton "watch" en haut à droite) :
https://github.com/tiangolo/fastapi. 👀
+
+Si vous sélectionnez "Watching" au lieu de "Releases only", vous recevrez des notifications lorsque quelqu'un crée une nouvelle Issue.
+
+Vous pouvez alors essayer de les aider à résoudre ces problèmes.
+
+## Créer une Issue
+
+Vous pouvez
créer une Issue dans le dépôt GitHub, par exemple pour :
+
+* Poser une question ou s'informer sur un problème.
+* Suggérer une nouvelle fonctionnalité.
+
+**Note** : si vous créez un problème, alors je vais vous demander d'aider aussi les autres. 😉
+
+## Créer une Pull Request
+
+Vous pouvez
créer une Pull Request, par exemple :
+
+* Pour corriger une faute de frappe que vous avez trouvée sur la documentation.
+* Proposer de nouvelles sections de documentation.
+* Pour corriger une Issue/Bug existant.
+* Pour ajouter une nouvelle fonctionnalité.
+
+## Rejoindre le chat
+
+
+ 
+
+
+Rejoignez le chat sur Gitter:
https://gitter.im/tiangolo/fastapi.
+
+Vous pouvez y avoir des conversations rapides avec d'autres personnes, aider les autres, partager des idées, etc.
+
+Mais gardez à l'esprit que, comme il permet une "conversation plus libre", il est facile de poser des questions trop générales et plus difficiles à répondre, de sorte que vous risquez de ne pas recevoir de réponses.
+
+Dans les Issues de GitHub, le modèle vous guidera pour écrire la bonne question afin que vous puissiez plus facilement obtenir une bonne réponse, ou même résoudre le problème vous-même avant même de le poser. Et dans GitHub, je peux m'assurer que je réponds toujours à tout, même si cela prend du temps. Je ne peux pas faire cela personnellement avec le chat Gitter. 😅
+
+Les conversations dans Gitter ne sont pas non plus aussi facilement consultables que dans GitHub, de sorte que les questions et les réponses peuvent se perdre dans la conversation.
+
+De l'autre côté, il y a plus de 1000 personnes dans le chat, il y a donc de fortes chances que vous y trouviez quelqu'un à qui parler, presque tout le temps. 😄
+
+## Parrainer l'auteur
+
+Vous pouvez également soutenir financièrement l'auteur (moi) via
GitHub sponsors.
+
+Là, vous pourriez m'offrir un café ☕️ pour me remercier 😄.
+
+## Sponsoriser les outils qui font fonctionner FastAPI
+
+Comme vous l'avez vu dans la documentation, FastAPI se tient sur les épaules des géants, Starlette et Pydantic.
+
+Vous pouvez également parrainer :
+
+*
Samuel Colvin (Pydantic)
+*
Encode (Starlette, Uvicorn)
+
+---
+
+Merci ! 🚀
diff --git a/docs/fr/docs/index.md b/docs/fr/docs/index.md
index 695204458..e7fb9947d 100644
--- a/docs/fr/docs/index.md
+++ b/docs/fr/docs/index.md
@@ -426,7 +426,7 @@ For a more complete example including more features, see the
requests - Required if you want to use the `TestClient`.
+*
HTTPX - Required if you want to use the `TestClient`.
*
jinja2 - Required if you want to use the default template configuration.
*
python-multipart - Required if you want to support form
"parsing", with `request.form()`.
*
itsdangerous - Required for `SessionMiddleware` support.
diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml
index 6bed7be73..7dce4b127 100644
--- a/docs/fr/mkdocs.yml
+++ b/docs/fr/mkdocs.yml
@@ -67,14 +67,21 @@ nav:
- tutorial/query-params.md
- tutorial/body.md
- tutorial/background-tasks.md
+- Guide utilisateur avancé:
+ - advanced/additional-status-codes.md
+ - advanced/additional-responses.md
- async.md
- Déploiement:
- deployment/index.md
+ - deployment/versions.md
+ - deployment/https.md
+ - deployment/deta.md
- deployment/docker.md
- project-generation.md
- alternatives.md
- history-design-future.md
- external-links.md
+- help-fastapi.md
markdown_extensions:
- toc:
permalink: true
diff --git a/docs/he/docs/index.md b/docs/he/docs/index.md
index fa63d8cb7..19f2f2041 100644
--- a/docs/he/docs/index.md
+++ b/docs/he/docs/index.md
@@ -445,7 +445,7 @@ item: Item
בשימוש Starlette:
--
requests - דרוש אם ברצונכם להשתמש ב - `TestClient`.
+-
httpx - דרוש אם ברצונכם להשתמש ב - `TestClient`.
-
jinja2 - דרוש אם ברצונכם להשתמש בברירת המחדל של תצורת הטמפלייטים.
-
python-multipart - דרוש אם ברצונכם לתמוך ב
"פרסור" טפסים, באצמעות
request.form().
-
itsdangerous - דרוש אם ברצונכם להשתמש ב - `SessionMiddleware`.
diff --git a/docs/id/docs/index.md b/docs/id/docs/index.md
index 3129f9dc6..66fc2859e 100644
--- a/docs/id/docs/index.md
+++ b/docs/id/docs/index.md
@@ -426,7 +426,7 @@ For a more complete example including more features, see the
requests - Required if you want to use the `TestClient`.
+*
httpx - Required if you want to use the `TestClient`.
*
jinja2 - Required if you want to use the default template configuration.
*
python-multipart - Required if you want to support form
"parsing", with `request.form()`.
*
itsdangerous - Required for `SessionMiddleware` support.
diff --git a/docs/it/docs/index.md b/docs/it/docs/index.md
index 852a5e56e..9d95dd6d7 100644
--- a/docs/it/docs/index.md
+++ b/docs/it/docs/index.md
@@ -423,7 +423,7 @@ For a more complete example including more features, see the
requests - Required if you want to use the `TestClient`.
+*
httpx - Required if you want to use the `TestClient`.
*
jinja2 - Required if you want to use the default template configuration.
*
python-multipart - Required if you want to support form
"parsing", with `request.form()`.
*
itsdangerous - Required for `SessionMiddleware` support.
diff --git a/docs/ja/docs/advanced/websockets.md b/docs/ja/docs/advanced/websockets.md
new file mode 100644
index 000000000..65e4112a6
--- /dev/null
+++ b/docs/ja/docs/advanced/websockets.md
@@ -0,0 +1,186 @@
+# WebSocket
+
+**FastAPI**で
WebSocketが使用できます。
+
+## `WebSockets`のインストール
+
+まず `WebSockets`のインストールが必要です。
+
+
+
+```console
+$ pip install websockets
+
+---> 100%
+```
+
+
+
+## WebSocket クライアント
+
+### 本番環境
+
+本番環境では、React、Vue.js、Angularなどの最新のフレームワークで作成されたフロントエンドを使用しているでしょう。
+
+そして、バックエンドとWebSocketを使用して通信するために、おそらくフロントエンドのユーティリティを使用することになるでしょう。
+
+または、ネイティブコードでWebSocketバックエンドと直接通信するネイティブモバイルアプリケーションがあるかもしれません。
+
+他にも、WebSocketのエンドポイントと通信する方法があるかもしれません。
+
+---
+
+ただし、この例では非常にシンプルなHTML文書といくつかのJavaScriptを、すべてソースコードの中に入れて使用することにします。
+
+もちろん、これは最適な方法ではありませんし、本番環境で使うことはないでしょう。
+
+本番環境では、上記の方法のいずれかの選択肢を採用することになるでしょう。
+
+しかし、これはWebSocketのサーバーサイドに焦点を当て、実用的な例を示す最も簡単な方法です。
+
+```Python hl_lines="2 6-38 41-43"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+## `websocket` を作成する
+
+**FastAPI** アプリケーションで、`websocket` を作成します。
+
+```Python hl_lines="1 46-47"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+!!! note "技術詳細"
+ `from starlette.websockets import WebSocket` を使用しても構いません.
+
+ **FastAPI** は開発者の利便性のために、同じ `WebSocket` を提供します。しかし、こちらはStarletteから直接提供されるものです。
+
+## メッセージの送受信
+
+WebSocketルートでは、 `await` を使ってメッセージの送受信ができます。
+
+```Python hl_lines="48-52"
+{!../../../docs_src/websockets/tutorial001.py!}
+```
+
+バイナリやテキストデータ、JSONデータを送受信できます。
+
+## 試してみる
+
+ファイル名が `main.py` である場合、以下の方法でアプリケーションを実行します。
+
+
+
+```console
+$ uvicorn main:app --reload
+
+INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+```
+
+
+
+ブラウザで
http://127.0.0.1:8000 を開きます。
+
+次のようなシンプルなページが表示されます。
+
+
+
+入力ボックスにメッセージを入力して送信できます。
+
+
+
+そして、 WebSocketを使用した**FastAPI**アプリケーションが応答します。
+
+
+
+複数のメッセージを送信（および受信）できます。
+
+
+
+そして、これらの通信はすべて同じWebSocket接続を使用します。
+
+## 依存関係
+
+WebSocketエンドポイントでは、`fastapi` から以下をインポートして使用できます。
+
+* `Depends`
+* `Security`
+* `Cookie`
+* `Header`
+* `Path`
+* `Query`
+
+これらは、他のFastAPI エンドポイント/*path operation* の場合と同じように機能します。
+
+```Python hl_lines="58-65 68-83"
+{!../../../docs_src/websockets/tutorial002.py!}
+```
+
+!!! info "情報"
+ WebSocket で `HTTPException` を発生させることはあまり意味がありません。したがって、WebSocketの接続を直接閉じる方がよいでしょう。
+
+ クロージングコードは、
仕様で定義された有効なコードの中から使用することができます。
+
+ 将来的には、どこからでも `raise` できる `WebSocketException` が用意され、専用の例外ハンドラを追加できるようになる予定です。これは、Starlette の
PR #527 に依存するものです。
+
+### 依存関係を用いてWebSocketsを試してみる
+
+ファイル名が `main.py` である場合、以下の方法でアプリケーションを実行します。
+
+
+
+```console
+$ uvicorn main:app --reload
+
+INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+```
+
+
+
+ブラウザで
http://127.0.0.1:8000 を開きます。
+
+クライアントが設定できる項目は以下の通りです。
+
+* パスで使用される「Item ID」
+* クエリパラメータとして使用される「Token」
+
+!!! tip "豆知識"
+ クエリ `token` は依存パッケージによって処理されることに注意してください。
+
+これにより、WebSocketに接続してメッセージを送受信できます。
+
+
+
+## 切断や複数クライアントへの対応
+
+WebSocket接続が閉じられると、 `await websocket.receive_text()` は例外 `WebSocketDisconnect` を発生させ、この例のようにキャッチして処理することができます。
+
+```Python hl_lines="81-83"
+{!../../../docs_src/websockets/tutorial003.py!}
+```
+
+試してみるには、
+
+* いくつかのブラウザタブでアプリを開きます。
+* それらのタブでメッセージを記入してください。
+* そして、タブのうち1つを閉じてください。
+
+これにより例外 `WebSocketDisconnect` が発生し、他のすべてのクライアントは次のようなメッセージを受信します。
+
+```
+Client #1596980209979 left the chat
+```
+
+!!! tip "豆知識"
+ 上記のアプリは、複数の WebSocket 接続に対してメッセージを処理し、ブロードキャストする方法を示すための最小限のシンプルな例です。
+
+ しかし、すべての接続がメモリ内の単一のリストで処理されるため、プロセスの実行中にのみ機能し、単一のプロセスでのみ機能することに注意してください。
+
+ もしFastAPIと簡単に統合できて、RedisやPostgreSQLなどでサポートされている、より堅牢なものが必要なら、
encode/broadcaster を確認してください。
+
+## その他のドキュメント
+
+オプションの詳細については、Starletteのドキュメントを確認してください。
+
+*
`WebSocket` クラス
+*
クラスベースのWebSocket処理
diff --git a/docs/ja/docs/contributing.md b/docs/ja/docs/contributing.md
index 8bad864a2..9affea443 100644
--- a/docs/ja/docs/contributing.md
+++ b/docs/ja/docs/contributing.md
@@ -97,7 +97,7 @@ $ python -m venv env
```console
-$ pip install -e .[dev,doc,test]
+$ pip install -e ."[dev,doc,test]"
---> 100%
```
diff --git a/docs/ja/docs/features.md b/docs/ja/docs/features.md
index 5ea68515d..a40b48cf0 100644
--- a/docs/ja/docs/features.md
+++ b/docs/ja/docs/features.md
@@ -169,7 +169,7 @@ FastAPIには非常に使いやすく、非常に強力な
requests - 使用 `TestClient` 时安装。
+* httpx - 使用 `TestClient` 时安装。
* jinja2 - 使用默认模板配置时安装。
* python-multipart - 需要通过 `request.form()` 对表单进行「解析」时安装。
* itsdangerous - 需要 `SessionMiddleware` 支持时安装。
diff --git a/docs/zh/docs/python-types.md b/docs/zh/docs/python-types.md
index 67a1612f0..6cdb4b588 100644
--- a/docs/zh/docs/python-types.md
+++ b/docs/zh/docs/python-types.md
@@ -194,7 +194,7 @@ John Doe
这表示：
-* 变量 `items_t` 是一个 `tuple`，其中的每个元素都是 `int` 类型。
+* 变量 `items_t` 是一个 `tuple`，其中的前两个元素都是 `int` 类型, 最后一个元素是 `str` 类型。
* 变量 `items_s` 是一个 `set`，其中的每个元素都是 `bytes` 类型。
#### 字典
diff --git a/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md
new file mode 100644
index 000000000..5813272ee
--- /dev/null
+++ b/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md
@@ -0,0 +1,247 @@
+# 类作为依赖项
+
+在深入探究 **依赖注入** 系统之前，让我们升级之前的例子。
+
+## 来自前一个例子的`dict`
+
+在前面的例子中, 我们从依赖项 ("可依赖对象") 中返回了一个 `dict`:
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="9"
+ {!> ../../../docs_src/dependencies/tutorial001.py!}
+ ```
+
+=== "Python 3.10 以及以上"
+
+ ```Python hl_lines="7"
+ {!> ../../../docs_src/dependencies/tutorial001_py310.py!}
+ ```
+
+但是后面我们在路径操作函数的参数 `commons` 中得到了一个 `dict`。
+
+我们知道编辑器不能为 `dict` 提供很多支持(比如补全)，因为编辑器不知道 `dict` 的键和值类型。
+
+对此，我们可以做的更好...
+
+## 什么构成了依赖项？
+
+到目前为止，您看到的依赖项都被声明为函数。
+
+但这并不是声明依赖项的唯一方法(尽管它可能是更常见的方法)。
+
+关键因素是依赖项应该是 "可调用对象"。
+
+Python 中的 "**可调用对象**" 是指任何 Python 可以像函数一样 "调用" 的对象。
+
+所以，如果你有一个对象 `something` (可能*不是*一个函数)，你可以 "调用" 它(执行它)，就像：
+
+```Python
+something()
+```
+
+或者
+
+```Python
+something(some_argument, some_keyword_argument="foo")
+```
+
+这就是 "可调用对象"。
+
+## 类作为依赖项
+
+您可能会注意到，要创建一个 Python 类的实例，您可以使用相同的语法。
+
+举个例子:
+
+```Python
+class Cat:
+ def __init__(self, name: str):
+ self.name = name
+
+
+fluffy = Cat(name="Mr Fluffy")
+```
+
+在这个例子中, `fluffy` 是一个 `Cat` 类的实例。
+
+为了创建 `fluffy`，你调用了 `Cat` 。
+
+所以，Python 类也是 **可调用对象**。
+
+因此，在 **FastAPI** 中，你可以使用一个 Python 类作为一个依赖项。
+
+实际上 FastAPI 检查的是它是一个 "可调用对象"（函数，类或其他任何类型）以及定义的参数。
+
+如果您在 **FastAPI** 中传递一个 "可调用对象" 作为依赖项，它将分析该 "可调用对象" 的参数，并以处理路径操作函数的参数的方式来处理它们。包括子依赖项。
+
+这也适用于完全没有参数的可调用对象。这与不带参数的路径操作函数一样。
+
+所以，我们可以将上面的依赖项 "可依赖对象" `common_parameters` 更改为类 `CommonQueryParams`:
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="11-15"
+ {!> ../../../docs_src/dependencies/tutorial002.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="9-13"
+ {!> ../../../docs_src/dependencies/tutorial002_py310.py!}
+ ```
+
+注意用于创建类实例的 `__init__` 方法：
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="12"
+ {!> ../../../docs_src/dependencies/tutorial002.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="10"
+ {!> ../../../docs_src/dependencies/tutorial002_py310.py!}
+ ```
+
+...它与我们以前的 `common_parameters` 具有相同的参数：
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="9"
+ {!> ../../../docs_src/dependencies/tutorial001.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="6"
+ {!> ../../../docs_src/dependencies/tutorial001_py310.py!}
+ ```
+
+这些参数就是 **FastAPI** 用来 "处理" 依赖项的。
+
+在两个例子下，都有：
+
+* 一个可选的 `q` 查询参数，是 `str` 类型。
+* 一个 `skip` 查询参数，是 `int` 类型，默认值为 `0`。
+* 一个 `limit` 查询参数，是 `int` 类型，默认值为 `100`。
+
+在两个例子下，数据都将被转换、验证、在 OpenAPI schema 上文档化，等等。
+
+## 使用它
+
+现在，您可以使用这个类来声明你的依赖项了。
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="19"
+ {!> ../../../docs_src/dependencies/tutorial002.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="17"
+ {!> ../../../docs_src/dependencies/tutorial002_py310.py!}
+ ```
+
+**FastAPI** 调用 `CommonQueryParams` 类。这将创建该类的一个 "实例"，该实例将作为参数 `commons` 被传递给你的函数。
+
+## 类型注解 vs `Depends`
+
+注意，我们在上面的代码中编写了两次`CommonQueryParams`：
+
+```Python
+commons: CommonQueryParams = Depends(CommonQueryParams)
+```
+
+最后的 `CommonQueryParams`:
+
+```Python
+... = Depends(CommonQueryParams)
+```
+
+...实际上是 **Fastapi** 用来知道依赖项是什么的。
+
+FastAPI 将从依赖项中提取声明的参数，这才是 FastAPI 实际调用的。
+
+---
+
+在本例中，第一个 `CommonQueryParams` ：
+
+```Python
+commons: CommonQueryParams ...
+```
+
+...对于 **FastAPI** 没有任何特殊的意义。FastAPI 不会使用它进行数据转换、验证等 (因为对于这，它使用 `= Depends(CommonQueryParams)`)。
+
+你实际上可以只这样编写:
+
+```Python
+commons = Depends(CommonQueryParams)
+```
+
+..就像:
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="19"
+ {!> ../../../docs_src/dependencies/tutorial003.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="17"
+ {!> ../../../docs_src/dependencies/tutorial003_py310.py!}
+ ```
+
+但是声明类型是被鼓励的，因为那样你的编辑器就会知道将传递什么作为参数 `commons` ，然后它可以帮助你完成代码，类型检查，等等：
+
+
+
+## 快捷方式
+
+但是您可以看到，我们在这里有一些代码重复了，编写了`CommonQueryParams`两次：
+
+```Python
+commons: CommonQueryParams = Depends(CommonQueryParams)
+```
+
+**FastAPI** 为这些情况提供了一个快捷方式，在这些情况下，依赖项 *明确地* 是一个类，**FastAPI** 将 "调用" 它来创建类本身的一个实例。
+
+对于这些特定的情况，您可以跟随以下操作：
+
+不是写成这样：
+
+```Python
+commons: CommonQueryParams = Depends(CommonQueryParams)
+```
+
+...而是这样写:
+
+```Python
+commons: CommonQueryParams = Depends()
+```
+
+您声明依赖项作为参数的类型，并使用 `Depends()` 作为该函数的参数的 "默认" 值(在 `=` 之后)，而在 `Depends()` 中没有任何参数，而不是在 `Depends(CommonQueryParams)` 编写完整的类。
+
+同样的例子看起来像这样：
+
+=== "Python 3.6 以及 以上"
+
+ ```Python hl_lines="19"
+ {!> ../../../docs_src/dependencies/tutorial004.py!}
+ ```
+
+=== "Python 3.10 以及 以上"
+
+ ```Python hl_lines="17"
+ {!> ../../../docs_src/dependencies/tutorial004_py310.py!}
+ ```
+
+... **FastAPI** 会知道怎么处理。
+
+!!! tip
+ 如果这看起来更加混乱而不是更加有帮助，那么请忽略它，你不*需要*它。
+
+ 这只是一个快捷方式。因为 **FastAPI** 关心的是帮助您减少代码重复。
diff --git a/docs/zh/docs/tutorial/query-params-str-validations.md b/docs/zh/docs/tutorial/query-params-str-validations.md
index 0b2b9446a..070074839 100644
--- a/docs/zh/docs/tutorial/query-params-str-validations.md
+++ b/docs/zh/docs/tutorial/query-params-str-validations.md
@@ -104,7 +104,7 @@ q: str
代替：
```Python
-q: str = None
+q: Union[str, None] = None
```
但是现在我们正在用 `Query` 声明它，例如：
@@ -113,17 +113,51 @@ q: str = None
q: Union[str, None] = Query(default=None, min_length=3)
```
-因此，当你在使用 `Query` 且需要声明一个值是必需的时，可以将 `...` 用作第一个参数值：
+因此，当你在使用 `Query` 且需要声明一个值是必需的时，只需不声明默认参数：
```Python hl_lines="7"
{!../../../docs_src/query_params_str_validations/tutorial006.py!}
```
+### 使用省略号(`...`)声明必需参数
+
+有另一种方法可以显式的声明一个值是必需的，即将默认参数的默认值设为 `...` ：
+
+```Python hl_lines="7"
+{!../../../docs_src/query_params_str_validations/tutorial006b.py!}
+```
+
!!! info
如果你之前没见过 `...` 这种用法：它是一个特殊的单独值，它是 Python 的一部分并且被称为「省略号」。
+ Pydantic 和 FastAPI 使用它来显式的声明需要一个值。
这将使 **FastAPI** 知道此查询参数是必需的。
+### 使用`None`声明必需参数
+
+你可以声明一个参数可以接收`None`值，但它仍然是必需的。这将强制客户端发送一个值，即使该值是`None`。
+
+为此，你可以声明`None`是一个有效的类型，并仍然使用`default=...`：
+
+```Python hl_lines="9"
+{!../../../docs_src/query_params_str_validations/tutorial006c.py!}
+```
+
+!!! tip
+ Pydantic 是 FastAPI 中所有数据验证和序列化的核心，当你在没有设默认值的情况下使用 `Optional` 或 `Union[Something, None]` 时，它具有特殊行为，你可以在 Pydantic 文档中阅读有关必需可选字段的更多信息。
+
+### 使用Pydantic中的`Required`代替省略号(`...`)
+
+如果你觉得使用 `...` 不舒服，你也可以从 Pydantic 导入并使用 `Required`：
+
+```Python hl_lines="2 8"
+{!../../../docs_src/query_params_str_validations/tutorial006d.py!}
+```
+
+!!! tip
+ 请记住，在大多数情况下，当你需要某些东西时，可以简单地省略 `default` 参数，因此你通常不必使用 `...` 或 `Required`
+
+
## 查询参数列表 / 多个值
当你使用 `Query` 显式地定义查询参数时，你还可以声明它去接收一组值，或换句话来说，接收多个值。
diff --git a/docs/zh/docs/tutorial/security/first-steps.md b/docs/zh/docs/tutorial/security/first-steps.md
index 116572411..86c3320ce 100644
--- a/docs/zh/docs/tutorial/security/first-steps.md
+++ b/docs/zh/docs/tutorial/security/first-steps.md
@@ -110,7 +110,7 @@ OAuth2 的设计目标是为了让后端或 API 独立于服务器验证用户
!!! info "说明"
- `Beare` 令牌不是唯一的选择。
+ `Bearer` 令牌不是唯一的选择。
但它是最适合这个用例的方案。
diff --git a/docs/zh/docs/tutorial/security/oauth2-jwt.md b/docs/zh/docs/tutorial/security/oauth2-jwt.md
index 82ef9b897..054198545 100644
--- a/docs/zh/docs/tutorial/security/oauth2-jwt.md
+++ b/docs/zh/docs/tutorial/security/oauth2-jwt.md
@@ -1,34 +1,34 @@
-# 使用（哈希）密码和 JWT Bearer 令牌的 OAuth2
+# OAuth2 实现密码哈希与 Bearer JWT 令牌验证
-既然我们已经有了所有的安全流程，就让我们来使用 JWT 令牌和安全哈希密码让应用程序真正地安全吧。
+至此，我们已经编写了所有安全流，本章学习如何使用 JWT 令牌（Token）和安全密码哈希（Hash）实现真正的安全机制。
-你可以在应用程序中真正地使用这些代码，在数据库中保存密码哈希值，等等。
+本章的示例代码真正实现了在应用的数据库中保存哈希密码等功能。
-我们将从上一章结束的位置开始，然后对示例进行扩充。
+接下来，我们紧接上一章，继续完善安全机制。
-## 关于 JWT
+## JWT 简介
-JWT 表示 「JSON Web Tokens」。
+JWT 即**JSON 网络令牌**（JSON Web Tokens）。
-它是一个将 JSON 对象编码为密集且没有空格的长字符串的标准。字符串看起来像这样：
+JWT 是一种将 JSON 对象编码为没有空格，且难以理解的长字符串的标准。JWT 的内容如下所示：
```
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```
-它没有被加密，因此任何人都可以从字符串内容中还原数据。
+JWT 字符串没有加密，任何人都能用它恢复原始信息。
-但它经过了签名。因此，当你收到一个由你发出的令牌时，可以校验令牌是否真的由你发出。
+但 JWT 使用了签名机制。接受令牌时，可以用签名校验令牌。
-通过这种方式，你可以创建一个有效期为 1 周的令牌。然后当用户第二天使用令牌重新访问时，你知道该用户仍然处于登入状态。
+使用 JWT 创建有效期为一周的令牌。第二天，用户持令牌再次访问时，仍为登录状态。
-一周后令牌将会过期，用户将不会通过认证，必须再次登录才能获得一个新令牌。而且如果用户（或第三方）试图修改令牌以篡改过期时间，你将因为签名不匹配而能够发觉。
+令牌于一周后过期，届时，用户身份验证就会失败。只有再次登录，才能获得新的令牌。如果用户（或第三方）篡改令牌的过期时间，因为签名不匹配会导致身份验证失败。
-如果你想上手体验 JWT 令牌并了解其工作方式，可访问 https://jwt.io。
+如需深入了解 JWT 令牌，了解它的工作方式，请参阅 https://jwt.io。
## 安装 `python-jose`
-我们需要安装 `python-jose` 以在 Python 中生成和校验 JWT 令牌：
+安装 `python-jose`，在 Python 中生成和校验 JWT 令牌：
@@ -40,38 +40,39 @@ $ pip install python-jose[cryptography]
-Python-jose 需要一个额外的加密后端。
+Python-jose 需要安装配套的加密后端。
-这里我们使用的是推荐的后端：pyca/cryptography。
+本教程推荐的后端是：pyca/cryptography。
-!!! tip
- 本教程曾经使用过 PyJWT。
+!!! tip "提示"
- 但是后来更新为使用 Python-jose，因为它提供了 PyJWT 的所有功能，以及之后与其他工具进行集成时你可能需要的一些其他功能。
+ 本教程以前使用 PyJWT。
-## 哈希密码
+ 但后来换成了 Python-jose，因为 Python-jose 支持 PyJWT 的所有功能，还支持与其它工具集成时可能会用到的一些其它功能。
-「哈希」的意思是：将某些内容（在本例中为密码）转换为看起来像乱码的字节序列（只是一个字符串）。
+## 密码哈希
-每次你传入完全相同的内容（完全相同的密码）时，你都会得到完全相同的乱码。
+**哈希**是指把特定内容（本例中为密码）转换为乱码形式的字节序列（其实就是字符串）。
-但是你不能从乱码转换回密码。
+每次传入完全相同的内容时（比如，完全相同的密码），返回的都是完全相同的乱码。
-### 为什么使用哈希密码
+但这个乱码无法转换回传入的密码。
-如果你的数据库被盗，小偷将无法获得用户的明文密码，只能拿到哈希值。
+### 为什么使用密码哈希
-因此，小偷将无法尝试在另一个系统中使用这些相同的密码（由于许多用户在任何地方都使用相同的密码，因此这很危险）。
+原因很简单，假如数据库被盗，窃贼无法获取用户的明文密码，得到的只是哈希值。
+
+这样一来，窃贼就无法在其它应用中使用窃取的密码，要知道，很多用户在所有系统中都使用相同的密码，风险超大）。
## 安装 `passlib`
-PassLib 是一个用于处理哈希密码的很棒的 Python 包。
+Passlib 是处理密码哈希的 Python 包。
-它支持许多安全哈希算法以及配合算法使用的实用程序。
+它支持很多安全哈希算法及配套工具。
-推荐的算法是 「Bcrypt」。
+本教程推荐的算法是 **Bcrypt**。
-因此，安装附带 Bcrypt 的 PassLib：
+因此，请先安装附带 Bcrypt 的 PassLib：
@@ -83,46 +84,49 @@ $ pip install passlib[bcrypt]
-!!! tip
- 使用 `passlib`，你甚至可以将其配置为能够读取 Django，Flask 的安全扩展或许多其他工具创建的密码。
+!!! tip "提示"
+
+ `passlib` 甚至可以读取 Django、Flask 的安全插件等工具创建的密码。
+
+ 例如，把 Django 应用的数据共享给 FastAPI 应用的数据库。或利用同一个数据库，可以逐步把应用从 Django 迁移到 FastAPI。
- 因此，你将能够，举个例子，将数据库中来自 Django 应用的数据共享给一个 FastAPI 应用。或者使用同一数据库但逐渐将应用从 Django 迁移到 FastAPI。
+ 并且，用户可以同时从 Django 应用或 FastAPI 应用登录。
- 而你的用户将能够同时从 Django 应用或 FastAPI 应用登录。
+## 密码哈希与校验
-## 哈希并校验密码
+从 `passlib` 导入所需工具。
-从 `passlib` 导入我们需要的工具。
+创建用于密码哈希和身份校验的 PassLib **上下文**。
-创建一个 PassLib 「上下文」。这将用于哈希和校验密码。
+!!! tip "提示"
-!!! tip
- PassLib 上下文还具有使用不同哈希算法的功能，包括仅允许用于校验的已弃用的旧算法等。
+ PassLib 上下文还支持使用不同哈希算法的功能，包括只能校验的已弃用旧算法等。
- 例如，你可以使用它来读取和校验由另一个系统（例如Django）生成的密码，但是使用其他算法例如 Bcrypt 生成新的密码哈希值。
+ 例如，用它读取和校验其它系统（如 Django）生成的密码，但要使用其它算法，如 Bcrypt，生成新的哈希密码。
- 并同时兼容所有的这些功能。
+ 同时，这些功能都是兼容的。
-创建一个工具函数以哈希来自用户的密码。
+接下来，创建三个工具函数，其中一个函数用于哈希用户的密码。
-然后创建另一个工具函数，用于校验接收的密码是否与存储的哈希值匹配。
+第一个函数用于校验接收的密码是否匹配存储的哈希值。
-再创建另一个工具函数用于认证并返回用户。
+第三个函数用于身份验证，并返回用户。
```Python hl_lines="7 48 55-56 59-60 69-75"
{!../../../docs_src/security/tutorial004.py!}
```
-!!! note
- 如果你查看新的（伪）数据库 `fake_users_db`，你将看到哈希后的密码现在的样子：`"$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW"`。
+!!! note "笔记"
+
+ 查看新的（伪）数据库 `fake_users_db`，就能看到哈希后的密码：`"$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW"`。
## 处理 JWT 令牌
导入已安装的模块。
-创建一个随机密钥，该密钥将用于对 JWT 令牌进行签名。
+创建用于 JWT 令牌签名的随机密钥。
-要生成一个安全的随机密钥，可使用以下命令：
+使用以下命令，生成安全的随机密钥：
@@ -134,15 +138,15 @@ $ openssl rand -hex 32
-然后将输出复制到变量 「SECRET_KEY」 中（不要使用示例中的这个）。
+然后，把生成的密钥复制到变量**SECRET_KEY**，注意，不要使用本例所示的密钥。
-创建用于设定 JWT 令牌签名算法的变量 「ALGORITHM」，并将其设置为 `"HS256"`。
+创建指定 JWT 令牌签名算法的变量 **ALGORITHM**，本例中的值为 `"HS256"`。
-创建一个设置令牌过期时间的变量。
+创建设置令牌过期时间的变量。
-定义一个将在令牌端点中用于响应的 Pydantic 模型。
+定义令牌端点响应的 Pydantic 模型。
-创建一个生成新的访问令牌的工具函数。
+创建生成新的访问令牌的工具函数。
```Python hl_lines="6 12-14 28-30 78-86"
{!../../../docs_src/security/tutorial004.py!}
@@ -150,11 +154,11 @@ $ openssl rand -hex 32
## 更新依赖项
-更新 `get_current_user` 以接收与之前相同的令牌，但这次使用的是 JWT 令牌。
+更新 `get_current_user` 以接收与之前相同的令牌，但这里用的是 JWT 令牌。
-解码接收到的令牌，对其进行校验，然后返回当前用户。
+解码并校验接收到的令牌，然后，返回当前用户。
-如果令牌无效，立即返回一个 HTTP 错误。
+如果令牌无效，则直接返回 HTTP 错误。
```Python hl_lines="89-106"
{!../../../docs_src/security/tutorial004.py!}
@@ -162,57 +166,57 @@ $ openssl rand -hex 32
## 更新 `/token` *路径操作*
-使用令牌的过期时间创建一个 `timedelta` 对象。
+用令牌过期时间创建 `timedelta` 对象。
-创建一个真实的 JWT 访问令牌并返回它。
+创建并返回真正的 JWT 访问令牌。
```Python hl_lines="115-128"
{!../../../docs_src/security/tutorial004.py!}
```
-### 关于 JWT 「主题」 `sub` 的技术细节
+### JWT `sub` 的技术细节
-JWT 的规范中提到有一个 `sub` 键，值为该令牌的主题。
+JWT 规范还包括 `sub` 键，值是令牌的主题。
-使用它并不是必须的，但这是你放置用户标识的地方，所以我们在示例中使用了它。
+该键是可选的，但要把用户标识放在这个键里，所以本例使用了该键。
-除了识别用户并允许他们直接在你的 API 上执行操作之外，JWT 还可以用于其他事情。
+除了识别用户与许可用户在 API 上直接执行操作之外，JWT 还可能用于其它事情。
-例如，你可以识别一个 「汽车」 或 「博客文章」。
+例如，识别**汽车**或**博客**。
-然后你可以添加关于该实体的权限，比如「驾驶」（汽车）或「编辑」（博客）。
+接着，为实体添加权限，比如**驾驶**（汽车）或**编辑**（博客）。
-然后，你可以将 JWT 令牌交给用户（或机器人），他们可以使用它来执行这些操作（驾驶汽车，或编辑博客文章），甚至不需要有一个账户，只需使用你的 API 为其生成的 JWT 令牌。
+然后，把 JWT 令牌交给用户（或机器人），他们就可以执行驾驶汽车，或编辑博客等操作。无需注册账户，只要有 API 生成的 JWT 令牌就可以。
-使用这样的思路，JWT 可以用于更复杂的场景。
+同理，JWT 可以用于更复杂的场景。
-在这些情况下，几个实体可能有相同的 ID，比如说 `foo`（一个用户 `foo`，一辆车 `foo`，一篇博客文章 `foo`）。
+在这些情况下，多个实体的 ID 可能是相同的，以 ID `foo` 为例，用户的 ID 是 `foo`，车的 ID 是 `foo`，博客的 ID 也是 `foo`。
-因此，为了避免 ID 冲突，当为用户创建 JWT 令牌时，你可以在 `sub` 键的值前加上前缀，例如 `username:`。所以，在这个例子中，`sub` 的值可以是：`username:johndoe`。
+为了避免 ID 冲突，在给用户创建 JWT 令牌时，可以为 `sub` 键的值加上前缀，例如 `username:`。因此，在本例中，`sub` 的值可以是：`username:johndoe`。
-要记住的重点是，`sub` 键在整个应用程序中应该有一个唯一的标识符，而且应该是一个字符串。
+注意，划重点，`sub` 键在整个应用中应该只有一个唯一的标识符，而且应该是字符串。
-## 检查效果
+## 检查
运行服务器并访问文档： http://127.0.0.1:8000/docs。
-你会看到如下用户界面：
+可以看到如下用户界面：
-像以前一样对应用程序进行认证。
+用与上一章同样的方式实现应用授权。
使用如下凭证：
-用户名: `johndoe`
-密码: `secret`
+用户名: `johndoe` 密码: `secret`
+
+!!! check "检查"
-!!! check
- 请注意，代码中没有任何地方记录了明文密码 「`secret`」，我们只保存了其哈希值。
+ 注意，代码中没有明文密码**`secret`**，只保存了它的哈希值。
-访问 `/users/me/` 端点，你将获得如下响应：
+调用 `/users/me/` 端点，收到下面的响应：
```JSON
{
@@ -225,41 +229,42 @@ JWT 的规范中提到有一个 `sub` 键，值为该令牌的主题。
-如果你打开开发者工具，将看到数据是如何发送的并且其中仅包含了令牌，只有在第一个请求中发送了密码以校验用户身份并获取该访问令牌，但之后都不会再发送密码：
+打开浏览器的开发者工具，查看数据是怎么发送的，而且数据里只包含了令牌，只有验证用户的第一个请求才发送密码，并获取访问令牌，但之后不会再发送密码：
-!!! note
- 注意请求中的 `Authorization` 首部，其值以 `Bearer` 开头。
+!!! note "笔记"
+
+ 注意，请求中 `Authorization` 响应头的值以 `Bearer` 开头。
-## 使用 `scopes` 的进阶用法
+## `scopes` 高级用法
-OAuth2 具有「作用域」的概念。
+OAuth2 支持**`scopes`**（作用域）。
-你可以使用它们向 JWT 令牌添加一组特定的权限。
+**`scopes`**为 JWT 令牌添加指定权限。
-然后，你可以将此令牌直接提供给用户或第三方，使其在一些限制下与你的 API 进行交互。
+让持有令牌的用户或第三方在指定限制条件下与 API 交互。
-你可以在之后的**进阶用户指南**中了解如何使用它们以及如何将它们集成到 **FastAPI** 中。
+**高级用户指南**中将介绍如何使用 `scopes`，及如何把 `scopes` 集成至 **FastAPI**。
-## 总结
+## 小结
-通过目前你所看到的，你可以使用像 OAuth2 和 JWT 这样的标准来构建一个安全的 **FastAPI** 应用程序。
+至此，您可以使用 OAuth2 和 JWT 等标准配置安全的 **FastAPI** 应用。
-在几乎所有的框架中，处理安全性问题都很容易成为一个相当复杂的话题。
+几乎在所有框架中，处理安全问题很快都会变得非常复杂。
-许多高度简化了安全流程的软件包不得不在数据模型、数据库和可用功能上做出很多妥协。而这些过于简化流程的软件包中，有些其实隐含了安全漏洞。
+有些包为了简化安全流，不得不在数据模型、数据库和功能上做出妥协。而有些过于简化的软件包其实存在了安全隐患。
---
-**FastAPI** 不对任何数据库、数据模型或工具做任何妥协。
+**FastAPI** 不向任何数据库、数据模型或工具做妥协。
-它给了你所有的灵活性来选择最适合你项目的前者。
+开发者可以灵活选择最适合项目的安全机制。
-你可以直接使用许多维护良好且使用广泛的包，如 `passlib` 和 `python-jose`，因为 **FastAPI** 不需要任何复杂的机制来集成外部包。
+还可以直接使用 `passlib` 和 `python-jose` 等维护良好、使用广泛的包，这是因为 **FastAPI** 不需要任何复杂机制，就能集成外部的包。
-但它为你提供了一些工具，在不影响灵活性、健壮性和安全性的前提下，尽可能地简化这个过程。
+而且，**FastAPI** 还提供了一些工具，在不影响灵活、稳定和安全的前提下，尽可能地简化安全机制。
-而且你可以用相对简单的方式使用和实现安全、标准的协议，比如 OAuth2。
+**FastAPI** 还支持以相对简单的方式，使用 OAuth2 等安全、标准的协议。
-你可以在**进阶用户指南**中了解更多关于如何使用 OAuth2 「作用域」的信息，以实现更精细的权限系统，并同样遵循这些标准。带有作用域的 OAuth2 是很多大的认证提供商使用的机制，比如 Facebook、Google、GitHub、微软、Twitter 等，授权第三方应用代表用户与他们的 API 进行交互。
+**高级用户指南**中详细介绍了 OAuth2**`scopes`**的内容，遵循同样的标准，实现更精密的权限系统。OAuth2 的作用域是脸书、谷歌、GitHub、微软、推特等第三方身份验证应用使用的机制，让用户授权第三方应用与 API 交互。
diff --git a/docs/zh/docs/tutorial/sql-databases.md b/docs/zh/docs/tutorial/sql-databases.md
new file mode 100644
index 000000000..6b354c2b6
--- /dev/null
+++ b/docs/zh/docs/tutorial/sql-databases.md
@@ -0,0 +1,770 @@
+# SQL (关系型) 数据库
+
+**FastAPI**不需要你使用SQL(关系型)数据库。
+
+但是您可以使用任何您想要的关系型数据库。
+
+在这里，让我们看一个使用着[SQLAlchemy](https://www.sqlalchemy.org/)的示例。
+
+您可以很容易地将SQLAlchemy支持任何数据库，像：
+
+* PostgreSQL
+* MySQL
+* SQLite
+* Oracle
+* Microsoft SQL Server，等等其它数据库
+
+在此示例中，我们将使用**SQLite**，因为它使用单个文件并且 在Python中具有集成支持。因此，您可以复制此示例并按原样来运行它。
+
+稍后，对于您的产品级别的应用程序，您可能会要使用像**PostgreSQL**这样的数据库服务器。
+
+!!! tip
+ 这儿有一个**FastAPI**和**PostgreSQL**的官方项目生成器，全部基于**Docker**，包括前端和更多工具：https://github.com/tiangolo/full-stack-fastapi-postgresql
+
+!!! note
+ 请注意，大部分代码是`SQLAlchemy`的标准代码，您可以用于任何框架。FastAPI特定的代码和往常一样少。
+
+## ORMs（对象关系映射）
+
+**FastAPI**可与任何数据库在任何样式的库中一起与 数据库进行通信。
+
+一种常见的模式是使用“ORM”：对象关系映射。
+
+ORM 具有在代码和数据库表（“*关系型”）中的**对象**之间转换（“*映射*”）的工具。
+
+使用 ORM，您通常会在 SQL 数据库中创建一个代表映射的类，该类的每个属性代表一个列，具有名称和类型。
+
+例如，一个类`Pet`可以表示一个 SQL 表`pets`。
+
+该类的每个*实例对象都代表数据库中的一行数据。*
+
+又例如，一个对象`orion_cat`（`Pet`的一个实例）可以有一个属性`orion_cat.type`, 对标数据库中的`type`列。并且该属性的值可以是其它，例如`"cat"`。
+
+这些 ORM 还具有在表或实体之间建立关系的工具（比如创建多表关系）。
+
+这样，您还可以拥有一个属性`orion_cat.owner`，它包含该宠物所有者的数据，这些数据取自另外一个表。
+
+因此，`orion_cat.owner.name`可能是该宠物主人的姓名（来自表`owners`中的列`name`）。
+
+它可能有一个像`"Arquilian"`(一种业务逻辑)。
+
+当您尝试从您的宠物对象访问它时，ORM 将完成所有工作以从相应的表*所有者那里再获取信息。*
+
+常见的 ORM 例如：Django-ORM（Django 框架的一部分）、SQLAlchemy ORM（SQLAlchemy 的一部分，独立于框架）和 Peewee（独立于框架）等。
+
+在这里，我们将看到如何使用**SQLAlchemy ORM**。
+
+以类似的方式，您也可以使用任何其他 ORM。
+
+!!! tip
+ 在文档中也有一篇使用 Peewee 的等效的文章。
+
+## 文件结构
+
+对于这些示例，假设您有一个名为的目录`my_super_project`，其中包含一个名为的子目录`sql_app`，其结构如下：
+
+```
+.
+└── sql_app
+ ├── __init__.py
+ ├── crud.py
+ ├── database.py
+ ├── main.py
+ ├── models.py
+ └── schemas.py
+```
+
+该文件`__init__.py`只是一个空文件，但它告诉 Python 其中`sql_app`的所有模块（Python 文件）都是一个包。
+
+现在让我们看看每个文件/模块的作用。
+
+## 创建 SQLAlchemy 部件
+
+让我们涉及到文件`sql_app/database.py`。
+
+### 导入 SQLAlchemy 部件
+
+```Python hl_lines="1-3"
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+### 为 SQLAlchemy 定义数据库 URL地址
+
+```Python hl_lines="5-6"
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+在这个例子中，我们正在“连接”到一个 SQLite 数据库（用 SQLite 数据库打开一个文件）。
+
+该文件将位于文件中的同一目录中`sql_app.db`。
+
+这就是为什么最后一部分是`./sql_app.db`.
+
+如果您使用的是**PostgreSQL**数据库，则只需取消注释该行：
+
+```Python
+SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db"
+```
+
+...并根据您的数据库数据和相关凭据（也适用于 MySQL、MariaDB 或任何其他）对其进行调整。
+
+!!! tip
+
+ 如果您想使用不同的数据库，这是就是您必须修改的地方。
+
+### 创建 SQLAlchemy 引擎
+
+第一步，创建一个 SQLAlchemy的“引擎”。
+
+我们稍后会将这个`engine`在其他地方使用。
+
+```Python hl_lines="8-10"
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+#### 注意
+
+参数:
+
+```Python
+connect_args={"check_same_thread": False}
+```
+
+...仅用于`SQLite`，在其他数据库不需要它。
+
+!!! info "技术细节"
+
+ 默认情况下，SQLite 只允许一个线程与其通信，假设有多个线程的话，也只将处理一个独立的请求。
+
+ 这是为了防止意外地为不同的事物（不同的请求）共享相同的连接。
+
+ 但是在 FastAPI 中，普遍使用def函数，多个线程可以为同一个请求与数据库交互，所以我们需要使用`connect_args={"check_same_thread": False}`来让SQLite允许这样。
+
+ 此外，我们将确保每个请求都在依赖项中获得自己的数据库连接会话，因此不需要该默认机制。
+
+### 创建一个`SessionLocal`类
+
+每个实例`SessionLocal`都会是一个数据库会话。当然该类本身还不是数据库会话。
+
+但是一旦我们创建了一个`SessionLocal`类的实例，这个实例将是实际的数据库会话。
+
+我们命名它是`SessionLocal`为了将它与我们从 SQLAlchemy 导入的`Session`区别开来。
+
+稍后我们将使用`Session`（从 SQLAlchemy 导入的那个）。
+
+要创建`SessionLocal`类，请使用函数`sessionmaker`：
+
+```Python hl_lines="11"
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+### 创建一个`Base`类
+
+现在我们将使用`declarative_base()`返回一个类。
+
+稍后我们将用这个类继承，来创建每个数据库模型或类（ORM 模型）：
+
+```Python hl_lines="13"
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+## 创建数据库模型
+
+现在让我们看看文件`sql_app/models.py`。
+
+### 用`Base`类来创建 SQLAlchemy 模型
+
+我们将使用我们之前创建的`Base`类来创建 SQLAlchemy 模型。
+
+!!! tip
+ SQLAlchemy 使用的“**模型**”这个术语 来指代与数据库交互的这些类和实例。
+
+ 而 Pydantic 也使用“模型”这个术语 来指代不同的东西，即数据验证、转换以及文档类和实例。
+
+从`database`（来自上面的`database.py`文件）导入`Base`。
+
+创建从它继承的类。
+
+这些类就是 SQLAlchemy 模型。
+
+```Python hl_lines="4 7-8 18-19"
+{!../../../docs_src/sql_databases/sql_app/models.py!}
+```
+
+这个`__tablename__`属性是用来告诉 SQLAlchemy 要在数据库中为每个模型使用的数据库表的名称。
+
+### 创建模型属性/列
+
+现在创建所有模型（类）属性。
+
+这些属性中的每一个都代表其相应数据库表中的一列。
+
+我们使用`Column`来表示 SQLAlchemy 中的默认值。
+
+我们传递一个 SQLAlchemy “类型”，如`Integer`、`String`和`Boolean`，它定义了数据库中的类型，作为参数。
+
+```Python hl_lines="1 10-13 21-24"
+{!../../../docs_src/sql_databases/sql_app/models.py!}
+```
+
+### 创建关系
+
+现在创建关系。
+
+为此，我们使用SQLAlchemy ORM提供的`relationship`。
+
+这将或多或少会成为一种“神奇”属性，其中表示该表与其他相关的表中的值。
+
+```Python hl_lines="2 15 26"
+{!../../../docs_src/sql_databases/sql_app/models.py!}
+```
+
+当访问 user 中的属性`items`时，如 中`my_user.items`，它将有一个`Item`SQLAlchemy 模型列表（来自`items`表），这些模型具有指向`users`表中此记录的外键。
+
+当您访问`my_user.items`时，SQLAlchemy 实际上会从`items`表中的获取一批记录并在此处填充进去。
+
+同样，当访问 Item中的属性`owner`时，它将包含表中的`User`SQLAlchemy 模型`users`。使用`owner_id`属性/列及其外键来了解要从`users`表中获取哪条记录。
+
+## 创建 Pydantic 模型
+
+现在让我们查看一下文件`sql_app/schemas.py`。
+
+!!! tip
+ 为了避免 SQLAlchemy*模型*和 Pydantic*模型*之间的混淆，我们将有`models.py`（SQLAlchemy 模型的文件）和`schemas.py`（ Pydantic 模型的文件）。
+
+ 这些 Pydantic 模型或多或少地定义了一个“schema”（一个有效的数据形状）。
+
+ 因此，这将帮助我们在使用两者时避免混淆。
+
+### 创建初始 Pydantic*模型*/模式
+
+创建一个`ItemBase`和`UserBase`Pydantic*模型*（或者我们说“schema”）以及在创建或读取数据时具有共同的属性。
+
+`ItemCreate`为 创建一个`UserCreate`继承自它们的所有属性（因此它们将具有相同的属性），以及创建所需的任何其他数据（属性）。
+
+因此在创建时也应当有一个`password`属性。
+
+但是为了安全起见，`password`不会出现在其他同类 Pydantic*模型*中，例如用户请求时不应该从 API 返回响应中包含它。
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="3 6-8 11-12 23-24 27-28"
+ {!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="3 6-8 11-12 23-24 27-28"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
+ ```
+
+=== "Python 3.10 及以上版本"
+
+ ```Python hl_lines="1 4-6 9-10 21-22 25-26"
+ {!> ../../../docs_src/sql_databases/sql_app_py310/schemas.py!}
+ ```
+
+#### SQLAlchemy 风格和 Pydantic 风格
+
+请注意，SQLAlchemy*模型*使用 `=`来定义属性，并将类型作为参数传递给`Column`，例如：
+
+```Python
+name = Column(String)
+```
+
+虽然 Pydantic*模型*使用`:` 声明类型，但新的类型注释语法/类型提示是：
+
+```Python
+name: str
+```
+
+请牢记这一点，这样您在使用`:`还是`=`时就不会感到困惑。
+
+### 创建用于读取/返回的Pydantic*模型/模式*
+
+现在创建当从 API 返回数据时、将在读取数据时使用的Pydantic*模型（schemas）。*
+
+例如，在创建一个项目之前，我们不知道分配给它的 ID 是什么，但是在读取它时（从 API 返回时）我们已经知道它的 ID。
+
+同样，当读取用户时，我们现在可以声明`items`，将包含属于该用户的项目。
+
+不仅是这些项目的 ID，还有我们在 Pydantic*模型*中定义的用于读取项目的所有数据：`Item`.
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="15-17 31-34"
+ {!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="15-17 31-34"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
+ ```
+
+=== "Python 3.10 及以上版本"
+
+ ```Python hl_lines="13-15 29-32"
+ {!> ../../../docs_src/sql_databases/sql_app_py310/schemas.py!}
+ ```
+
+!!! tip
+ 请注意，读取用户（从 API 返回）时将使用不包括`password`的`User` Pydantic*模型*。
+
+### 使用 Pydantic 的`orm_mode`
+
+现在，在用于查询的 Pydantic*模型*`Item`中`User`，添加一个内部`Config`类。
+
+此类[`Config`](https://pydantic-docs.helpmanual.io/usage/model_config/)用于为 Pydantic 提供配置。
+
+在`Config`类中，设置属性`orm_mode = True`。
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="15 19-20 31 36-37"
+ {!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="15 19-20 31 36-37"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
+ ```
+
+=== "Python 3.10 及以上版本"
+
+ ```Python hl_lines="13 17-18 29 34-35"
+ {!> ../../../docs_src/sql_databases/sql_app_py310/schemas.py!}
+ ```
+
+!!! tip
+ 请注意，它使用`=`分配一个值，例如：
+
+ `orm_mode = True`
+
+ 它不使用之前的`:`来类型声明。
+
+ 这是设置配置值，而不是声明类型。
+
+Pydantic`orm_mode`将告诉 Pydantic*模型*读取数据，即它不是一个`dict`，而是一个 ORM 模型（或任何其他具有属性的任意对象）。
+
+这样，而不是仅仅试图从`dict`上 `id` 中获取值，如下所示：
+
+```Python
+id = data["id"]
+```
+
+尝试从属性中获取它，如：
+
+```Python
+id = data.id
+```
+
+有了这个，Pydantic*模型*与 ORM 兼容，您只需在*路径操作*`response_model`的参数中声明它即可。
+
+您将能够返回一个数据库模型，它将从中读取数据。
+
+#### ORM 模式的技术细节
+
+SQLAlchemy 和许多其他默认情况下是“延迟加载”。
+
+这意味着，例如，除非您尝试访问包含该数据的属性，否则它们不会从数据库中获取关系数据。
+
+例如，访问属性`items`：
+
+```Python
+current_user.items
+```
+
+将使 SQLAlchemy 转到`items`表并获取该用户的项目，在调用`.items`之前不会去查询数据库。
+
+没有`orm_mode`，如果您从*路径操作*返回一个 SQLAlchemy 模型，它不会包含关系数据。
+
+即使您在 Pydantic 模型中声明了这些关系，也没有用处。
+
+但是在 ORM 模式下，由于 Pydantic 本身会尝试从属性访问它需要的数据（而不是假设为 `dict`），你可以声明你想要返回的特定数据，它甚至可以从 ORM 中获取它。
+
+## CRUD工具
+
+现在让我们看看文件`sql_app/crud.py`。
+
+在这个文件中，我们将编写可重用的函数用来与数据库中的数据进行交互。
+
+**CRUD**分别为：**增加**、**查询**、**更改**和**删除**，即增删改查。
+
+...虽然在这个例子中我们只是新增和查询。
+
+### 读取数据
+
+从 `sqlalchemy.orm`中导入`Session`，这将允许您声明`db`参数的类型，并在您的函数中进行更好的类型检查和完成。
+
+导入之前的`models`（SQLAlchemy 模型）和`schemas`（Pydantic*模型*/模式）。
+
+创建一些实用函数来完成：
+
+* 通过 ID 和电子邮件查询单个用户。
+* 查询多个用户。
+* 查询多个项目。
+
+```Python hl_lines="1 3 6-7 10-11 14-15 27-28"
+{!../../../docs_src/sql_databases/sql_app/crud.py!}
+```
+
+!!! tip
+ 通过创建仅专用于与数据库交互（获取用户或项目）的函数，独立于*路径操作函数*，您可以更轻松地在多个部分中重用它们，并为它们添加单元测试。
+
+### 创建数据
+
+现在创建实用程序函数来创建数据。
+
+它的步骤是：
+
+* 使用您的数据创建一个 SQLAlchemy 模型*实例。*
+* 使用`add`来将该实例对象添加到您的数据库。
+* 使用`commit`来对数据库的事务提交（以便保存它们）。
+* 使用`refresh`来刷新您的数据库实例（以便它包含来自数据库的任何新数据，例如生成的 ID）。
+
+```Python hl_lines="18-24 31-36"
+{!../../../docs_src/sql_databases/sql_app/crud.py!}
+```
+
+!!! tip
+ SQLAlchemy 模型`User`包含一个`hashed_password`，它应该是一个包含散列的安全密码。
+
+ 但由于 API 客户端提供的是原始密码，因此您需要将其提取并在应用程序中生成散列密码。
+
+ 然后将hashed_password参数与要保存的值一起传递。
+
+!!! warning
+ 此示例不安全，密码未经过哈希处理。
+
+ 在现实生活中的应用程序中，您需要对密码进行哈希处理，并且永远不要以明文形式保存它们。
+
+ 有关更多详细信息，请返回教程中的安全部分。
+
+ 在这里，我们只关注数据库的工具和机制。
+
+!!! tip
+ 这里不是将每个关键字参数传递给Item并从Pydantic模型中读取每个参数，而是先生成一个字典，其中包含Pydantic模型的数据：
+
+ `item.dict()`
+
+ 然后我们将dict的键值对 作为关键字参数传递给 SQLAlchemy `Item`：
+
+ `Item(**item.dict())`
+
+ 然后我们传递 Pydantic模型未提供的额外关键字参数`owner_id`：
+
+ `Item(**item.dict(), owner_id=user_id)`
+
+## 主**FastAPI**应用程序
+
+现在在`sql_app/main.py`文件中 让我们集成和使用我们之前创建的所有其他部分。
+
+### 创建数据库表
+
+以非常简单的方式创建数据库表：
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="9"
+ {!> ../../../docs_src/sql_databases/sql_app/main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="7"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
+ ```
+
+#### Alembic 注意
+
+通常你可能会使用 Alembic，来进行格式化数据库（创建表等）。
+
+而且您还可以将 Alembic 用于“迁移”（这是它的主要工作）。
+
+“迁移”是每当您更改 SQLAlchemy 模型的结构、添加新属性等以在数据库中复制这些更改、添加新列、新表等时所需的一组步骤。
+
+您可以在[Project Generation - Template](https://fastapi.tiangolo.com/zh/project-generation/)的模板中找到一个 FastAPI 项目中的 Alembic 示例。具体在[`alembic`代码目录中](https://github.com/tiangolo/full-stack-fastapi-postgresql/tree/master/%7B%7Bcookiecutter.project_slug%7D%7D/backend/app/alembic/)。
+
+### 创建依赖项
+
+现在使用我们在`sql_app/database.py`文件中创建的`SessionLocal`来创建依赖项。
+
+我们需要每个请求有一个独立的数据库会话/连接（`SessionLocal`），在所有请求中使用相同的会话，然后在请求完成后关闭它。
+
+然后将为下一个请求创建一个新会话。
+
+为此，我们将创建一个新的依赖项`yield`，正如前面关于[Dependencies with`yield`](https://fastapi.tiangolo.com/zh/tutorial/dependencies/dependencies-with-yield/)的部分中所解释的那样。
+
+我们的依赖项将创建一个新的 SQLAlchemy `SessionLocal`，它将在单个请求中使用，然后在请求完成后关闭它。
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="15-20"
+ {!> ../../../docs_src/sql_databases/sql_app/main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="13-18"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
+ ```
+
+!!! info
+ 我们将`SessionLocal()`请求的创建和处理放在一个`try`块中。
+
+ 然后我们在finally块中关闭它。
+
+ 通过这种方式，我们确保数据库会话在请求后始终关闭。即使在处理请求时出现异常。
+
+ 但是您不能从退出代码中引发另一个异常（在yield之后）。可以查阅 [Dependencies with yield and HTTPException](https://fastapi.tiangolo.com/zh/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-httpexception)
+
+*然后，当在路径操作函数*中使用依赖项时，我们使用`Session`，直接从 SQLAlchemy 导入的类型声明它。
+
+*这将为我们在路径操作函数*中提供更好的编辑器支持，因为编辑器将知道`db`参数的类型`Session`：
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="24 32 38 47 53"
+ {!> ../../../docs_src/sql_databases/sql_app/main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="22 30 36 45 51"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
+ ```
+
+!!! info "技术细节"
+ 参数`db`实际上是 type `SessionLocal`，但是这个类（用 创建`sessionmaker()`）是 SQLAlchemy 的“代理” `Session`，所以，编辑器并不真正知道提供了哪些方法。
+
+ 但是通过将类型声明为Session，编辑器现在可以知道可用的方法（.add()、.query()、.commit()等）并且可以提供更好的支持（比如完成）。类型声明不影响实际对象。
+
+### 创建您的**FastAPI** *路径操作*
+
+现在，到了最后，编写标准的**FastAPI** *路径操作*代码。
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="23-28 31-34 37-42 45-49 52-55"
+ {!> ../../../docs_src/sql_databases/sql_app/main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="21-26 29-32 35-40 43-47 50-53"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
+ ```
+
+我们在依赖项中的每个请求之前利用`yield`创建数据库会话，然后关闭它。
+
+所以我们就可以在*路径操作函数*中创建需要的依赖，就能直接获取会话。
+
+这样，我们就可以直接从*路径操作函数*内部调用`crud.get_user`并使用该会话，来进行对数据库操作。
+
+!!! tip
+ 请注意，您返回的值是 SQLAlchemy 模型或 SQLAlchemy 模型列表。
+
+ 但是由于所有路径操作的response_model都使用 Pydantic模型/使用orm_mode模式，因此您的 Pydantic 模型中声明的数据将从它们中提取并返回给客户端，并进行所有正常的过滤和验证。
+
+!!! tip
+ 另请注意，`response_models`应当是标准 Python 类型，例如`List[schemas.Item]`.
+
+ 但是由于它的内容/参数List是一个 使用orm_mode模式的Pydantic模型，所以数据将被正常检索并返回给客户端，所以没有问题。
+
+### 关于 `def` 对比 `async def`
+
+*在这里，我们在路径操作函数*和依赖项中都使用着 SQLAlchemy 模型，它将与外部数据库进行通信。
+
+这会需要一些“等待时间”。
+
+但是由于 SQLAlchemy 不具有`await`直接使用的兼容性，因此类似于：
+
+```Python
+user = await db.query(User).first()
+```
+
+...相反，我们可以使用：
+
+```Python
+user = db.query(User).first()
+```
+
+然后我们应该声明*路径操作函数*和不带 的依赖关系`async def`，只需使用普通的`def`，如下：
+
+```Python hl_lines="2"
+@app.get("/users/{user_id}", response_model=schemas.User)
+def read_user(user_id: int, db: Session = Depends(get_db)):
+ db_user = crud.get_user(db, user_id=user_id)
+ ...
+```
+
+!!! info
+ 如果您需要异步连接到关系数据库，请参阅[Async SQL (Relational) Databases](https://fastapi.tiangolo.com/zh/advanced/async-sql-databases/)
+
+!!! note "Very Technical Details"
+ 如果您很好奇并且拥有深厚的技术知识，您可以在[Async](https://fastapi.tiangolo.com/zh/async/#very-technical-details)文档中查看有关如何处理 `async def`于`def`差别的技术细节。
+
+## 迁移
+
+因为我们直接使用 SQLAlchemy，并且我们不需要任何类型的插件来使用**FastAPI**，所以我们可以直接将数据库迁移至[Alembic](https://alembic.sqlalchemy.org/)进行集成。
+
+由于与 SQLAlchemy 和 SQLAlchemy 模型相关的代码位于单独的独立文件中，您甚至可以使用 Alembic 执行迁移，而无需安装 FastAPI、Pydantic 或其他任何东西。
+
+同样，您将能够在与**FastAPI**无关的代码的其他部分中使用相同的 SQLAlchemy 模型和实用程序。
+
+例如，在具有[Celery](https://docs.celeryq.dev/)、[RQ](https://python-rq.org/)或[ARQ](https://arq-docs.helpmanual.io/)的后台任务工作者中。
+
+## 审查所有文件
+
+最后回顾整个案例，您应该有一个名为的目录`my_super_project`，其中包含一个名为`sql_app`。
+
+`sql_app`中应该有以下文件：
+
+* `sql_app/__init__.py`：这是一个空文件。
+
+* `sql_app/database.py`：
+
+```Python
+{!../../../docs_src/sql_databases/sql_app/database.py!}
+```
+
+* `sql_app/models.py`:
+
+```Python
+{!../../../docs_src/sql_databases/sql_app/models.py!}
+```
+
+* `sql_app/schemas.py`:
+
+=== "Python 3.6 及以上版本"
+
+ ```Python
+ {!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python
+ {!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
+ ```
+
+=== "Python 3.10 及以上版本"
+
+ ```Python
+ {!> ../../../docs_src/sql_databases/sql_app_py310/schemas.py!}
+ ```
+
+* `sql_app/crud.py`:
+
+```Python
+{!../../../docs_src/sql_databases/sql_app/crud.py!}
+```
+
+* `sql_app/main.py`:
+
+=== "Python 3.6 及以上版本"
+
+ ```Python
+ {!> ../../../docs_src/sql_databases/sql_app/main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python
+ {!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
+ ```
+
+## 执行项目
+
+您可以复制这些代码并按原样使用它。
+
+!!! info
+
+ 事实上，这里的代码只是大多数测试代码的一部分。
+
+你可以用 Uvicorn 运行它：
+
+
+
+
+```console
+$ uvicorn sql_app.main:app --reload
+
+INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+```
+
+
+
+打开浏览器进入 http://127.0.0.1:8000/docs。
+
+您将能够与您的**FastAPI**应用程序交互，从真实数据库中读取数据：
+
+
+
+## 直接与数据库交互
+
+如果您想独立于 FastAPI 直接浏览 SQLite 数据库（文件）以调试其内容、添加表、列、记录、修改数据等，您可以使用[SQLite 的 DB Browser](https://sqlitebrowser.org/)
+
+它看起来像这样：
+
+
+
+您还可以使用[SQLite Viewer](https://inloop.github.io/sqlite-viewer/)或[ExtendsClass](https://extendsclass.com/sqlite-browser.html)等在线 SQLite 浏览器。
+
+## 中间件替代数据库会话
+
+如果你不能使用依赖项`yield`——例如，如果你没有使用**Python 3.7**并且不能安装上面提到的**Python 3.6**的“backports” ——你可以在类似的“中间件”中设置会话方法。
+
+“中间件”基本功能是一个为每个请求执行的函数在请求之前进行执行相应的代码，以及在请求执行之后执行相应的代码。
+
+### 创建中间件
+
+我们将添加中间件（只是一个函数）将为每个请求创建一个新的 SQLAlchemy`SessionLocal`，将其添加到请求中，然后在请求完成后关闭它。
+
+=== "Python 3.6 及以上版本"
+
+ ```Python hl_lines="14-22"
+ {!> ../../../docs_src/sql_databases/sql_app/alt_main.py!}
+ ```
+
+=== "Python 3.9 及以上版本"
+
+ ```Python hl_lines="12-20"
+ {!> ../../../docs_src/sql_databases/sql_app_py39/alt_main.py!}
+ ```
+
+!!! info
+ 我们将`SessionLocal()`请求的创建和处理放在一个`try`块中。
+
+ 然后我们在finally块中关闭它。
+
+ 通过这种方式，我们确保数据库会话在请求后始终关闭，即使在处理请求时出现异常也会关闭。
+
+### 关于`request.state`
+
+`request.state`是每个`Request`对象的属性。它用于存储附加到请求本身的任意对象，例如本例中的数据库会话。您可以在[Starlette 的关于`Request`state](https://www.starlette.io/requests/#other-state)的文档中了解更多信息。
+
+对于这种情况下，它帮助我们确保在所有请求中使用单个数据库会话，然后关闭（在中间件中）。
+
+### 使用`yield`依赖项与使用中间件的区别
+
+在此处添加**中间件**与`yield`的依赖项的作用效果类似，但也有一些区别：
+
+* 中间件需要更多的代码并且更复杂一些。
+* 中间件必须是一个`async`函数。
+ * 如果其中有代码必须“等待”网络，它可能会在那里“阻止”您的应用程序并稍微降低性能。
+ * 尽管这里的`SQLAlchemy`工作方式可能不是很成问题。
+ * 但是，如果您向等待大量I/O的中间件添加更多代码，则可能会出现问题。
+* *每个*请求都会运行一个中间件。
+ * 将为每个请求创建一个连接。
+ * 即使处理该请求的*路径操作*不需要数据库。
+
+!!! tip
+ `tyield`当依赖项 足以满足用例时，使用`tyield`依赖项方法会更好。
+
+!!! info
+ `yield`的依赖项是最近刚加入**FastAPI**中的。
+
+ 所以本教程的先前版本只有带有中间件的示例，并且可能有多个应用程序使用中间件进行数据库会话管理。
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index ac8679dc0..f4c3c0ec1 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -89,6 +89,7 @@ nav:
- tutorial/body-updates.md
- 依赖项:
- tutorial/dependencies/index.md
+ - tutorial/dependencies/classes-as-dependencies.md
- tutorial/dependencies/sub-dependencies.md
- tutorial/dependencies/dependencies-in-path-operation-decorators.md
- tutorial/dependencies/global-dependencies.md
@@ -99,6 +100,7 @@ nav:
- tutorial/security/simple-oauth2.md
- tutorial/security/oauth2-jwt.md
- tutorial/cors.md
+ - tutorial/sql-databases.md
- tutorial/bigger-applications.md
- tutorial/metadata.md
- tutorial/debugging.md
@@ -109,6 +111,7 @@ nav:
- advanced/response-directly.md
- advanced/custom-response.md
- advanced/response-cookies.md
+ - advanced/wsgi.md
- contributing.md
- help-fastapi.md
- benchmarks.md
diff --git a/docs_src/security/tutorial005.py b/docs_src/security/tutorial005.py
index ab3af9a6a..bd0a33581 100644
--- a/docs_src/security/tutorial005.py
+++ b/docs_src/security/tutorial005.py
@@ -107,7 +107,7 @@ async def get_current_user(
if security_scopes.scopes:
authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
else:
- authenticate_value = f"Bearer"
+ authenticate_value = "Bearer"
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
diff --git a/docs_src/security/tutorial005_py310.py b/docs_src/security/tutorial005_py310.py
index c6a095d2c..ba756ef4f 100644
--- a/docs_src/security/tutorial005_py310.py
+++ b/docs_src/security/tutorial005_py310.py
@@ -106,7 +106,7 @@ async def get_current_user(
if security_scopes.scopes:
authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
else:
- authenticate_value = f"Bearer"
+ authenticate_value = "Bearer"
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
diff --git a/docs_src/security/tutorial005_py39.py b/docs_src/security/tutorial005_py39.py
index 38391308a..9e4dbcffb 100644
--- a/docs_src/security/tutorial005_py39.py
+++ b/docs_src/security/tutorial005_py39.py
@@ -107,7 +107,7 @@ async def get_current_user(
if security_scopes.scopes:
authenticate_value = f'Bearer scope="{security_scopes.scope_str}"'
else:
- authenticate_value = f"Bearer"
+ authenticate_value = "Bearer"
credentials_exception = HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Could not validate credentials",
diff --git a/docs_src/websockets/tutorial002.py b/docs_src/websockets/tutorial002.py
index cf5c7e805..cab749e4d 100644
--- a/docs_src/websockets/tutorial002.py
+++ b/docs_src/websockets/tutorial002.py
@@ -1,6 +1,14 @@
from typing import Union
-from fastapi import Cookie, Depends, FastAPI, Query, WebSocket, status
+from fastapi import (
+ Cookie,
+ Depends,
+ FastAPI,
+ Query,
+ WebSocket,
+ WebSocketException,
+ status,
+)
from fastapi.responses import HTMLResponse
app = FastAPI()
@@ -61,7 +69,7 @@ async def get_cookie_or_token(
token: Union[str, None] = Query(default=None),
):
if session is None and token is None:
- await websocket.close(code=status.WS_1008_POLICY_VIOLATION)
+ raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)
return session or token
diff --git a/fastapi/__init__.py b/fastapi/__init__.py
index 7ccb62563..037d9804b 100644
--- a/fastapi/__init__.py
+++ b/fastapi/__init__.py
@@ -1,6 +1,6 @@
"""FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
-__version__ = "0.85.1"
+__version__ = "0.88.0"
from starlette import status as status
@@ -8,6 +8,7 @@ from .applications import FastAPI as FastAPI
from .background import BackgroundTasks as BackgroundTasks
from .datastructures import UploadFile as UploadFile
from .exceptions import HTTPException as HTTPException
+from .exceptions import WebSocketException as WebSocketException
from .param_functions import Body as Body
from .param_functions import Cookie as Cookie
from .param_functions import Depends as Depends
diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py
index 83132262b..115723662 100644
--- a/fastapi/dependencies/utils.py
+++ b/fastapi/dependencies/utils.py
@@ -105,10 +105,10 @@ def check_file_field(field: ModelField) -> None:
assert parse_options_header
except ImportError:
logger.error(multipart_incorrect_install_error)
- raise RuntimeError(multipart_incorrect_install_error)
+ raise RuntimeError(multipart_incorrect_install_error) from None
except ImportError:
logger.error(multipart_not_installed_error)
- raise RuntimeError(multipart_not_installed_error)
+ raise RuntimeError(multipart_not_installed_error) from None
def get_param_sub_dependant(
@@ -450,21 +450,21 @@ def is_coroutine_callable(call: Callable[..., Any]) -> bool:
return inspect.iscoroutinefunction(call)
if inspect.isclass(call):
return False
- dunder_call = getattr(call, "__call__", None)
+ dunder_call = getattr(call, "__call__", None) # noqa: B004
return inspect.iscoroutinefunction(dunder_call)
def is_async_gen_callable(call: Callable[..., Any]) -> bool:
if inspect.isasyncgenfunction(call):
return True
- dunder_call = getattr(call, "__call__", None)
+ dunder_call = getattr(call, "__call__", None) # noqa: B004
return inspect.isasyncgenfunction(dunder_call)
def is_gen_callable(call: Callable[..., Any]) -> bool:
if inspect.isgeneratorfunction(call):
return True
- dunder_call = getattr(call, "__call__", None)
+ dunder_call = getattr(call, "__call__", None) # noqa: B004
return inspect.isgeneratorfunction(dunder_call)
@@ -748,14 +748,14 @@ def get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:
# in case a sub-dependency is evaluated with a single unique body field
# That is combined (embedded) with other body fields
for param in flat_dependant.body_params:
- setattr(param.field_info, "embed", True)
+ setattr(param.field_info, "embed", True) # noqa: B010
model_name = "Body_" + name
BodyModel: Type[BaseModel] = create_model(model_name)
for f in flat_dependant.body_params:
BodyModel.__fields__[f.name] = f
required = any(True for f in flat_dependant.body_params if f.required)
- BodyFieldInfo_kwargs: Dict[str, Any] = dict(default=None)
+ BodyFieldInfo_kwargs: Dict[str, Any] = {"default": None}
if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):
BodyFieldInfo: Type[params.Body] = params.File
elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):
@@ -764,7 +764,7 @@ def get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:
BodyFieldInfo = params.Body
body_param_media_types = [
- getattr(f.field_info, "media_type")
+ f.field_info.media_type
for f in flat_dependant.body_params
if isinstance(f.field_info, params.Body)
]
diff --git a/fastapi/encoders.py b/fastapi/encoders.py
index 6bde9f4ab..2f95bcbf6 100644
--- a/fastapi/encoders.py
+++ b/fastapi/encoders.py
@@ -157,7 +157,7 @@ def jsonable_encoder(
data = vars(obj)
except Exception as e:
errors.append(e)
- raise ValueError(errors)
+ raise ValueError(errors) from e
return jsonable_encoder(
data,
include=include,
diff --git a/fastapi/exceptions.py b/fastapi/exceptions.py
index 0f50acc6c..ca097b1ce 100644
--- a/fastapi/exceptions.py
+++ b/fastapi/exceptions.py
@@ -3,6 +3,7 @@ from typing import Any, Dict, Optional, Sequence, Type
from pydantic import BaseModel, ValidationError, create_model
from pydantic.error_wrappers import ErrorList
from starlette.exceptions import HTTPException as StarletteHTTPException
+from starlette.exceptions import WebSocketException as WebSocketException # noqa: F401
class HTTPException(StarletteHTTPException):
diff --git a/fastapi/routing.py b/fastapi/routing.py
index 7caf018b5..9a7d88efc 100644
--- a/fastapi/routing.py
+++ b/fastapi/routing.py
@@ -3,6 +3,7 @@ import dataclasses
import email.message
import inspect
import json
+from contextlib import AsyncExitStack
from enum import Enum, IntEnum
from typing import (
Any,
@@ -190,6 +191,9 @@ def get_request_handler(
if body_field:
if is_body_form:
body = await request.form()
+ stack = request.scope.get("fastapi_astack")
+ assert isinstance(stack, AsyncExitStack)
+ stack.push_async_callback(body.close)
else:
body_bytes = await request.body()
if body_bytes:
@@ -697,7 +701,7 @@ class APIRouter(routing.Router):
), "A path prefix must not end with '/', as the routes will start with '/'"
else:
for r in router.routes:
- path = getattr(r, "path")
+ path = getattr(r, "path") # noqa: B009
name = getattr(r, "name", "unknown")
if path is not None and not path:
raise Exception(
diff --git a/fastapi/security/api_key.py b/fastapi/security/api_key.py
index bca5c721a..24ddbf482 100644
--- a/fastapi/security/api_key.py
+++ b/fastapi/security/api_key.py
@@ -54,7 +54,7 @@ class APIKeyHeader(APIKeyBase):
self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
- api_key: str = request.headers.get(self.model.name)
+ api_key = request.headers.get(self.model.name)
if not api_key:
if self.auto_error:
raise HTTPException(
diff --git a/fastapi/security/http.py b/fastapi/security/http.py
index 1b473c69e..8b677299d 100644
--- a/fastapi/security/http.py
+++ b/fastapi/security/http.py
@@ -38,7 +38,7 @@ class HTTPBase(SecurityBase):
async def __call__(
self, request: Request
) -> Optional[HTTPAuthorizationCredentials]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
@@ -67,7 +67,7 @@ class HTTPBasic(HTTPBase):
async def __call__( # type: ignore
self, request: Request
) -> Optional[HTTPBasicCredentials]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, param = get_authorization_scheme_param(authorization)
if self.realm:
unauthorized_headers = {"WWW-Authenticate": f'Basic realm="{self.realm}"'}
@@ -113,7 +113,7 @@ class HTTPBearer(HTTPBase):
async def __call__(
self, request: Request
) -> Optional[HTTPAuthorizationCredentials]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
@@ -148,7 +148,7 @@ class HTTPDigest(HTTPBase):
async def __call__(
self, request: Request
) -> Optional[HTTPAuthorizationCredentials]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, credentials = get_authorization_scheme_param(authorization)
if not (authorization and scheme and credentials):
if self.auto_error:
diff --git a/fastapi/security/oauth2.py b/fastapi/security/oauth2.py
index 653c3010e..eb6b4277c 100644
--- a/fastapi/security/oauth2.py
+++ b/fastapi/security/oauth2.py
@@ -126,7 +126,7 @@ class OAuth2(SecurityBase):
self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
if not authorization:
if self.auto_error:
raise HTTPException(
@@ -157,7 +157,7 @@ class OAuth2PasswordBearer(OAuth2):
)
async def __call__(self, request: Request) -> Optional[str]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, param = get_authorization_scheme_param(authorization)
if not authorization or scheme.lower() != "bearer":
if self.auto_error:
@@ -200,7 +200,7 @@ class OAuth2AuthorizationCodeBearer(OAuth2):
)
async def __call__(self, request: Request) -> Optional[str]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
scheme, param = get_authorization_scheme_param(authorization)
if not authorization or scheme.lower() != "bearer":
if self.auto_error:
diff --git a/fastapi/security/open_id_connect_url.py b/fastapi/security/open_id_connect_url.py
index dfe9f7b25..393614f7c 100644
--- a/fastapi/security/open_id_connect_url.py
+++ b/fastapi/security/open_id_connect_url.py
@@ -23,7 +23,7 @@ class OpenIdConnect(SecurityBase):
self.auto_error = auto_error
async def __call__(self, request: Request) -> Optional[str]:
- authorization: str = request.headers.get("Authorization")
+ authorization = request.headers.get("Authorization")
if not authorization:
if self.auto_error:
raise HTTPException(
diff --git a/fastapi/security/utils.py b/fastapi/security/utils.py
index 2da0dd20f..fa7a450b7 100644
--- a/fastapi/security/utils.py
+++ b/fastapi/security/utils.py
@@ -1,7 +1,9 @@
-from typing import Tuple
+from typing import Optional, Tuple
-def get_authorization_scheme_param(authorization_header_value: str) -> Tuple[str, str]:
+def get_authorization_scheme_param(
+ authorization_header_value: Optional[str],
+) -> Tuple[str, str]:
if not authorization_header_value:
return "", ""
scheme, _, param = authorization_header_value.partition(" ")
diff --git a/fastapi/utils.py b/fastapi/utils.py
index b94dacecc..b15f6a2cf 100644
--- a/fastapi/utils.py
+++ b/fastapi/utils.py
@@ -89,7 +89,7 @@ def create_response_field(
except RuntimeError:
raise fastapi.exceptions.FastAPIError(
f"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type"
- )
+ ) from None
def create_cloned_field(
diff --git a/pyproject.toml b/pyproject.toml
index c76538c17..be3080ae8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -34,11 +34,12 @@ classifiers = [
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
"Topic :: Internet :: WWW/HTTP :: HTTP Servers",
"Topic :: Internet :: WWW/HTTP",
]
dependencies = [
- "starlette==0.20.4",
+ "starlette==0.22.0",
"pydantic >=1.6.2,!=1.7,!=1.7.1,!=1.7.2,!=1.7.3,!=1.8,!=1.8.1,<2.0.0",
]
dynamic = ["version"]
@@ -50,12 +51,11 @@ Documentation = "https://fastapi.tiangolo.com/"
[project.optional-dependencies]
test = [
"pytest >=7.1.3,<8.0.0",
- "pytest-cov >=2.12.0,<4.0.0",
- "mypy ==0.971",
- "flake8 >=3.8.3,<6.0.0",
- "black == 22.8.0",
+ "coverage[toml] >= 6.5.0,<7.0",
+ "mypy ==0.982",
+ "ruff ==0.0.138",
+ "black == 22.10.0",
"isort >=5.0.6,<6.0.0",
- "requests >=2.24.0,<3.0.0",
"httpx >=0.23.0,<0.24.0",
"email_validator >=1.1.1,<2.0.0",
# TODO: once removing databases from tutorial, upgrade SQLAlchemy
@@ -73,7 +73,7 @@ test = [
"passlib[bcrypt] >=1.7.2,<2.0.0",
# types
- "types-ujson ==5.4.0",
+ "types-ujson ==5.5.0",
"types-orjson ==3.6.2",
]
doc = [
@@ -83,25 +83,24 @@ doc = [
"mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0",
# TODO: upgrade and enable typer-cli once it supports Click 8.x.x
# "typer-cli >=0.0.12,<0.0.13",
- "typer[all] >=0.6.1,<0.7.0",
+ "typer[all] >=0.6.1,<0.8.0",
"pyyaml >=5.3.1,<7.0.0",
]
dev = [
- "autoflake >=1.4.0,<2.0.0",
- "flake8 >=3.8.3,<6.0.0",
+ "ruff ==0.0.138",
"uvicorn[standard] >=0.12.0,<0.19.0",
"pre-commit >=2.17.0,<3.0.0",
]
all = [
- "requests >=2.24.0,<3.0.0",
- "jinja2 >=2.11.2,<4.0.0",
- "python-multipart >=0.0.5,<0.0.6",
- "itsdangerous >=1.1.0,<3.0.0",
- "pyyaml >=5.3.1,<7.0.0",
- "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,<6.0.0",
- "orjson >=3.2.1,<4.0.0",
- "email_validator >=1.1.1,<2.0.0",
- "uvicorn[standard] >=0.12.0,<0.19.0",
+ "httpx >=0.23.0",
+ "jinja2 >=2.11.2",
+ "python-multipart >=0.0.5",
+ "itsdangerous >=1.1.0",
+ "pyyaml >=5.3.1",
+ "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0",
+ "orjson >=3.2.1",
+ "email_validator >=1.1.1",
+ "uvicorn[standard] >=0.12.0",
]
[tool.hatch.version]
@@ -136,9 +135,52 @@ filterwarnings = [
# TODO: needed by asyncio in Python 3.9.7 https://bugs.python.org/issue45097, try to remove on 3.9.8
'ignore:The loop argument is deprecated since Python 3\.8, and scheduled for removal in Python 3\.10:DeprecationWarning:asyncio',
'ignore:starlette.middleware.wsgi is deprecated and will be removed in a future release\..*:DeprecationWarning:starlette',
+ # TODO: remove after upgrading HTTPX to a version newer than 0.23.0
+ # Including PR: https://github.com/encode/httpx/pull/2309
+ "ignore:'cgi' is deprecated:DeprecationWarning",
+ # For passlib
+ "ignore:'crypt' is deprecated and slated for removal in Python 3.13:DeprecationWarning",
# see https://trio.readthedocs.io/en/stable/history.html#trio-0-22-0-2022-09-28
"ignore:You seem to already have a custom.*:RuntimeWarning:trio",
"ignore::trio.TrioDeprecationWarning",
# TODO remove pytest-cov
'ignore::pytest.PytestDeprecationWarning:pytest_cov',
]
+
+[tool.coverage.run]
+parallel = true
+source = [
+ "docs_src",
+ "tests",
+ "fastapi"
+]
+context = '${CONTEXT}'
+
+[tool.ruff]
+select = [
+ "E", # pycodestyle errors
+ "W", # pycodestyle warnings
+ "F", # pyflakes
+ # "I", # isort
+ "C", # flake8-comprehensions
+ "B", # flake8-bugbear
+]
+ignore = [
+ "E501", # line too long, handled by black
+ "B008", # do not perform function calls in argument defaults
+ "C901", # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+"docs_src/dependencies/tutorial007.py" = ["F821"]
+"docs_src/dependencies/tutorial008.py" = ["F821"]
+"docs_src/dependencies/tutorial009.py" = ["F821"]
+"docs_src/dependencies/tutorial010.py" = ["F821"]
+"docs_src/custom_response/tutorial007.py" = ["B007"]
+"docs_src/dataclasses/tutorial003.py" = ["I001"]
+"docs_src/path_operation_advanced_configuration/tutorial007.py" = ["B904"]
+"docs_src/custom_request_and_route/tutorial002.py" = ["B904"]
+
+[tool.ruff.isort]
+known-third-party = ["fastapi", "pydantic", "starlette"]
diff --git a/scripts/docs.py b/scripts/docs.py
index d5fbacf59..e0953b8ed 100644
--- a/scripts/docs.py
+++ b/scripts/docs.py
@@ -284,7 +284,9 @@ def build_all():
continue
langs.append(lang.name)
cpu_count = os.cpu_count() or 1
- with Pool(cpu_count * 2) as p:
+ process_pool_size = cpu_count * 4
+ typer.echo(f"Using process pool size: {process_pool_size}")
+ with Pool(process_pool_size) as p:
p.map(build_lang, langs)
@@ -332,7 +334,7 @@ def serve():
os.chdir("site")
server_address = ("", 8008)
server = HTTPServer(server_address, SimpleHTTPRequestHandler)
- typer.echo(f"Serving at: http://127.0.0.1:8008")
+ typer.echo("Serving at: http://127.0.0.1:8008")
server.serve_forever()
@@ -420,7 +422,7 @@ def get_file_to_nav_map(nav: list) -> Dict[str, Tuple[str, ...]]:
file_to_nav = {}
for item in nav:
if type(item) is str:
- file_to_nav[item] = tuple()
+ file_to_nav[item] = ()
elif type(item) is dict:
item_key = list(item.keys())[0]
sub_nav = item[item_key]
diff --git a/scripts/format.sh b/scripts/format.sh
index ee4fbf1a5..3ac1fead8 100755
--- a/scripts/format.sh
+++ b/scripts/format.sh
@@ -1,6 +1,6 @@
#!/bin/sh -e
set -x
-autoflake --remove-all-unused-imports --recursive --remove-unused-variables --in-place docs_src fastapi tests scripts --exclude=__init__.py
+ruff fastapi tests docs_src scripts --fix
black fastapi tests docs_src scripts
isort fastapi tests docs_src scripts
diff --git a/scripts/lint.sh b/scripts/lint.sh
index 2e2072cf1..0feb973a8 100755
--- a/scripts/lint.sh
+++ b/scripts/lint.sh
@@ -4,6 +4,6 @@ set -e
set -x
mypy fastapi
-flake8 fastapi tests
+ruff fastapi tests docs_src scripts
black fastapi tests --check
isort fastapi tests docs_src scripts --check-only
diff --git a/scripts/test-cov-html.sh b/scripts/test-cov-html.sh
index 7957277fc..d1bdfced2 100755
--- a/scripts/test-cov-html.sh
+++ b/scripts/test-cov-html.sh
@@ -3,4 +3,7 @@
set -e
set -x
-bash scripts/test.sh --cov-report=html ${@}
+bash scripts/test.sh ${@}
+coverage combine
+coverage report --show-missing
+coverage html
diff --git a/scripts/test.sh b/scripts/test.sh
index d445ca174..62449ea41 100755
--- a/scripts/test.sh
+++ b/scripts/test.sh
@@ -6,4 +6,4 @@ set -x
# Check README.md is up to date
python ./scripts/docs.py verify-readme
export PYTHONPATH=./docs_src
-pytest --cov=fastapi --cov=tests --cov=docs_src --cov-report=term-missing:skip-covered --cov-report=xml tests ${@}
+coverage run -m pytest tests ${@}
diff --git a/scripts/zip-docs.sh b/scripts/zip-docs.sh
index f2b7ba3be..69315f5dd 100644
--- a/scripts/zip-docs.sh
+++ b/scripts/zip-docs.sh
@@ -3,7 +3,9 @@
set -x
set -e
+cd ./site
+
if [ -f docs.zip ]; then
rm -rf docs.zip
fi
-zip -r docs.zip ./site
+zip -r docs.zip ./
diff --git a/tests/test_custom_route_class.py b/tests/test_custom_route_class.py
index 1a9ea7199..2e8d9c6de 100644
--- a/tests/test_custom_route_class.py
+++ b/tests/test_custom_route_class.py
@@ -110,6 +110,6 @@ def test_route_classes():
for r in app.router.routes:
assert isinstance(r, Route)
routes[r.path] = r
- assert getattr(routes["/a/"], "x_type") == "A"
- assert getattr(routes["/a/b/"], "x_type") == "B"
- assert getattr(routes["/a/b/c/"], "x_type") == "C"
+ assert getattr(routes["/a/"], "x_type") == "A" # noqa: B009
+ assert getattr(routes["/a/b/"], "x_type") == "B" # noqa: B009
+ assert getattr(routes["/a/b/c/"], "x_type") == "C" # noqa: B009
diff --git a/tests/test_datastructures.py b/tests/test_datastructures.py
index 43f1a116c..2e6217d34 100644
--- a/tests/test_datastructures.py
+++ b/tests/test_datastructures.py
@@ -1,6 +1,10 @@
+from pathlib import Path
+from typing import List
+
import pytest
-from fastapi import UploadFile
+from fastapi import FastAPI, UploadFile
from fastapi.datastructures import Default
+from fastapi.testclient import TestClient
def test_upload_file_invalid():
@@ -20,3 +24,25 @@ def test_default_placeholder_bool():
placeholder_b = Default("")
assert placeholder_a
assert not placeholder_b
+
+
+def test_upload_file_is_closed(tmp_path: Path):
+ path = tmp_path / "test.txt"
+ path.write_bytes(b"")
+ app = FastAPI()
+
+ testing_file_store: List[UploadFile] = []
+
+ @app.post("/uploadfile/")
+ def create_upload_file(file: UploadFile):
+ testing_file_store.append(file)
+ return {"filename": file.filename}
+
+ client = TestClient(app)
+ with path.open("rb") as file:
+ response = client.post("/uploadfile/", files={"file": file})
+ assert response.status_code == 200, response.text
+ assert response.json() == {"filename": "test.txt"}
+
+ assert testing_file_store
+ assert testing_file_store[0].file.closed
diff --git a/tests/test_enforce_once_required_parameter.py b/tests/test_enforce_once_required_parameter.py
index ba8c7353f..bf05aa585 100644
--- a/tests/test_enforce_once_required_parameter.py
+++ b/tests/test_enforce_once_required_parameter.py
@@ -101,7 +101,7 @@ def test_schema():
def test_get_invalid():
- response = client.get("/foo", params={"client_id": None})
+ response = client.get("/foo")
assert response.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY
diff --git a/tests/test_extra_routes.py b/tests/test_extra_routes.py
index 491ba61c6..e979628a5 100644
--- a/tests/test_extra_routes.py
+++ b/tests/test_extra_routes.py
@@ -333,7 +333,7 @@ def test_get_api_route_not_decorated():
def test_delete():
- response = client.delete("/items/foo", json={"name": "Foo"})
+ response = client.request("DELETE", "/items/foo", json={"name": "Foo"})
assert response.status_code == 200, response.text
assert response.json() == {"item_id": "foo", "item": {"name": "Foo", "price": None}}
diff --git a/tests/test_get_request_body.py b/tests/test_get_request_body.py
index 88b9d839f..52a052faa 100644
--- a/tests/test_get_request_body.py
+++ b/tests/test_get_request_body.py
@@ -104,5 +104,5 @@ def test_openapi_schema():
def test_get_with_body():
body = {"name": "Foo", "description": "Some description", "price": 5.5}
- response = client.get("/product", json=body)
+ response = client.request("GET", "/product", json=body)
assert response.json() == body
diff --git a/tests/test_param_include_in_schema.py b/tests/test_param_include_in_schema.py
index 214f039b6..cb182a1cd 100644
--- a/tests/test_param_include_in_schema.py
+++ b/tests/test_param_include_in_schema.py
@@ -33,8 +33,6 @@ async def hidden_query(
return {"hidden_query": hidden_query}
-client = TestClient(app)
-
openapi_shema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
@@ -161,6 +159,7 @@ openapi_shema = {
def test_openapi_schema():
+ client = TestClient(app)
response = client.get("/openapi.json")
assert response.status_code == 200
assert response.json() == openapi_shema
@@ -184,7 +183,8 @@ def test_openapi_schema():
],
)
def test_hidden_cookie(path, cookies, expected_status, expected_response):
- response = client.get(path, cookies=cookies)
+ client = TestClient(app, cookies=cookies)
+ response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response
@@ -207,12 +207,14 @@ def test_hidden_cookie(path, cookies, expected_status, expected_response):
],
)
def test_hidden_header(path, headers, expected_status, expected_response):
+ client = TestClient(app)
response = client.get(path, headers=headers)
assert response.status_code == expected_status
assert response.json() == expected_response
def test_hidden_path():
+ client = TestClient(app)
response = client.get("/hidden_path/hidden_path")
assert response.status_code == 200
assert response.json() == {"hidden_path": "hidden_path"}
@@ -234,6 +236,7 @@ def test_hidden_path():
],
)
def test_hidden_query(path, expected_status, expected_response):
+ client = TestClient(app)
response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response
diff --git a/tests/test_security_api_key_cookie.py b/tests/test_security_api_key_cookie.py
index a5b2e44f0..0bf4e9bb3 100644
--- a/tests/test_security_api_key_cookie.py
+++ b/tests/test_security_api_key_cookie.py
@@ -22,8 +22,6 @@ def read_current_user(current_user: User = Depends(get_current_user)):
return current_user
-client = TestClient(app)
-
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
@@ -51,18 +49,21 @@ openapi_schema = {
def test_openapi_schema():
+ client = TestClient(app)
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == openapi_schema
def test_security_api_key():
- response = client.get("/users/me", cookies={"key": "secret"})
+ client = TestClient(app, cookies={"key": "secret"})
+ response = client.get("/users/me")
assert response.status_code == 200, response.text
assert response.json() == {"username": "secret"}
def test_security_api_key_no_key():
+ client = TestClient(app)
response = client.get("/users/me")
assert response.status_code == 403, response.text
assert response.json() == {"detail": "Not authenticated"}
diff --git a/tests/test_security_api_key_cookie_description.py b/tests/test_security_api_key_cookie_description.py
index 2cd3565b4..ed4e65239 100644
--- a/tests/test_security_api_key_cookie_description.py
+++ b/tests/test_security_api_key_cookie_description.py
@@ -22,8 +22,6 @@ def read_current_user(current_user: User = Depends(get_current_user)):
return current_user
-client = TestClient(app)
-
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
@@ -56,18 +54,21 @@ openapi_schema = {
def test_openapi_schema():
+ client = TestClient(app)
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == openapi_schema
def test_security_api_key():
- response = client.get("/users/me", cookies={"key": "secret"})
+ client = TestClient(app, cookies={"key": "secret"})
+ response = client.get("/users/me")
assert response.status_code == 200, response.text
assert response.json() == {"username": "secret"}
def test_security_api_key_no_key():
+ client = TestClient(app)
response = client.get("/users/me")
assert response.status_code == 403, response.text
assert response.json() == {"detail": "Not authenticated"}
diff --git a/tests/test_security_api_key_cookie_optional.py b/tests/test_security_api_key_cookie_optional.py
index 96a64f09a..3e7aa81c0 100644
--- a/tests/test_security_api_key_cookie_optional.py
+++ b/tests/test_security_api_key_cookie_optional.py
@@ -29,8 +29,6 @@ def read_current_user(current_user: User = Depends(get_current_user)):
return current_user
-client = TestClient(app)
-
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
@@ -58,18 +56,21 @@ openapi_schema = {
def test_openapi_schema():
+ client = TestClient(app)
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == openapi_schema
def test_security_api_key():
- response = client.get("/users/me", cookies={"key": "secret"})
+ client = TestClient(app, cookies={"key": "secret"})
+ response = client.get("/users/me")
assert response.status_code == 200, response.text
assert response.json() == {"username": "secret"}
def test_security_api_key_no_key():
+ client = TestClient(app)
response = client.get("/users/me")
assert response.status_code == 200, response.text
assert response.json() == {"msg": "Create an account first"}
diff --git a/tests/test_security_http_basic_optional.py b/tests/test_security_http_basic_optional.py
index 289bd5c74..91824d223 100644
--- a/tests/test_security_http_basic_optional.py
+++ b/tests/test_security_http_basic_optional.py
@@ -4,7 +4,6 @@ from typing import Optional
from fastapi import FastAPI, Security
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi.testclient import TestClient
-from requests.auth import HTTPBasicAuth
app = FastAPI()
@@ -51,8 +50,7 @@ def test_openapi_schema():
def test_security_http_basic():
- auth = HTTPBasicAuth(username="john", password="secret")
- response = client.get("/users/me", auth=auth)
+ response = client.get("/users/me", auth=("john", "secret"))
assert response.status_code == 200, response.text
assert response.json() == {"username": "john", "password": "secret"}
diff --git a/tests/test_security_http_basic_realm.py b/tests/test_security_http_basic_realm.py
index 54867c2e0..6d760c0f9 100644
--- a/tests/test_security_http_basic_realm.py
+++ b/tests/test_security_http_basic_realm.py
@@ -3,7 +3,6 @@ from base64 import b64encode
from fastapi import FastAPI, Security
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi.testclient import TestClient
-from requests.auth import HTTPBasicAuth
app = FastAPI()
@@ -48,8 +47,7 @@ def test_openapi_schema():
def test_security_http_basic():
- auth = HTTPBasicAuth(username="john", password="secret")
- response = client.get("/users/me", auth=auth)
+ response = client.get("/users/me", auth=("john", "secret"))
assert response.status_code == 200, response.text
assert response.json() == {"username": "john", "password": "secret"}
diff --git a/tests/test_security_http_basic_realm_description.py b/tests/test_security_http_basic_realm_description.py
index 6ff9d9d07..7cc547561 100644
--- a/tests/test_security_http_basic_realm_description.py
+++ b/tests/test_security_http_basic_realm_description.py
@@ -3,7 +3,6 @@ from base64 import b64encode
from fastapi import FastAPI, Security
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi.testclient import TestClient
-from requests.auth import HTTPBasicAuth
app = FastAPI()
@@ -54,8 +53,7 @@ def test_openapi_schema():
def test_security_http_basic():
- auth = HTTPBasicAuth(username="john", password="secret")
- response = client.get("/users/me", auth=auth)
+ response = client.get("/users/me", auth=("john", "secret"))
assert response.status_code == 200, response.text
assert response.json() == {"username": "john", "password": "secret"}
diff --git a/tests/test_starlette_exception.py b/tests/test_starlette_exception.py
index 2b6712f7b..418ddff7d 100644
--- a/tests/test_starlette_exception.py
+++ b/tests/test_starlette_exception.py
@@ -47,10 +47,10 @@ openapi_schema = {
"responses": {
"200": {
"content": {"application/json": {"schema": {}}},
- "description": "Successful " "Response",
+ "description": "Successful Response",
}
},
- "summary": "No Body " "Status " "Code " "Exception",
+ "summary": "No Body Status Code Exception",
}
},
"/http-no-body-statuscode-with-detail-exception": {
@@ -59,7 +59,7 @@ openapi_schema = {
"responses": {
"200": {
"content": {"application/json": {"schema": {}}},
- "description": "Successful " "Response",
+ "description": "Successful Response",
}
},
"summary": "No Body Status Code With Detail Exception",
diff --git a/tests/test_starlette_urlconvertors.py b/tests/test_starlette_urlconvertors.py
index 5a980cbf6..5ef1b819c 100644
--- a/tests/test_starlette_urlconvertors.py
+++ b/tests/test_starlette_urlconvertors.py
@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Path
+from fastapi import FastAPI, Path, Query
from fastapi.testclient import TestClient
app = FastAPI()
@@ -19,6 +19,11 @@ def path_convertor(param: str = Path()):
return {"path": param}
+@app.get("/query/")
+def query_convertor(param: str = Query()):
+ return {"query": param}
+
+
client = TestClient(app)
@@ -45,6 +50,13 @@ def test_route_converters_path():
assert response.json() == {"path": "some/example"}
+def test_route_converters_query():
+ # Test query conversion
+ response = client.get("/query", params={"param": "Qué tal!"})
+ assert response.status_code == 200, response.text
+ assert response.json() == {"query": "Qué tal!"}
+
+
def test_url_path_for_path_convertor():
assert (
app.url_path_for("path_convertor", param="some/example") == "/path/some/example"
diff --git a/tests/test_tuples.py b/tests/test_tuples.py
index 18ec2d048..6e2cc0db6 100644
--- a/tests/test_tuples.py
+++ b/tests/test_tuples.py
@@ -252,16 +252,14 @@ def test_tuple_with_model_invalid():
def test_tuple_form_valid():
- response = client.post("/tuple-form/", data=[("values", "1"), ("values", "2")])
+ response = client.post("/tuple-form/", data={"values": ("1", "2")})
assert response.status_code == 200, response.text
assert response.json() == [1, 2]
def test_tuple_form_invalid():
- response = client.post(
- "/tuple-form/", data=[("values", "1"), ("values", "2"), ("values", "3")]
- )
+ response = client.post("/tuple-form/", data={"values": ("1", "2", "3")})
assert response.status_code == 422, response.text
- response = client.post("/tuple-form/", data=[("values", "1")])
+ response = client.post("/tuple-form/", data={"values": ("1")})
assert response.status_code == 422, response.text
diff --git a/tests/test_tutorial/test_advanced_middleware/test_tutorial001.py b/tests/test_tutorial/test_advanced_middleware/test_tutorial001.py
index 17165c0fc..157fa5caf 100644
--- a/tests/test_tutorial/test_advanced_middleware/test_tutorial001.py
+++ b/tests/test_tutorial/test_advanced_middleware/test_tutorial001.py
@@ -9,6 +9,6 @@ def test_middleware():
assert response.status_code == 200, response.text
client = TestClient(app)
- response = client.get("/", allow_redirects=False)
+ response = client.get("/", follow_redirects=False)
assert response.status_code == 307, response.text
assert response.headers["location"] == "https://testserver/"
diff --git a/tests/test_tutorial/test_body/test_tutorial001.py b/tests/test_tutorial/test_body/test_tutorial001.py
index 8dbaf15db..65cdc758a 100644
--- a/tests/test_tutorial/test_body/test_tutorial001.py
+++ b/tests/test_tutorial/test_body/test_tutorial001.py
@@ -176,7 +176,7 @@ def test_post_broken_body():
response = client.post(
"/items/",
headers={"content-type": "application/json"},
- data="{some broken json}",
+ content="{some broken json}",
)
assert response.status_code == 422, response.text
assert response.json() == {
@@ -214,7 +214,7 @@ def test_post_form_for_json():
def test_explicit_content_type():
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
headers={"Content-Type": "application/json"},
)
assert response.status_code == 200, response.text
@@ -223,7 +223,7 @@ def test_explicit_content_type():
def test_geo_json():
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
headers={"Content-Type": "application/geo+json"},
)
assert response.status_code == 200, response.text
@@ -232,7 +232,7 @@ def test_geo_json():
def test_no_content_type_is_json():
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
)
assert response.status_code == 200, response.text
assert response.json() == {
@@ -255,17 +255,19 @@ def test_wrong_headers():
]
}
- response = client.post("/items/", data=data, headers={"Content-Type": "text/plain"})
+ response = client.post(
+ "/items/", content=data, headers={"Content-Type": "text/plain"}
+ )
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
response = client.post(
- "/items/", data=data, headers={"Content-Type": "application/geo+json-seq"}
+ "/items/", content=data, headers={"Content-Type": "application/geo+json-seq"}
)
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
response = client.post(
- "/items/", data=data, headers={"Content-Type": "application/not-really-json"}
+ "/items/", content=data, headers={"Content-Type": "application/not-really-json"}
)
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
diff --git a/tests/test_tutorial/test_body/test_tutorial001_py310.py b/tests/test_tutorial/test_body/test_tutorial001_py310.py
index dd9d9911e..83bcb68f3 100644
--- a/tests/test_tutorial/test_body/test_tutorial001_py310.py
+++ b/tests/test_tutorial/test_body/test_tutorial001_py310.py
@@ -185,7 +185,7 @@ def test_post_broken_body(client: TestClient):
response = client.post(
"/items/",
headers={"content-type": "application/json"},
- data="{some broken json}",
+ content="{some broken json}",
)
assert response.status_code == 422, response.text
assert response.json() == {
@@ -225,7 +225,7 @@ def test_post_form_for_json(client: TestClient):
def test_explicit_content_type(client: TestClient):
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
headers={"Content-Type": "application/json"},
)
assert response.status_code == 200, response.text
@@ -235,7 +235,7 @@ def test_explicit_content_type(client: TestClient):
def test_geo_json(client: TestClient):
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
headers={"Content-Type": "application/geo+json"},
)
assert response.status_code == 200, response.text
@@ -245,7 +245,7 @@ def test_geo_json(client: TestClient):
def test_no_content_type_is_json(client: TestClient):
response = client.post(
"/items/",
- data='{"name": "Foo", "price": 50.5}',
+ content='{"name": "Foo", "price": 50.5}',
)
assert response.status_code == 200, response.text
assert response.json() == {
@@ -269,17 +269,19 @@ def test_wrong_headers(client: TestClient):
]
}
- response = client.post("/items/", data=data, headers={"Content-Type": "text/plain"})
+ response = client.post(
+ "/items/", content=data, headers={"Content-Type": "text/plain"}
+ )
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
response = client.post(
- "/items/", data=data, headers={"Content-Type": "application/geo+json-seq"}
+ "/items/", content=data, headers={"Content-Type": "application/geo+json-seq"}
)
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
response = client.post(
- "/items/", data=data, headers={"Content-Type": "application/not-really-json"}
+ "/items/", content=data, headers={"Content-Type": "application/not-really-json"}
)
assert response.status_code == 422, response.text
assert response.json() == invalid_dict
diff --git a/tests/test_tutorial/test_cookie_params/test_tutorial001.py b/tests/test_tutorial/test_cookie_params/test_tutorial001.py
index edccffec1..38ae211db 100644
--- a/tests/test_tutorial/test_cookie_params/test_tutorial001.py
+++ b/tests/test_tutorial/test_cookie_params/test_tutorial001.py
@@ -3,8 +3,6 @@ from fastapi.testclient import TestClient
from docs_src.cookie_params.tutorial001 import app
-client = TestClient(app)
-
openapi_schema = {
"openapi": "3.0.2",
"info": {"title": "FastAPI", "version": "0.1.0"},
@@ -88,6 +86,7 @@ openapi_schema = {
],
)
def test(path, cookies, expected_status, expected_response):
- response = client.get(path, cookies=cookies)
+ client = TestClient(app, cookies=cookies)
+ response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response
diff --git a/tests/test_tutorial/test_cookie_params/test_tutorial001_py310.py b/tests/test_tutorial/test_cookie_params/test_tutorial001_py310.py
index 5caa5c440..5ad52fb5e 100644
--- a/tests/test_tutorial/test_cookie_params/test_tutorial001_py310.py
+++ b/tests/test_tutorial/test_cookie_params/test_tutorial001_py310.py
@@ -70,14 +70,6 @@ openapi_schema = {
}
-@pytest.fixture(name="client")
-def get_client():
- from docs_src.cookie_params.tutorial001_py310 import app
-
- client = TestClient(app)
- return client
-
-
@needs_py310
@pytest.mark.parametrize(
"path,cookies,expected_status,expected_response",
@@ -94,7 +86,10 @@ def get_client():
("/items", {"session": "cookiesession"}, 200, {"ads_id": None}),
],
)
-def test(path, cookies, expected_status, expected_response, client: TestClient):
- response = client.get(path, cookies=cookies)
+def test(path, cookies, expected_status, expected_response):
+ from docs_src.cookie_params.tutorial001_py310 import app
+
+ client = TestClient(app, cookies=cookies)
+ response = client.get(path)
assert response.status_code == expected_status
assert response.json() == expected_response
diff --git a/tests/test_tutorial/test_custom_request_and_route/test_tutorial001.py b/tests/test_tutorial/test_custom_request_and_route/test_tutorial001.py
index 3eb5822e2..e6da630e8 100644
--- a/tests/test_tutorial/test_custom_request_and_route/test_tutorial001.py
+++ b/tests/test_tutorial/test_custom_request_and_route/test_tutorial001.py
@@ -26,7 +26,7 @@ def test_gzip_request(compress):
data = gzip.compress(data)
headers["Content-Encoding"] = "gzip"
headers["Content-Type"] = "application/json"
- response = client.post("/sum", data=data, headers=headers)
+ response = client.post("/sum", content=data, headers=headers)
assert response.json() == {"sum": n}
diff --git a/tests/test_tutorial/test_custom_response/test_tutorial006.py b/tests/test_tutorial/test_custom_response/test_tutorial006.py
index 72bbfd277..9b10916e5 100644
--- a/tests/test_tutorial/test_custom_response/test_tutorial006.py
+++ b/tests/test_tutorial/test_custom_response/test_tutorial006.py
@@ -32,6 +32,6 @@ def test_openapi_schema():
def test_get():
- response = client.get("/typer", allow_redirects=False)
+ response = client.get("/typer", follow_redirects=False)
assert response.status_code == 307, response.text
assert response.headers["location"] == "https://typer.tiangolo.com"
diff --git a/tests/test_tutorial/test_custom_response/test_tutorial006b.py b/tests/test_tutorial/test_custom_response/test_tutorial006b.py
index ac5a76d34..b3e60e86a 100644
--- a/tests/test_tutorial/test_custom_response/test_tutorial006b.py
+++ b/tests/test_tutorial/test_custom_response/test_tutorial006b.py
@@ -27,6 +27,6 @@ def test_openapi_schema():
def test_redirect_response_class():
- response = client.get("/fastapi", allow_redirects=False)
+ response = client.get("/fastapi", follow_redirects=False)
assert response.status_code == 307
assert response.headers["location"] == "https://fastapi.tiangolo.com"
diff --git a/tests/test_tutorial/test_custom_response/test_tutorial006c.py b/tests/test_tutorial/test_custom_response/test_tutorial006c.py
index 009225e8c..0cb6ddaa3 100644
--- a/tests/test_tutorial/test_custom_response/test_tutorial006c.py
+++ b/tests/test_tutorial/test_custom_response/test_tutorial006c.py
@@ -27,6 +27,6 @@ def test_openapi_schema():
def test_redirect_status_code():
- response = client.get("/pydantic", allow_redirects=False)
+ response = client.get("/pydantic", follow_redirects=False)
assert response.status_code == 302
assert response.headers["location"] == "https://pydantic-docs.helpmanual.io/"
diff --git a/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial006.py b/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial006.py
index 5533b2957..330b4e2c7 100644
--- a/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial006.py
+++ b/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial006.py
@@ -47,7 +47,7 @@ def test_openapi_schema():
def test_post():
- response = client.post("/items/", data=b"this is actually not validated")
+ response = client.post("/items/", content=b"this is actually not validated")
assert response.status_code == 200, response.text
assert response.json() == {
"size": 30,
diff --git a/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial007.py b/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial007.py
index cb5dbc8eb..076f60b2f 100644
--- a/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial007.py
+++ b/tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial007.py
@@ -58,7 +58,7 @@ def test_post():
- x-men
- x-avengers
"""
- response = client.post("/items/", data=yaml_data)
+ response = client.post("/items/", content=yaml_data)
assert response.status_code == 200, response.text
assert response.json() == {
"name": "Deadpoolio",
@@ -74,7 +74,7 @@ def test_post_broken_yaml():
x - x-men
x - x-avengers
"""
- response = client.post("/items/", data=yaml_data)
+ response = client.post("/items/", content=yaml_data)
assert response.status_code == 422, response.text
assert response.json() == {"detail": "Invalid YAML"}
@@ -88,7 +88,7 @@ def test_post_invalid():
- x-avengers
- sneaky: object
"""
- response = client.post("/items/", data=yaml_data)
+ response = client.post("/items/", content=yaml_data)
assert response.status_code == 422, response.text
assert response.json() == {
"detail": [
diff --git a/tests/test_tutorial/test_security/test_tutorial006.py b/tests/test_tutorial/test_security/test_tutorial006.py
index 3b0a36ebc..bbfef9f7c 100644
--- a/tests/test_tutorial/test_security/test_tutorial006.py
+++ b/tests/test_tutorial/test_security/test_tutorial006.py
@@ -1,7 +1,6 @@
from base64 import b64encode
from fastapi.testclient import TestClient
-from requests.auth import HTTPBasicAuth
from docs_src.security.tutorial006 import app
@@ -38,8 +37,7 @@ def test_openapi_schema():
def test_security_http_basic():
- auth = HTTPBasicAuth(username="john", password="secret")
- response = client.get("/users/me", auth=auth)
+ response = client.get("/users/me", auth=("john", "secret"))
assert response.status_code == 200, response.text
assert response.json() == {"username": "john", "password": "secret"}
diff --git a/tests/test_tutorial/test_websockets/test_tutorial002.py b/tests/test_tutorial/test_websockets/test_tutorial002.py
index a8523c9c4..bb5ccbf8e 100644
--- a/tests/test_tutorial/test_websockets/test_tutorial002.py
+++ b/tests/test_tutorial/test_websockets/test_tutorial002.py
@@ -4,20 +4,18 @@ from fastapi.websockets import WebSocketDisconnect
from docs_src.websockets.tutorial002 import app
-client = TestClient(app)
-
def test_main():
+ client = TestClient(app)
response = client.get("/")
assert response.status_code == 200, response.text
assert b"" in response.content
def test_websocket_with_cookie():
+ client = TestClient(app, cookies={"session": "fakesession"})
with pytest.raises(WebSocketDisconnect):
- with client.websocket_connect(
- "/items/foo/ws", cookies={"session": "fakesession"}
- ) as websocket:
+ with client.websocket_connect("/items/foo/ws") as websocket:
message = "Message one"
websocket.send_text(message)
data = websocket.receive_text()
@@ -33,6 +31,7 @@ def test_websocket_with_cookie():
def test_websocket_with_header():
+ client = TestClient(app)
with pytest.raises(WebSocketDisconnect):
with client.websocket_connect("/items/bar/ws?token=some-token") as websocket:
message = "Message one"
@@ -50,6 +49,7 @@ def test_websocket_with_header():
def test_websocket_with_header_and_query():
+ client = TestClient(app)
with pytest.raises(WebSocketDisconnect):
with client.websocket_connect("/items/2/ws?q=3&token=some-token") as websocket:
message = "Message one"
@@ -71,6 +71,7 @@ def test_websocket_with_header_and_query():
def test_websocket_no_credentials():
+ client = TestClient(app)
with pytest.raises(WebSocketDisconnect):
with client.websocket_connect("/items/foo/ws"):
pytest.fail(
@@ -79,6 +80,7 @@ def test_websocket_no_credentials():
def test_websocket_invalid_data():
+ client = TestClient(app)
with pytest.raises(WebSocketDisconnect):
with client.websocket_connect("/items/foo/ws?q=bar&token=some-token"):
pytest.fail(
diff --git a/tests/test_ws_router.py b/tests/test_ws_router.py
index 206d743ba..c312821e9 100644
--- a/tests/test_ws_router.py
+++ b/tests/test_ws_router.py
@@ -111,7 +111,7 @@ def test_router_ws_depends():
def test_router_ws_depends_with_override():
client = TestClient(app)
- app.dependency_overrides[ws_dependency] = lambda: "Override"
+ app.dependency_overrides[ws_dependency] = lambda: "Override" # noqa: E731
with client.websocket_connect("/router-ws-depends/") as websocket:
assert websocket.receive_text() == "Override"
+
+ 
@@ -427,7 +427,7 @@ For a more complete example including more features, see the Strawberry and other libraries.
* Many extra features (thanks to Starlette) as:
* **WebSockets**
- * extremely easy tests based on `requests` and `pytest`
+ * extremely easy tests based on HTTPX and `pytest`
* **CORS**
* **Cookie Sessions**
* ...and more.
@@ -447,7 +447,7 @@ Used by Pydantic:
Used by Starlette:
-* 
-If you open the developer tools, you could see how the data sent and only includes the token, the password is only sent in the first request to authenticate the user and get that access token, but not afterwards:
+If you open the developer tools, you could see how the data sent only includes the token, the password is only sent in the first request to authenticate the user and get that access token, but not afterwards:
diff --git a/docs/en/docs/tutorial/testing.md b/docs/en/docs/tutorial/testing.md
index d2ccd7dc7..be07aab37 100644
--- a/docs/en/docs/tutorial/testing.md
+++ b/docs/en/docs/tutorial/testing.md
@@ -2,16 +2,16 @@
Thanks to Starlette, testing **FastAPI** applications is easy and enjoyable.
-It is based on Requests, so it's very familiar and intuitive.
+It is based on HTTPX, which in turn is designed based on Requests, so it's very familiar and intuitive.
With it, you can use pytest directly with **FastAPI**.
## Using `TestClient`
!!! info
- To use `TestClient`, first install `requests`.
+ To use `TestClient`, first install `httpx`.
- E.g. `pip install requests`.
+ E.g. `pip install httpx`.
Import `TestClient`.
@@ -19,7 +19,7 @@ Create a `TestClient` by passing your **FastAPI** application to it.
Create functions with a name that starts with `test_` (this is standard `pytest` conventions).
-Use the `TestClient` object the same way as you do with `requests`.
+Use the `TestClient` object the same way as you do with `httpx`.
Write simple `assert` statements with the standard Python expressions that you need to check (again, standard `pytest`).
@@ -130,7 +130,7 @@ You could then update `test_main.py` with the extended tests:
{!> ../../../docs_src/app_testing/app_b/test_main.py!}
```
-Whenever you need the client to pass information in the request and you don't know how to, you can search (Google) how to do it in `requests`.
+Whenever you need the client to pass information in the request and you don't know how to, you can search (Google) how to do it in `httpx`, or even how to do it with `requests`, as HTTPX's design is based on Requests' design.
Then you just do the same in your tests.
@@ -142,7 +142,7 @@ E.g.:
* To pass *headers*, use a `dict` in the `headers` parameter.
* For *cookies*, a `dict` in the `cookies` parameter.
-For more information about how to pass data to the backend (using `requests` or the `TestClient`) check the Requests documentation.
+For more information about how to pass data to the backend (using `httpx` or the `TestClient`) check the HTTPX documentation.
!!! info
Note that the `TestClient` receives data that can be converted to JSON, not Pydantic models.
diff --git a/docs/en/overrides/main.html b/docs/en/overrides/main.html
index c5eb94870..e9b9f60eb 100644
--- a/docs/en/overrides/main.html
+++ b/docs/en/overrides/main.html
@@ -22,12 +22,6 @@
-
- 