Date: Thu, 22 Jun 2023 16:17:50 +0000
Subject: [PATCH 04/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 0714848dd..9a724feef 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Add Chinese translations for `docs/zh/docs/advanced/websockets.md`. PR [#9651](https://github.com/tiangolo/fastapi/pull/9651) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translation for `docs/zh/docs/tutorial/testing.md`. PR [#9641](https://github.com/tiangolo/fastapi/pull/9641) by [@wdh99](https://github.com/wdh99).
* 🌐 Add Russian translation for `docs/tutorial/extra-models.md`. PR [#9619](https://github.com/tiangolo/fastapi/pull/9619) by [@ivan-abc](https://github.com/ivan-abc).
* 🌐 Add Russian translation for `docs/tutorial/cors.md`. PR [#9608](https://github.com/tiangolo/fastapi/pull/9608) by [@ivan-abc](https://github.com/ivan-abc).
From 804a0a90cf6e7ed03a171db759c8b7cb632b5316 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=9B=A8=E8=BF=87=E5=88=9D=E6=99=B4?=
<129537877+ChoyeonChern@users.noreply.github.com>
Date: Fri, 23 Jun 2023 00:18:04 +0800
Subject: [PATCH 05/46] =?UTF-8?q?=F0=9F=8C=90=20Add=20Chinese=20translatio?=
=?UTF-8?q?ns=20for=20`docs/zh/docs/advanced/settings.md`=20(#9652)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/zh/docs/advanced/settings.md | 433 ++++++++++++++++++++++++++++++
docs/zh/mkdocs.yml | 1 +
2 files changed, 434 insertions(+)
create mode 100644 docs/zh/docs/advanced/settings.md
diff --git a/docs/zh/docs/advanced/settings.md b/docs/zh/docs/advanced/settings.md
new file mode 100644
index 000000000..597e99a77
--- /dev/null
+++ b/docs/zh/docs/advanced/settings.md
@@ -0,0 +1,433 @@
+# 设置和环境变量
+
+在许多情况下，您的应用程序可能需要一些外部设置或配置，例如密钥、数据库凭据、电子邮件服务的凭据等等。
+
+这些设置中的大多数是可变的（可以更改的），比如数据库的 URL。而且许多设置可能是敏感的，比如密钥。
+
+因此，通常会将它们提供为由应用程序读取的环境变量。
+
+## 环境变量
+
+!!! tip
+ 如果您已经知道什么是"环境变量"以及如何使用它们，请随意跳到下面的下一节。
+
+环境变量（也称为"env var"）是一种存在于 Python 代码之外、存在于操作系统中的变量，可以被您的 Python 代码（或其他程序）读取。
+
+您可以在 shell 中创建和使用环境变量，而无需使用 Python：
+
+=== "Linux、macOS、Windows Bash"
+
+
+
+ ```console
+ // 您可以创建一个名为 MY_NAME 的环境变量
+ $ export MY_NAME="Wade Wilson"
+
+ // 然后您可以与其他程序一起使用它，例如
+ $ echo "Hello $MY_NAME"
+
+ Hello Wade Wilson
+ ```
+
+
+
+=== "Windows PowerShell"
+
+
+
+ ```console
+ // 创建一个名为 MY_NAME 的环境变量
+ $ $Env:MY_NAME = "Wade Wilson"
+
+ // 与其他程序一起使用它，例如
+ $ echo "Hello $Env:MY_NAME"
+
+ Hello Wade Wilson
+ ```
+
+
+
+### 在 Python 中读取环境变量
+
+您还可以在 Python 之外的地方（例如终端中或使用任何其他方法）创建环境变量，然后在 Python 中读取它们。
+
+例如，您可以有一个名为 `main.py` 的文件，其中包含以下内容：
+
+```Python hl_lines="3"
+import os
+
+name = os.getenv("MY_NAME", "World")
+print(f"Hello {name} from Python")
+```
+
+!!! tip
+ `os.getenv()` 的第二个参数是要返回的默认值。
+
+ 如果没有提供默认值，默认为 `None`，此处我们提供了 `"World"` 作为要使用的默认值。
+
+然后，您可以调用该 Python 程序：
+
+
+
+```console
+// 这里我们还没有设置环境变量
+$ python main.py
+
+// 因为我们没有设置环境变量，所以我们得到默认值
+
+Hello World from Python
+
+// 但是如果我们先创建一个环境变量
+$ export MY_NAME="Wade Wilson"
+
+// 然后再次调用程序
+$ python main.py
+
+// 现在它可以读取环境变量
+
+Hello Wade Wilson from Python
+```
+
+
+
+由于环境变量可以在代码之外设置，但可以由代码读取，并且不需要与其他文件一起存储（提交到 `git`），因此通常将它们用于配置或设置。
+
+
+
+您还可以仅为特定程序调用创建一个环境变量，该环境变量仅对该程序可用，并且仅在其运行期间有效。
+
+要做到这一点，在程序本身之前的同一行创建它：
+
+
+
+```console
+// 在此程序调用行中创建一个名为 MY_NAME 的环境变量
+$ MY_NAME="Wade Wilson" python main.py
+
+// 现在它可以读取环境变量
+
+Hello Wade Wilson from Python
+
+// 之后环境变量不再存在
+$ python main.py
+
+Hello World from Python
+```
+
+
+
+!!! tip
+ 您可以在 Twelve-Factor App: Config 中阅读更多相关信息。
+
+### 类型和验证
+
+这些环境变量只能处理文本字符串，因为它们是外部于 Python 的，并且必须与其他程序和整个系统兼容（甚至与不同的操作系统，如 Linux、Windows、macOS）。
+
+这意味着从环境变量中在 Python 中读取的任何值都将是 `str` 类型，任何类型的转换或验证都必须在代码中完成。
+
+## Pydantic 的 `Settings`
+
+幸运的是，Pydantic 提供了一个很好的工具来处理来自环境变量的设置，即Pydantic: Settings management。
+
+### 创建 `Settings` 对象
+
+从 Pydantic 导入 `BaseSettings` 并创建一个子类，与 Pydantic 模型非常相似。
+
+与 Pydantic 模型一样，您使用类型注释声明类属性，还可以指定默认值。
+
+您可以使用与 Pydantic 模型相同的验证功能和工具，比如不同的数据类型和使用 `Field()` 进行附加验证。
+
+```Python hl_lines="2 5-8 11"
+{!../../../docs_src/settings/tutorial001.py!}
+```
+
+!!! tip
+ 如果您需要一个快速的复制粘贴示例，请不要使用此示例，而应使用下面的最后一个示例。
+
+然后，当您创建该 `Settings` 类的实例（在此示例中是 `settings` 对象）时，Pydantic 将以不区分大小写的方式读取环境变量，因此，大写的变量 `APP_NAME` 仍将为属性 `app_name` 读取。
+
+然后，它将转换和验证数据。因此，当您使用该 `settings` 对象时，您将获得您声明的类型的数据（例如 `items_per_user` 将为 `int` 类型）。
+
+### 使用 `settings`
+
+然后，您可以在应用程序中使用新的 `settings` 对象：
+
+```Python hl_lines="18-20"
+{!../../../docs_src/settings/tutorial001.py!}
+```
+
+### 运行服务器
+
+接下来，您将运行服务器，并将配置作为环境变量传递。例如，您可以设置一个 `ADMIN_EMAIL` 和 `APP_NAME`，如下所示：
+
+
+
+```console
+$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp"uvicorn main:app
+
+INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+```
+
+
+
+!!! tip
+ 要为单个命令设置多个环境变量，只需用空格分隔它们，并将它们全部放在命令之前。
+
+然后，`admin_email` 设置将为 `"deadpool@example.com"`。
+
+`app_name` 将为 `"ChimichangApp"`。
+
+而 `items_per_user` 将保持其默认值为 `50`。
+
+## 在另一个模块中设置
+
+您可以将这些设置放在另一个模块文件中，就像您在[Bigger Applications - Multiple Files](../tutorial/bigger-applications.md){.internal-link target=_blank}中所见的那样。
+
+例如，您可以创建一个名为 `config.py` 的文件，其中包含以下内容：
+
+```Python
+{!../../../docs_src/settings/app01/config.py!}
+```
+
+然后在一个名为 `main.py` 的文件中使用它：
+
+```Python hl_lines="3 11-13"
+{!../../../docs_src/settings/app01/main.py!}
+```
+!!! tip
+ 您还需要一个名为 `__init__.py` 的文件，就像您在[Bigger Applications - Multiple Files](../tutorial/bigger-applications.md){.internal-link target=_blank}中看到的那样。
+
+## 在依赖项中使用设置
+
+在某些情况下，从依赖项中提供设置可能比在所有地方都使用全局对象 `settings` 更有用。
+
+这在测试期间尤其有用，因为很容易用自定义设置覆盖依赖项。
+
+### 配置文件
+
+根据前面的示例，您的 `config.py` 文件可能如下所示：
+
+```Python hl_lines="10"
+{!../../../docs_src/settings/app02/config.py!}
+```
+
+请注意，现在我们不创建默认实例 `settings = Settings()`。
+
+### 主应用程序文件
+
+现在我们创建一个依赖项，返回一个新的 `config.Settings()`。
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="6 12-13"
+ {!> ../../../docs_src/settings/app02_an_py39/main.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="6 12-13"
+ {!> ../../../docs_src/settings/app02_an/main.py!}
+ ```
+
+=== "Python 3.6+ 非注解版本"
+
+ !!! tip
+ 如果可能，请尽量使用 `Annotated` 版本。
+
+ ```Python hl_lines="5 11-12"
+ {!> ../../../docs_src/settings/app02/main.py!}
+ ```
+
+!!! tip
+ 我们稍后会讨论 `@lru_cache()`。
+
+ 目前，您可以将 `get_settings()` 视为普通函数。
+
+然后，我们可以将其作为依赖项从“路径操作函数”中引入，并在需要时使用它。
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="17 19-21"
+ {!> ../../../docs_src/settings/app02_an_py39/main.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="17 19-21"
+ {!> ../../../docs_src/settings/app02_an/main.py!}
+ ```
+
+=== "Python 3.6+ 非注解版本"
+
+ !!! tip
+ 如果可能，请尽量使用 `Annotated` 版本。
+
+ ```Python hl_lines="16 18-20"
+ {!> ../../../docs_src/settings/app02/main.py!}
+ ```
+
+### 设置和测试
+
+然后，在测试期间，通过创建 `get_settings` 的依赖项覆盖，很容易提供一个不同的设置对象：
+
+```Python hl_lines="9-10 13 21"
+{!../../../docs_src/settings/app02/test_main.py!}
+```
+
+在依赖项覆盖中，我们在创建新的 `Settings` 对象时为 `admin_email` 设置了一个新值，然后返回该新对象。
+
+然后，我们可以测试它是否被使用。
+
+## 从 `.env` 文件中读取设置
+
+如果您有许多可能经常更改的设置，可能在不同的环境中，将它们放在一个文件中，然后从该文件中读取它们，就像它们是环境变量一样，可能非常有用。
+
+这种做法相当常见，有一个名称，这些环境变量通常放在一个名为 `.env` 的文件中，该文件被称为“dotenv”。
+
+!!! tip
+ 以点 (`.`) 开头的文件是 Unix-like 系统（如 Linux 和 macOS）中的隐藏文件。
+
+ 但是，dotenv 文件实际上不一定要具有确切的文件名。
+
+Pydantic 支持使用外部库从这些类型的文件中读取。您可以在Pydantic 设置: Dotenv (.env) 支持中阅读更多相关信息。
+
+!!! tip
+ 要使其工作，您需要执行 `pip install python-dotenv`。
+
+### `.env` 文件
+
+您可以使用以下内容创建一个名为 `.env` 的文件：
+
+```bash
+ADMIN_EMAIL="deadpool@example.com"
+APP_NAME="ChimichangApp"
+```
+
+### 从 `.env` 文件中读取设置
+
+然后，您可以使用以下方式更新您的 `config.py`：
+
+```Python hl_lines="9-10"
+{!../../../docs_src/settings/app03/config.py!}
+```
+
+在这里，我们在 Pydantic 的 `Settings` 类中创建了一个名为 `Config` 的类，并将 `env_file` 设置为我们想要使用的 dotenv 文件的文件名。
+
+!!! tip
+ `Config` 类仅用于 Pydantic 配置。您可以在Pydantic Model Config中阅读更多相关信息。
+
+### 使用 `lru_cache` 仅创建一次 `Settings`
+
+从磁盘中读取文件通常是一项耗时的（慢）操作，因此您可能希望仅在首次读取后并重复使用相同的设置对象，而不是为每个请求都读取它。
+
+但是，每次执行以下操作：
+
+```Python
+Settings()
+```
+
+都会创建一个新的 `Settings` 对象，并且在创建时会再次读取 `.env` 文件。
+
+如果依赖项函数只是这样的：
+
+```Python
+def get_settings():
+ return Settings()
+```
+
+我们将为每个请求创建该对象，并且将在每个请求中读取 `.env` 文件。 ⚠️
+
+但是，由于我们在顶部使用了 `@lru_cache()` 装饰器，因此只有在第一次调用它时，才会创建 `Settings` 对象一次。 ✔️
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="1 11"
+ {!> ../../../docs_src/settings/app03_an_py39/main.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="1 11"
+ {!> ../../../docs_src/settings/app03_an/main.py!}
+ ```
+
+=== "Python 3.6+ 非注解版本"
+
+ !!! tip
+ 如果可能，请尽量使用 `Annotated` 版本。
+
+ ```Python hl_lines="1 10"
+ {!> ../../../docs_src/settings/app03/main.py!}
+ ```
+
+然后，在下一次请求的依赖项中对 `get_settings()` 进行任何后续调用时，它不会执行 `get_settings()` 的内部代码并创建新的 `Settings` 对象，而是返回在第一次调用时返回的相同对象，一次又一次。
+
+#### `lru_cache` 技术细节
+
+`@lru_cache()` 修改了它所装饰的函数，以返回第一次返回的相同值，而不是再次计算它，每次都执行函数的代码。
+
+因此，下面的函数将对每个参数组合执行一次。然后，每个参数组合返回的值将在使用完全相同的参数组合调用函数时再次使用。
+
+例如，如果您有一个函数：
+```Python
+@lru_cache()
+def say_hi(name: str, salutation: str = "Ms."):
+ return f"Hello {salutation} {name}"
+```
+
+您的程序可以像这样执行：
+
+```mermaid
+sequenceDiagram
+
+participant code as Code
+participant function as say_hi()
+participant execute as Execute function
+
+ rect rgba(0, 255, 0, .1)
+ code ->> function: say_hi(name="Camila")
+ function ->> execute: 执行函数代码
+ execute ->> code: 返回结果
+ end
+
+ rect rgba(0, 255, 255, .1)
+ code ->> function: say_hi(name="Camila")
+ function ->> code: 返回存储的结果
+ end
+
+ rect rgba(0, 255, 0, .1)
+ code ->> function: say_hi(name="Rick")
+ function ->> execute: 执行函数代码
+ execute ->> code: 返回结果
+ end
+
+ rect rgba(0, 255, 0, .1)
+ code ->> function: say_hi(name="Rick", salutation="Mr.")
+ function ->> execute: 执行函数代码
+ execute ->> code: 返回结果
+ end
+
+ rect rgba(0, 255, 255, .1)
+ code ->> function: say_hi(name="Rick")
+ function ->> code: 返回存储的结果
+ end
+
+ rect rgba(0, 255, 255, .1)
+ code ->> function: say_hi(name="Camila")
+ function ->> code: 返回存储的结果
+ end
+```
+
+对于我们的依赖项 `get_settings()`，该函数甚至不接受任何参数，因此它始终返回相同的值。
+
+这样，它的行为几乎就像是一个全局变量。但是由于它使用了依赖项函数，因此我们可以轻松地进行测试时的覆盖。
+
+`@lru_cache()` 是 `functools` 的一部分，它是 Python 标准库的一部分，您可以在Python 文档中了解有关 `@lru_cache()` 的更多信息。
+
+## 小结
+
+您可以使用 Pydantic 设置处理应用程序的设置或配置，利用 Pydantic 模型的所有功能。
+
+* 通过使用依赖项，您可以简化测试。
+* 您可以使用 `.env` 文件。
+* 使用 `@lru_cache()` 可以避免为每个请求重复读取 dotenv 文件，同时允许您在测试时进行覆盖。
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index 6c5001e2a..0e09101eb 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -119,6 +119,7 @@ nav:
- advanced/custom-response.md
- advanced/response-cookies.md
- advanced/response-change-status-code.md
+ - advanced/settings.md
- advanced/response-headers.md
- advanced/websockets.md
- advanced/wsgi.md
From 2f0541f17a2e9a4baa52325dc83b3907941897f7 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:18:54 +0000
Subject: [PATCH 06/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 9a724feef..30a0137c3 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Add Chinese translations for `docs/zh/docs/advanced/settings.md`. PR [#9652](https://github.com/tiangolo/fastapi/pull/9652) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/websockets.md`. PR [#9651](https://github.com/tiangolo/fastapi/pull/9651) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translation for `docs/zh/docs/tutorial/testing.md`. PR [#9641](https://github.com/tiangolo/fastapi/pull/9641) by [@wdh99](https://github.com/wdh99).
* 🌐 Add Russian translation for `docs/tutorial/extra-models.md`. PR [#9619](https://github.com/tiangolo/fastapi/pull/9619) by [@ivan-abc](https://github.com/ivan-abc).
From fa7474b2e849f96687ba883e10d99f06ddafb51e Mon Sep 17 00:00:00 2001
From: lordqyxz <31722468+lordqyxz@users.noreply.github.com>
Date: Fri, 23 Jun 2023 00:19:49 +0800
Subject: [PATCH 07/46] =?UTF-8?q?=F0=9F=8C=90=20Add=20Chinese=20translatio?=
=?UTF-8?q?n=20for=20`docs/zh/docs/advanced/security/index.md`=20(#9666)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: shiyz
---
docs/zh/docs/advanced/security/index.md | 16 ++++++++++++++++
docs/zh/mkdocs.yml | 2 ++
2 files changed, 18 insertions(+)
create mode 100644 docs/zh/docs/advanced/security/index.md
diff --git a/docs/zh/docs/advanced/security/index.md b/docs/zh/docs/advanced/security/index.md
new file mode 100644
index 000000000..962523c09
--- /dev/null
+++ b/docs/zh/docs/advanced/security/index.md
@@ -0,0 +1,16 @@
+# 高级安全 - 介绍
+
+## 附加特性
+
+除 [教程 - 用户指南: 安全性](../../tutorial/security/){.internal-link target=_blank} 中涵盖的功能之外，还有一些额外的功能来处理安全性.
+
+!!! tip "小贴士"
+ 接下来的章节 **并不一定是 "高级的"**.
+
+ 而且对于你的使用场景来说，解决方案很可能就在其中。
+
+## 先阅读教程
+
+接下来的部分假设你已经阅读了主要的 [教程 - 用户指南: 安全性](../../tutorial/security/){.internal-link target=_blank}.
+
+它们都基于相同的概念，但支持一些额外的功能.
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index 0e09101eb..a6afb3039 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -123,6 +123,8 @@ nav:
- advanced/response-headers.md
- advanced/websockets.md
- advanced/wsgi.md
+ - 高级安全:
+ - advanced/security/index.md
- contributing.md
- help-fastapi.md
- benchmarks.md
From fd6a78cbfe67a28478ceb6aa4fc7ceea59fc6aac Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:20:40 +0000
Subject: [PATCH 08/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 30a0137c3..02c7f16ec 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Add Chinese translation for `docs/zh/docs/advanced/security/index.md`. PR [#9666](https://github.com/tiangolo/fastapi/pull/9666) by [@lordqyxz](https://github.com/lordqyxz).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/settings.md`. PR [#9652](https://github.com/tiangolo/fastapi/pull/9652) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/websockets.md`. PR [#9651](https://github.com/tiangolo/fastapi/pull/9651) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translation for `docs/zh/docs/tutorial/testing.md`. PR [#9641](https://github.com/tiangolo/fastapi/pull/9641) by [@wdh99](https://github.com/wdh99).
From 0ef164e1eefdb09f8b7f5e67ccbe171b60a5f3fa Mon Sep 17 00:00:00 2001
From: Alexandr
Date: Thu, 22 Jun 2023 19:32:53 +0300
Subject: [PATCH 09/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20`Annotated`=20not?=
=?UTF-8?q?es=20in=20`docs/en/docs/tutorial/schema-extra-example.md`=20(#9?=
=?UTF-8?q?620)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Update for docs/tutorial/schema-extra-example.md
When working on the translation, I noticed that this page is missing the annotated tips that can be found in the rest of the documentation (I checked, and it's the only page where they're missing).
---
docs/en/docs/tutorial/schema-extra-example.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/en/docs/tutorial/schema-extra-example.md b/docs/en/docs/tutorial/schema-extra-example.md
index 5312254d9..e0f7ed256 100644
--- a/docs/en/docs/tutorial/schema-extra-example.md
+++ b/docs/en/docs/tutorial/schema-extra-example.md
@@ -86,6 +86,9 @@ Here we pass an `example` of the data expected in `Body()`:
=== "Python 3.10+ non-Annotated"
+ !!! tip
+ Prefer to use the `Annotated` version if possible.
+
```Python hl_lines="18-23"
{!> ../../../docs_src/schema_extra_example/tutorial003_py310.py!}
```
@@ -138,6 +141,9 @@ Each specific example `dict` in the `examples` can contain:
=== "Python 3.10+ non-Annotated"
+ !!! tip
+ Prefer to use the `Annotated` version if possible.
+
```Python hl_lines="19-45"
{!> ../../../docs_src/schema_extra_example/tutorial004_py310.py!}
```
From c7dad1bb59b5543f89d1470001c71dde3bb76d77 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:33:28 +0000
Subject: [PATCH 10/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 02c7f16ec..9d0b94a57 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
* 🌐 Add Chinese translation for `docs/zh/docs/advanced/security/index.md`. PR [#9666](https://github.com/tiangolo/fastapi/pull/9666) by [@lordqyxz](https://github.com/lordqyxz).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/settings.md`. PR [#9652](https://github.com/tiangolo/fastapi/pull/9652) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/websockets.md`. PR [#9651](https://github.com/tiangolo/fastapi/pull/9651) by [@ChoyeonChern](https://github.com/ChoyeonChern).
From 4c401aef0f1b169927249e4fc8218ad709002482 Mon Sep 17 00:00:00 2001
From: TabarakoAkula <113298631+TabarakoAkula@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:33:47 +0300
Subject: [PATCH 11/46] =?UTF-8?q?=F0=9F=8C=90=20Add=20Russian=20translatio?=
=?UTF-8?q?n=20for=20`docs/tutorial/path-operation-configuration.md`=20(#9?=
=?UTF-8?q?696)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Co-authored-by: Alexandr
Co-authored-by: Sebastián Ramírez
---
.../tutorial/path-operation-configuration.md | 179 ++++++++++++++++++
docs/ru/mkdocs.yml | 1 +
2 files changed, 180 insertions(+)
create mode 100644 docs/ru/docs/tutorial/path-operation-configuration.md
diff --git a/docs/ru/docs/tutorial/path-operation-configuration.md b/docs/ru/docs/tutorial/path-operation-configuration.md
new file mode 100644
index 000000000..013903add
--- /dev/null
+++ b/docs/ru/docs/tutorial/path-operation-configuration.md
@@ -0,0 +1,179 @@
+# Конфигурация операций пути
+
+Существует несколько параметров, которые вы можете передать вашему *декоратору операций пути* для его настройки.
+
+!!! warning "Внимание"
+ Помните, что эти параметры передаются непосредственно *декоратору операций пути*, а не вашей *функции-обработчику операций пути*.
+
+## Коды состояния
+
+Вы можете определить (HTTP) `status_code`, который будет использован в ответах вашей *операции пути*.
+
+Вы можете передать только `int`-значение кода, например `404`.
+
+Но если вы не помните, для чего нужен каждый числовой код, вы можете использовать сокращенные константы в параметре `status`:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="1 15"
+ {!> ../../../docs_src/path_operation_configuration/tutorial001_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="3 17"
+ {!> ../../../docs_src/path_operation_configuration/tutorial001_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="3 17"
+ {!> ../../../docs_src/path_operation_configuration/tutorial001.py!}
+ ```
+
+Этот код состояния будет использован в ответе и будет добавлен в схему OpenAPI.
+
+!!! note "Технические детали"
+ Вы также можете использовать `from starlette import status`.
+
+ **FastAPI** предоставляет тот же `starlette.status` под псевдонимом `fastapi.status` для удобства разработчика. Но его источник - это непосредственно Starlette.
+
+## Теги
+
+Вы можете добавлять теги к вашим *операциям пути*, добавив параметр `tags` с `list` заполненным `str`-значениями (обычно в нём только одна строка):
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="15 20 25"
+ {!> ../../../docs_src/path_operation_configuration/tutorial002_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="17 22 27"
+ {!> ../../../docs_src/path_operation_configuration/tutorial002_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="17 22 27"
+ {!> ../../../docs_src/path_operation_configuration/tutorial002.py!}
+ ```
+
+Они будут добавлены в схему OpenAPI и будут использованы в автоматической документации интерфейса:
+
+
+
+### Теги с перечислениями
+
+Если у вас большое приложение, вы можете прийти к необходимости добавить **несколько тегов**, и возможно, вы захотите убедиться в том, что всегда используете **один и тот же тег** для связанных *операций пути*.
+
+В этих случаях, имеет смысл хранить теги в классе `Enum`.
+
+**FastAPI** поддерживает это так же, как и в случае с обычными строками:
+
+```Python hl_lines="1 8-10 13 18"
+{!../../../docs_src/path_operation_configuration/tutorial002b.py!}
+```
+
+## Краткое и развёрнутое содержание
+
+Вы можете добавить параметры `summary` и `description`:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="18-19"
+ {!> ../../../docs_src/path_operation_configuration/tutorial003_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="20-21"
+ {!> ../../../docs_src/path_operation_configuration/tutorial003_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="20-21"
+ {!> ../../../docs_src/path_operation_configuration/tutorial003.py!}
+ ```
+
+## Описание из строк документации
+
+Так как описания обычно длинные и содержат много строк, вы можете объявить описание *операции пути* в функции строки документации и **FastAPI** прочитает её отсюда.
+
+Вы можете использовать Markdown в строке документации, и он будет интерпретирован и отображён корректно (с учетом отступа в строке документации).
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="17-25"
+ {!> ../../../docs_src/path_operation_configuration/tutorial004_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="19-27"
+ {!> ../../../docs_src/path_operation_configuration/tutorial004_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="19-27"
+ {!> ../../../docs_src/path_operation_configuration/tutorial004.py!}
+ ```
+
+Он будет использован в интерактивной документации:
+
+
+
+## Описание ответа
+
+Вы можете указать описание ответа с помощью параметра `response_description`:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="19"
+ {!> ../../../docs_src/path_operation_configuration/tutorial005_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="21"
+ {!> ../../../docs_src/path_operation_configuration/tutorial005_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="21"
+ {!> ../../../docs_src/path_operation_configuration/tutorial005.py!}
+ ```
+
+!!! info "Дополнительная информация"
+ Помните, что `response_description` относится конкретно к ответу, а `description` относится к *операции пути* в целом.
+
+!!! check "Технические детали"
+ OpenAPI указывает, что каждой *операции пути* необходимо описание ответа.
+
+ Если вдруг вы не укажете его, то **FastAPI** автоматически сгенерирует это описание с текстом "Successful response".
+
+
+
+## Обозначение *операции пути* как устаревшей
+
+Если вам необходимо пометить *операцию пути* как устаревшую, при этом не удаляя её, передайте параметр `deprecated`:
+
+```Python hl_lines="16"
+{!../../../docs_src/path_operation_configuration/tutorial006.py!}
+```
+
+Он будет четко помечен как устаревший в интерактивной документации:
+
+
+
+Проверьте, как будут выглядеть устаревшие и не устаревшие *операции пути*:
+
+
+
+## Резюме
+
+Вы можете легко конфигурировать и добавлять метаданные в ваши *операции пути*, передавая параметры *декораторам операций пути*.
diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml
index 24ab15726..3350a1a5e 100644
--- a/docs/ru/mkdocs.yml
+++ b/docs/ru/mkdocs.yml
@@ -81,6 +81,7 @@ nav:
- tutorial/response-status-code.md
- tutorial/query-params.md
- tutorial/body-multiple-params.md
+ - tutorial/path-operation-configuration.md
- tutorial/cors.md
- tutorial/static-files.md
- tutorial/debugging.md
From b1f27c96c4e092882253dcd40cfd6ec03ad29eeb Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:35:04 +0000
Subject: [PATCH 12/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 9d0b94a57..96484a19b 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Add Russian translation for `docs/tutorial/path-operation-configuration.md`. PR [#9696](https://github.com/tiangolo/fastapi/pull/9696) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
* 🌐 Add Chinese translation for `docs/zh/docs/advanced/security/index.md`. PR [#9666](https://github.com/tiangolo/fastapi/pull/9666) by [@lordqyxz](https://github.com/lordqyxz).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/settings.md`. PR [#9652](https://github.com/tiangolo/fastapi/pull/9652) by [@ChoyeonChern](https://github.com/ChoyeonChern).
From 41ff599d4b9548a3a56a71431da7062a00de6f18 Mon Sep 17 00:00:00 2001
From: Lili_DL <97926049+lilidl-nft@users.noreply.github.com>
Date: Thu, 22 Jun 2023 13:40:17 -0300
Subject: [PATCH 13/46] =?UTF-8?q?=F0=9F=8C=90=20Fix=20typo=20in=20Spanish?=
=?UTF-8?q?=20translation=20for=20`docs/es/docs/tutorial/first-steps.md`?=
=?UTF-8?q?=20(#9571)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Sebastián Ramírez
---
docs/es/docs/tutorial/first-steps.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/es/docs/tutorial/first-steps.md b/docs/es/docs/tutorial/first-steps.md
index 110036e8c..efa61f994 100644
--- a/docs/es/docs/tutorial/first-steps.md
+++ b/docs/es/docs/tutorial/first-steps.md
@@ -181,7 +181,7 @@ $ uvicorn main:my_awesome_api --reload
-### Paso 3: crea un *operación de path*
+### Paso 3: crea una *operación de path*
#### Path
From a3b1478221afc6185e47fd650d9d8958fd861896 Mon Sep 17 00:00:00 2001
From: jyothish-mohan <56919787+jyothish-mohan@users.noreply.github.com>
Date: Thu, 22 Jun 2023 22:10:32 +0530
Subject: [PATCH 14/46] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Tweak=20wording=20in?=
=?UTF-8?q?=20`docs/en/docs/tutorial/security/index.md`=20(#9561)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/tutorial/security/index.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/en/docs/tutorial/security/index.md b/docs/en/docs/tutorial/security/index.md
index 9aed2adb5..035b31736 100644
--- a/docs/en/docs/tutorial/security/index.md
+++ b/docs/en/docs/tutorial/security/index.md
@@ -26,7 +26,7 @@ That's what all the systems with "login with Facebook, Google, Twitter, GitHub"
### OAuth 1
-There was an OAuth 1, which is very different from OAuth2, and more complex, as it included directly specifications on how to encrypt the communication.
+There was an OAuth 1, which is very different from OAuth2, and more complex, as it included direct specifications on how to encrypt the communication.
It is not very popular or used nowadays.
From 762ede2beca0b2d8ef95a4370a7fc79b62362a02 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:40:50 +0000
Subject: [PATCH 15/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 96484a19b..ae23a74f9 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Fix typo in Spanish translation for `docs/es/docs/tutorial/first-steps.md`. PR [#9571](https://github.com/tiangolo/fastapi/pull/9571) by [@lilidl-nft](https://github.com/lilidl-nft).
* 🌐 Add Russian translation for `docs/tutorial/path-operation-configuration.md`. PR [#9696](https://github.com/tiangolo/fastapi/pull/9696) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
* 🌐 Add Chinese translation for `docs/zh/docs/advanced/security/index.md`. PR [#9666](https://github.com/tiangolo/fastapi/pull/9666) by [@lordqyxz](https://github.com/lordqyxz).
From 7217f167d4c511a85aac27aabe74aef91f3564e3 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:41:05 +0000
Subject: [PATCH 16/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index ae23a74f9..fe9d92bb1 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ✏️ Tweak wording in `docs/en/docs/tutorial/security/index.md`. PR [#9561](https://github.com/tiangolo/fastapi/pull/9561) by [@jyothish-mohan](https://github.com/jyothish-mohan).
* 🌐 Fix typo in Spanish translation for `docs/es/docs/tutorial/first-steps.md`. PR [#9571](https://github.com/tiangolo/fastapi/pull/9571) by [@lilidl-nft](https://github.com/lilidl-nft).
* 🌐 Add Russian translation for `docs/tutorial/path-operation-configuration.md`. PR [#9696](https://github.com/tiangolo/fastapi/pull/9696) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
From e5f3d6a5eb0f826f5d4ffe378a9d3c8c69d8388c Mon Sep 17 00:00:00 2001
From: Marcel Sander
Date: Thu, 22 Jun 2023 18:44:05 +0200
Subject: [PATCH 17/46] =?UTF-8?q?=F0=9F=93=9D=20Add=20german=20blog=20post?=
=?UTF-8?q?=20(Domain-driven=20Design=20mit=20Python=20und=20FastAPI)=20(#?=
=?UTF-8?q?9261)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/data/external_links.yml | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/en/data/external_links.yml b/docs/en/data/external_links.yml
index af5810778..ad738df35 100644
--- a/docs/en/data/external_links.yml
+++ b/docs/en/data/external_links.yml
@@ -233,6 +233,10 @@ articles:
link: https://medium.com/@krishnardt365/fastapi-docker-and-postgres-91943e71be92
title: Fastapi, Docker(Docker compose) and Postgres
german:
+ - author: Marcel Sander (actidoo)
+ author_link: https://www.actidoo.com
+ link: https://www.actidoo.com/de/blog/python-fastapi-domain-driven-design
+ title: Domain-driven Design mit Python und FastAPI
- author: Nico Axtmann
author_link: https://twitter.com/_nicoax
link: https://blog.codecentric.de/2019/08/inbetriebnahme-eines-scikit-learn-modells-mit-onnx-und-fastapi/
From e76dd3e70de7f0cee79e46ab74eea423ebeb302a Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:44:41 +0000
Subject: [PATCH 18/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index fe9d92bb1..d29ff0388 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 📝 Add german blog post (Domain-driven Design mit Python und FastAPI). PR [#9261](https://github.com/tiangolo/fastapi/pull/9261) by [@msander](https://github.com/msander).
* ✏️ Tweak wording in `docs/en/docs/tutorial/security/index.md`. PR [#9561](https://github.com/tiangolo/fastapi/pull/9561) by [@jyothish-mohan](https://github.com/jyothish-mohan).
* 🌐 Fix typo in Spanish translation for `docs/es/docs/tutorial/first-steps.md`. PR [#9571](https://github.com/tiangolo/fastapi/pull/9571) by [@lilidl-nft](https://github.com/lilidl-nft).
* 🌐 Add Russian translation for `docs/tutorial/path-operation-configuration.md`. PR [#9696](https://github.com/tiangolo/fastapi/pull/9696) by [@TabarakoAkula](https://github.com/TabarakoAkula).
From 47342cdd183a7b3a2059209a1c94915603753aee Mon Sep 17 00:00:00 2001
From: TabarakoAkula <113298631+TabarakoAkula@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:52:24 +0300
Subject: [PATCH 19/46] =?UTF-8?q?=F0=9F=8C=90=20Add=20Russian=20translatio?=
=?UTF-8?q?n=20for=20`docs/ru/docs/tutorial/metadata.md`=20(#9681)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Co-authored-by: Sebastián Ramírez
---
docs/ru/docs/tutorial/metadata.md | 111 ++++++++++++++++++++++++++++++
docs/ru/mkdocs.yml | 1 +
2 files changed, 112 insertions(+)
create mode 100644 docs/ru/docs/tutorial/metadata.md
diff --git a/docs/ru/docs/tutorial/metadata.md b/docs/ru/docs/tutorial/metadata.md
new file mode 100644
index 000000000..331c96734
--- /dev/null
+++ b/docs/ru/docs/tutorial/metadata.md
@@ -0,0 +1,111 @@
+# URL-адреса метаданных и документации
+
+Вы можете настроить несколько конфигураций метаданных в вашем **FastAPI** приложении.
+
+## Метаданные для API
+
+Вы можете задать следующие поля, которые используются в спецификации OpenAPI и в UI автоматической документации API:
+
+| Параметр | Тип | Описание |
+|------------|--|-------------|
+| `title` | `str` | Заголовок API. |
+| `description` | `str` | Краткое описание API. Может быть использован Markdown. |
+| `version` | `string` | Версия API. Версия вашего собственного приложения, а не OpenAPI. К примеру `2.5.0`. |
+| `terms_of_service` | `str` | Ссылка к условиям пользования API. Если указано, то это должен быть URL-адрес. |
+| `contact` | `dict` | Контактная информация для открытого API. Может содержать несколько полей. поля contact
| Параметр | Тип | Описание |
|---|
name | str | Идентификационное имя контактного лица/организации. |
url | str | URL указывающий на контактную информацию. ДОЛЖЕН быть в формате URL. |
email | str | Email адрес контактного лица/организации. ДОЛЖЕН быть в формате email адреса. |
поля license_info
| Параметр | Тип | Описание |
|---|
name | str | ОБЯЗАТЕЛЬНО (если установлен параметр license_info). Название лицензии, используемой для API |
url | str | URL, указывающий на лицензию, используемую для API. ДОЛЖЕН быть в формате URL. |
+
+## Метаданные для тегов
+
+Вы также можете добавить дополнительные метаданные для различных тегов, используемых для группировки ваших операций пути с помощью параметра `openapi_tags`.
+
+Он принимает список, содержащий один словарь для каждого тега.
+
+Каждый словарь может содержать в себе:
+
+* `name` (**обязательно**): `str`-значение с тем же именем тега, которое вы используете в параметре `tags` в ваших *операциях пути* и `APIRouter`ах.
+* `description`: `str`-значение с кратким описанием для тега. Может содержать Markdown и будет отображаться в UI документации.
+* `externalDocs`: `dict`-значение описывающее внешнюю документацию. Включает в себя:
+ * `description`: `str`-значение с кратким описанием для внешней документации.
+ * `url` (**обязательно**): `str`-значение с URL-адресом для внешней документации.
+
+### Создание метаданных для тегов
+
+Давайте попробуем сделать это на примере с тегами для `users` и `items`.
+
+Создайте метаданные для ваших тегов и передайте их в параметре `openapi_tags`:
+
+```Python hl_lines="3-16 18"
+{!../../../docs_src/metadata/tutorial004.py!}
+```
+
+Помните, что вы можете использовать Markdown внутри описания, к примеру "login" будет отображен жирным шрифтом (**login**) и "fancy" будет отображаться курсивом (_fancy_).
+
+!!! tip "Подсказка"
+ Вам необязательно добавлять метаданные для всех используемых тегов
+
+### Используйте собственные теги
+Используйте параметр `tags` с вашими *операциями пути* (и `APIRouter`ами), чтобы присвоить им различные теги:
+
+```Python hl_lines="21 26"
+{!../../../docs_src/metadata/tutorial004.py!}
+```
+
+!!! info "Дополнительная информация"
+ Узнайте больше о тегах в [Конфигурации операции пути](../path-operation-configuration/#tags){.internal-link target=_blank}.
+
+### Проверьте документацию
+
+Теперь, если вы проверите документацию, вы увидите всю дополнительную информацию:
+
+
+
+### Порядок расположения тегов
+
+Порядок расположения словарей метаданных для каждого тега определяет также порядок, отображаемый в документах UI
+
+К примеру, несмотря на то, что `users` будут идти после `items` в алфавитном порядке, они отображаются раньше, потому что мы добавляем свои метаданные в качестве первого словаря в списке.
+
+## URL-адреса OpenAPI
+
+По умолчанию схема OpenAPI отображена по адресу `/openapi.json`.
+
+Но вы можете изменить это с помощью параметра `openapi_url`.
+
+К примеру, чтобы задать её отображение по адресу `/api/v1/openapi.json`:
+
+```Python hl_lines="3"
+{!../../../docs_src/metadata/tutorial002.py!}
+```
+
+Если вы хотите отключить схему OpenAPI полностью, вы можете задать `openapi_url=None`, это также отключит пользовательские интерфейсы документации, которые его использует.
+
+## URL-адреса документации
+
+Вы можете изменить конфигурацию двух пользовательских интерфейсов документации, среди которых
+
+* **Swagger UI**: отображаемый по адресу `/docs`.
+ * Вы можете задать его URL с помощью параметра `docs_url`.
+ * Вы можете отключить это с помощью настройки `docs_url=None`.
+* **ReDoc**: отображаемый по адресу `/redoc`.
+ * Вы можете задать его URL с помощью параметра `redoc_url`.
+ * Вы можете отключить это с помощью настройки `redoc_url=None`.
+
+К примеру, чтобы задать отображение Swagger UI по адресу `/documentation` и отключить ReDoc:
+
+```Python hl_lines="3"
+{!../../../docs_src/metadata/tutorial003.py!}
+```
diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml
index 3350a1a5e..4a7512ac0 100644
--- a/docs/ru/mkdocs.yml
+++ b/docs/ru/mkdocs.yml
@@ -81,6 +81,7 @@ nav:
- tutorial/response-status-code.md
- tutorial/query-params.md
- tutorial/body-multiple-params.md
+ - tutorial/metadata.md
- tutorial/path-operation-configuration.md
- tutorial/cors.md
- tutorial/static-files.md
From fafe670db6547b272d567272007f3f6de94131f3 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 16:53:00 +0000
Subject: [PATCH 20/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index d29ff0388..d2ce322ed 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Add german blog post (Domain-driven Design mit Python und FastAPI). PR [#9261](https://github.com/tiangolo/fastapi/pull/9261) by [@msander](https://github.com/msander).
* ✏️ Tweak wording in `docs/en/docs/tutorial/security/index.md`. PR [#9561](https://github.com/tiangolo/fastapi/pull/9561) by [@jyothish-mohan](https://github.com/jyothish-mohan).
* 🌐 Fix typo in Spanish translation for `docs/es/docs/tutorial/first-steps.md`. PR [#9571](https://github.com/tiangolo/fastapi/pull/9571) by [@lilidl-nft](https://github.com/lilidl-nft).
From d82700c96dc49d81682877cf2438f75cd452d213 Mon Sep 17 00:00:00 2001
From: Pankaj Kumar <76695979+pankaj1707k@users.noreply.github.com>
Date: Thu, 22 Jun 2023 22:31:28 +0530
Subject: [PATCH 21/46] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20tooltips=20for?=
=?UTF-8?q?=20light/dark=20theme=20toggler=20in=20docs=20(#9588)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/mkdocs.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
index b7cefee53..73df174d1 100644
--- a/docs/en/mkdocs.yml
+++ b/docs/en/mkdocs.yml
@@ -11,14 +11,14 @@ theme:
accent: amber
toggle:
icon: material/lightbulb
- name: Switch to light mode
+ name: Switch to dark mode
- media: '(prefers-color-scheme: dark)'
scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
- name: Switch to dark mode
+ name: Switch to light mode
features:
- search.suggest
- search.highlight
From 0dc9a377dcaf69c50a9d3c63d0d09aca700beffa Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:02:08 +0000
Subject: [PATCH 22/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index d2ce322ed..cfe51c17a 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Add german blog post (Domain-driven Design mit Python und FastAPI). PR [#9261](https://github.com/tiangolo/fastapi/pull/9261) by [@msander](https://github.com/msander).
* ✏️ Tweak wording in `docs/en/docs/tutorial/security/index.md`. PR [#9561](https://github.com/tiangolo/fastapi/pull/9561) by [@jyothish-mohan](https://github.com/jyothish-mohan).
From 68ce5b37dc4dba574aa91ac8f80e854fbe6738f3 Mon Sep 17 00:00:00 2001
From: ivan-abc <36765187+ivan-abc@users.noreply.github.com>
Date: Thu, 22 Jun 2023 23:04:16 +0600
Subject: [PATCH 23/46] =?UTF-8?q?=E2=9C=8F=20Rewording=20in=20`docs/en/doc?=
=?UTF-8?q?s/tutorial/debugging.md`=20(#9581)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Sebastián Ramírez
---
docs/en/docs/tutorial/debugging.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/en/docs/tutorial/debugging.md b/docs/en/docs/tutorial/debugging.md
index bda889c45..3deba54d5 100644
--- a/docs/en/docs/tutorial/debugging.md
+++ b/docs/en/docs/tutorial/debugging.md
@@ -64,7 +64,7 @@ from myapp import app
# Some more code
```
-in that case, the automatic variable inside of `myapp.py` will not have the variable `__name__` with a value of `"__main__"`.
+in that case, the automatically created variable inside of `myapp.py` will not have the variable `__name__` with a value of `"__main__"`.
So, the line:
From c812b4229375eeb5c6b1fba26d01fbde219284af Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:04:50 +0000
Subject: [PATCH 24/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index cfe51c17a..ed1d94cfc 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ✏ Rewording in `docs/en/docs/tutorial/debugging.md`. PR [#9581](https://github.com/tiangolo/fastapi/pull/9581) by [@ivan-abc](https://github.com/ivan-abc).
* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Add german blog post (Domain-driven Design mit Python und FastAPI). PR [#9261](https://github.com/tiangolo/fastapi/pull/9261) by [@msander](https://github.com/msander).
From cfc06a3a3d2ebf4cb33d73aa40f62f0ac75ba25d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D1=8F=20=D0=BA=D0=BE=D1=82=D0=B8=D0=BA=20=D0=BF=D1=83?=
=?UTF-8?q?=D1=80-=D0=BF=D1=83=D1=80?=
Date: Thu, 22 Jun 2023 20:06:25 +0300
Subject: [PATCH 25/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20docs=20on=20Pydan?=
=?UTF-8?q?tic=20using=20ujson=20internally=20(#5804)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Sebastián Ramírez
---
README.md | 1 -
docs/az/docs/index.md | 1 -
docs/de/docs/index.md | 1 -
docs/en/docs/index.md | 1 -
docs/es/docs/index.md | 1 -
docs/fa/docs/index.md | 1 -
docs/fr/docs/index.md | 1 -
docs/he/docs/index.md | 1 -
docs/id/docs/index.md | 1 -
docs/it/docs/index.md | 1 -
docs/ja/docs/index.md | 1 -
docs/ko/docs/index.md | 1 -
docs/nl/docs/index.md | 1 -
docs/pl/docs/index.md | 1 -
docs/pt/docs/index.md | 1 -
docs/ru/docs/index.md | 1 -
docs/sq/docs/index.md | 1 -
docs/sv/docs/index.md | 1 -
docs/tr/docs/index.md | 1 -
docs/uk/docs/index.md | 1 -
docs/zh/docs/index.md | 1 -
21 files changed, 21 deletions(-)
diff --git a/README.md b/README.md
index ee25f1803..7dc199367 100644
--- a/README.md
+++ b/README.md
@@ -446,7 +446,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/az/docs/index.md b/docs/az/docs/index.md
index 282c15032..8b1c65194 100644
--- a/docs/az/docs/index.md
+++ b/docs/az/docs/index.md
@@ -441,7 +441,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/de/docs/index.md b/docs/de/docs/index.md
index 68fc8b753..f1c873d75 100644
--- a/docs/de/docs/index.md
+++ b/docs/de/docs/index.md
@@ -440,7 +440,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/en/docs/index.md b/docs/en/docs/index.md
index 9a81f14d1..afd6d7138 100644
--- a/docs/en/docs/index.md
+++ b/docs/en/docs/index.md
@@ -445,7 +445,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/es/docs/index.md b/docs/es/docs/index.md
index 727a6617b..5b75880c0 100644
--- a/docs/es/docs/index.md
+++ b/docs/es/docs/index.md
@@ -433,7 +433,6 @@ Para entender más al respecto revisa la sección ujson - para "parsing" de JSON más rápido.
* email_validator - para validación de emails.
Usados por Starlette:
diff --git a/docs/fa/docs/index.md b/docs/fa/docs/index.md
index ebaa8085a..248084389 100644
--- a/docs/fa/docs/index.md
+++ b/docs/fa/docs/index.md
@@ -436,7 +436,6 @@ item: Item
استفاده شده توسط Pydantic:
-* ujson - برای "تجزیه (parse)" سریعتر JSON .
* email_validator - برای اعتبارسنجی آدرسهای ایمیل.
استفاده شده توسط Starlette:
diff --git a/docs/fr/docs/index.md b/docs/fr/docs/index.md
index 5ee8b462f..7c7547be1 100644
--- a/docs/fr/docs/index.md
+++ b/docs/fr/docs/index.md
@@ -445,7 +445,6 @@ Pour en savoir plus, consultez la section ujson - pour un "décodage" JSON plus rapide.
* email_validator - pour la validation des adresses email.
Utilisées par Starlette :
diff --git a/docs/he/docs/index.md b/docs/he/docs/index.md
index 19f2f2041..802dbe8b5 100644
--- a/docs/he/docs/index.md
+++ b/docs/he/docs/index.md
@@ -440,7 +440,6 @@ item: Item
בשימוש Pydantic:
-- ujson - "פרסור" JSON.
- email_validator - לאימות כתובות אימייל.
בשימוש Starlette:
diff --git a/docs/id/docs/index.md b/docs/id/docs/index.md
index 66fc2859e..ed551f910 100644
--- a/docs/id/docs/index.md
+++ b/docs/id/docs/index.md
@@ -441,7 +441,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/it/docs/index.md b/docs/it/docs/index.md
index 9d95dd6d7..42c9a7e8c 100644
--- a/docs/it/docs/index.md
+++ b/docs/it/docs/index.md
@@ -438,7 +438,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/ja/docs/index.md b/docs/ja/docs/index.md
index f3a159f70..a9c381a23 100644
--- a/docs/ja/docs/index.md
+++ b/docs/ja/docs/index.md
@@ -431,7 +431,6 @@ item: Item
Pydantic によって使用されるもの:
-- ujson - より速い JSON への"変換".
- email_validator - E メールの検証
Starlette によって使用されるもの:
diff --git a/docs/ko/docs/index.md b/docs/ko/docs/index.md
index c64713705..a6991a9b8 100644
--- a/docs/ko/docs/index.md
+++ b/docs/ko/docs/index.md
@@ -437,7 +437,6 @@ item: Item
Pydantic이 사용하는:
-* ujson - 더 빠른 JSON "파싱".
* email_validator - 이메일 유효성 검사.
Starlette이 사용하는:
diff --git a/docs/nl/docs/index.md b/docs/nl/docs/index.md
index 23143a96f..47d62f8c4 100644
--- a/docs/nl/docs/index.md
+++ b/docs/nl/docs/index.md
@@ -444,7 +444,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/pl/docs/index.md b/docs/pl/docs/index.md
index 98e1e82fc..bade7a88c 100644
--- a/docs/pl/docs/index.md
+++ b/docs/pl/docs/index.md
@@ -435,7 +435,6 @@ Aby dowiedzieć się o tym więcej, zobacz sekcję ujson - dla szybszego "parsowania" danych JSON.
* email_validator - dla walidacji adresów email.
Używane przez Starlette:
diff --git a/docs/pt/docs/index.md b/docs/pt/docs/index.md
index 76668b4da..591e7f3d4 100644
--- a/docs/pt/docs/index.md
+++ b/docs/pt/docs/index.md
@@ -430,7 +430,6 @@ Para entender mais sobre performance, veja a seção ujson - para JSON mais rápido "parsing".
* email_validator - para validação de email.
Usados por Starlette:
diff --git a/docs/ru/docs/index.md b/docs/ru/docs/index.md
index 14a6d5a8b..30c32e046 100644
--- a/docs/ru/docs/index.md
+++ b/docs/ru/docs/index.md
@@ -439,7 +439,6 @@ item: Item
Используется Pydantic:
-* ujson - для более быстрого JSON "парсинга".
* email_validator - для проверки электронной почты.
Используется Starlette:
diff --git a/docs/sq/docs/index.md b/docs/sq/docs/index.md
index cff2c2804..a83b7b519 100644
--- a/docs/sq/docs/index.md
+++ b/docs/sq/docs/index.md
@@ -441,7 +441,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/sv/docs/index.md b/docs/sv/docs/index.md
index 23143a96f..47d62f8c4 100644
--- a/docs/sv/docs/index.md
+++ b/docs/sv/docs/index.md
@@ -444,7 +444,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/tr/docs/index.md b/docs/tr/docs/index.md
index 6bd30d709..2339337f3 100644
--- a/docs/tr/docs/index.md
+++ b/docs/tr/docs/index.md
@@ -449,7 +449,6 @@ Daha fazla bilgi için, bu bölüme bir göz at ujson - daha hızlı JSON "dönüşümü" için.
* email_validator - email doğrulaması için.
Starlette tarafında kullanılan:
diff --git a/docs/uk/docs/index.md b/docs/uk/docs/index.md
index cff2c2804..a83b7b519 100644
--- a/docs/uk/docs/index.md
+++ b/docs/uk/docs/index.md
@@ -441,7 +441,6 @@ To understand more about it, see the section ujson - for faster JSON "parsing".
* email_validator - for email validation.
Used by Starlette:
diff --git a/docs/zh/docs/index.md b/docs/zh/docs/index.md
index 4db3ef10c..1de2a8d36 100644
--- a/docs/zh/docs/index.md
+++ b/docs/zh/docs/index.md
@@ -437,7 +437,6 @@ item: Item
用于 Pydantic：
-* ujson - 更快的 JSON 「解析」。
* email_validator - 用于 email 校验。
用于 Starlette：
From 4842dfadcf1a68f77f6a26df1235cdf85387ae89 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:07:05 +0000
Subject: [PATCH 26/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index ed1d94cfc..122976f96 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 📝 Update docs on Pydantic using ujson internally. PR [#5804](https://github.com/tiangolo/fastapi/pull/5804) by [@mvasilkov](https://github.com/mvasilkov).
* ✏ Rewording in `docs/en/docs/tutorial/debugging.md`. PR [#9581](https://github.com/tiangolo/fastapi/pull/9581) by [@ivan-abc](https://github.com/ivan-abc).
* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
From 56bc75372f970818502d3ec9b1ce08b15c702173 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:12:24 +0200
Subject: [PATCH 27/46] =?UTF-8?q?=E2=AC=86=20Bump=20pypa/gh-action-pypi-pu?=
=?UTF-8?q?blish=20from=201.8.5=20to=201.8.6=20(#9482)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
.github/workflows/publish.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index bdadcc6d3..b84c5bf17 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -32,7 +32,7 @@ jobs:
- name: Build distribution
run: python -m build
- name: Publish
- uses: pypa/gh-action-pypi-publish@v1.8.5
+ uses: pypa/gh-action-pypi-publish@v1.8.6
with:
password: ${{ secrets.PYPI_API_TOKEN }}
- name: Dump GitHub context
From 586de94ca11c6edf914645a381a4a516e9c0aa31 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:12:59 +0000
Subject: [PATCH 28/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 122976f96..e1b267d9e 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
* 📝 Update docs on Pydantic using ujson internally. PR [#5804](https://github.com/tiangolo/fastapi/pull/5804) by [@mvasilkov](https://github.com/mvasilkov).
* ✏ Rewording in `docs/en/docs/tutorial/debugging.md`. PR [#9581](https://github.com/tiangolo/fastapi/pull/9581) by [@ivan-abc](https://github.com/ivan-abc).
* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
From 60343161ea502cac9039d4410686aa7a2e768153 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:26:01 +0200
Subject: [PATCH 29/46] =?UTF-8?q?=E2=AC=86=20Update=20pre-commit=20require?=
=?UTF-8?q?ment=20from=20<3.0.0,>=3D2.17.0=20to=20>=3D2.17.0,<4.0.0=20(#92?=
=?UTF-8?q?51)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
requirements.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.txt b/requirements.txt
index cb9abb44a..49aae4466 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,4 +2,4 @@
-r requirements-tests.txt
-r requirements-docs.txt
uvicorn[standard] >=0.12.0,<0.21.0
-pre-commit >=2.17.0,<3.0.0
+pre-commit >=2.17.0,<4.0.0
From fdc713428e226d217dcda2b3418b4497aee3086e Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:26:46 +0000
Subject: [PATCH 30/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index e1b267d9e..3ca3d7d9e 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
* 📝 Update docs on Pydantic using ujson internally. PR [#5804](https://github.com/tiangolo/fastapi/pull/5804) by [@mvasilkov](https://github.com/mvasilkov).
* ✏ Rewording in `docs/en/docs/tutorial/debugging.md`. PR [#9581](https://github.com/tiangolo/fastapi/pull/9581) by [@ivan-abc](https://github.com/ivan-abc).
From 6553243dbfcb0f0e938e6aa7b3e3c2d17730430b Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:42:53 +0200
Subject: [PATCH 31/46] =?UTF-8?q?=E2=AC=86=20Bump=20mypy=20from=201.3.0=20?=
=?UTF-8?q?to=201.4.0=20(#9719)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
requirements-tests.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements-tests.txt b/requirements-tests.txt
index 3ef3c4fd9..d7ef561fa 100644
--- a/requirements-tests.txt
+++ b/requirements-tests.txt
@@ -1,7 +1,7 @@
-e .
pytest >=7.1.3,<8.0.0
coverage[toml] >= 6.5.0,< 8.0
-mypy ==1.3.0
+mypy ==1.4.0
ruff ==0.0.272
black == 23.3.0
httpx >=0.23.0,<0.24.0
From a01c2ca3ddedbb743c6feb1b8d68b80b1d8ca692 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:43:29 +0000
Subject: [PATCH 32/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 3ca3d7d9e..caec549ae 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆ Bump mypy from 1.3.0 to 1.4.0. PR [#9719](https://github.com/tiangolo/fastapi/pull/9719) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
* 📝 Update docs on Pydantic using ujson internally. PR [#5804](https://github.com/tiangolo/fastapi/pull/5804) by [@mvasilkov](https://github.com/mvasilkov).
From 836ac562034899146c3a744015f1df5703cccb66 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:43:44 +0200
Subject: [PATCH 33/46] =?UTF-8?q?=E2=AC=86=20Update=20uvicorn[standard]=20?=
=?UTF-8?q?requirement=20from=20<0.21.0,>=3D0.12.0=20to=20>=3D0.12.0,<0.23?=
=?UTF-8?q?.0=20(#9463)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
requirements.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements.txt b/requirements.txt
index 49aae4466..7e746016a 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,5 +1,5 @@
-e .[all]
-r requirements-tests.txt
-r requirements-docs.txt
-uvicorn[standard] >=0.12.0,<0.21.0
+uvicorn[standard] >=0.12.0,<0.23.0
pre-commit >=2.17.0,<4.0.0
From 41d774ed6d7f90da8cddc168a645bc00158a6a9b Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:44:21 +0000
Subject: [PATCH 34/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index caec549ae..171c46f7f 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆ Update uvicorn[standard] requirement from <0.21.0,>=0.12.0 to >=0.12.0,<0.23.0. PR [#9463](https://github.com/tiangolo/fastapi/pull/9463) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump mypy from 1.3.0 to 1.4.0. PR [#9719](https://github.com/tiangolo/fastapi/pull/9719) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
From d1805ef466b507ad52a627a6fd4fea9b0b71a7b6 Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:52:20 +0200
Subject: [PATCH 35/46] =?UTF-8?q?=E2=AC=86=20Bump=20ruff=20from=200.0.272?=
=?UTF-8?q?=20to=200.0.275=20(#9721)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: dependabot[bot]
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
requirements-tests.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/requirements-tests.txt b/requirements-tests.txt
index d7ef561fa..5cedde84d 100644
--- a/requirements-tests.txt
+++ b/requirements-tests.txt
@@ -2,7 +2,7 @@
pytest >=7.1.3,<8.0.0
coverage[toml] >= 6.5.0,< 8.0
mypy ==1.4.0
-ruff ==0.0.272
+ruff ==0.0.275
black == 23.3.0
httpx >=0.23.0,<0.24.0
email_validator >=1.1.1,<2.0.0
From 2ffb08d0bc6a6e14a14d278c29dcc6e24b162f48 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Thu, 22 Jun 2023 17:52:55 +0000
Subject: [PATCH 36/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 171c46f7f..b45ebeb03 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆ Bump ruff from 0.0.272 to 0.0.275. PR [#9721](https://github.com/tiangolo/fastapi/pull/9721) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update uvicorn[standard] requirement from <0.21.0,>=0.12.0 to >=0.12.0,<0.23.0. PR [#9463](https://github.com/tiangolo/fastapi/pull/9463) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump mypy from 1.3.0 to 1.4.0. PR [#9719](https://github.com/tiangolo/fastapi/pull/9719) by [@dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
From 8066f85b3f83d79c28b941af6160d3512edb8cb5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Thu, 22 Jun 2023 19:57:25 +0200
Subject: [PATCH 37/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index b45ebeb03..752b42d3e 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,20 +2,25 @@
## Latest Changes
-* ⬆ Bump ruff from 0.0.272 to 0.0.275. PR [#9721](https://github.com/tiangolo/fastapi/pull/9721) by [@dependabot[bot]](https://github.com/apps/dependabot).
-* ⬆ Update uvicorn[standard] requirement from <0.21.0,>=0.12.0 to >=0.12.0,<0.23.0. PR [#9463](https://github.com/tiangolo/fastapi/pull/9463) by [@dependabot[bot]](https://github.com/apps/dependabot).
-* ⬆ Bump mypy from 1.3.0 to 1.4.0. PR [#9719](https://github.com/tiangolo/fastapi/pull/9719) by [@dependabot[bot]](https://github.com/apps/dependabot).
-* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
-* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
+### Features
+
+* ✨ Allow disabling `redirect_slashes` at the FastAPI app level. PR [#3432](https://github.com/tiangolo/fastapi/pull/3432) by [@cyberlis](https://github.com/cyberlis).
+
+### Docs
+
* 📝 Update docs on Pydantic using ujson internally. PR [#5804](https://github.com/tiangolo/fastapi/pull/5804) by [@mvasilkov](https://github.com/mvasilkov).
* ✏ Rewording in `docs/en/docs/tutorial/debugging.md`. PR [#9581](https://github.com/tiangolo/fastapi/pull/9581) by [@ivan-abc](https://github.com/ivan-abc).
-* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
-* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 📝 Add german blog post (Domain-driven Design mit Python und FastAPI). PR [#9261](https://github.com/tiangolo/fastapi/pull/9261) by [@msander](https://github.com/msander).
* ✏️ Tweak wording in `docs/en/docs/tutorial/security/index.md`. PR [#9561](https://github.com/tiangolo/fastapi/pull/9561) by [@jyothish-mohan](https://github.com/jyothish-mohan).
+* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
+* ✏️ Fix typo `Annotation` -> `Annotated` in `docs/en/docs/tutorial/query-params-str-validations.md`. PR [#9625](https://github.com/tiangolo/fastapi/pull/9625) by [@mccricardo](https://github.com/mccricardo).
+* 📝 Use in memory database for testing SQL in docs. PR [#1223](https://github.com/tiangolo/fastapi/pull/1223) by [@HarshaLaxman](https://github.com/HarshaLaxman).
+
+### Translations
+
+* 🌐 Add Russian translation for `docs/ru/docs/tutorial/metadata.md`. PR [#9681](https://github.com/tiangolo/fastapi/pull/9681) by [@TabarakoAkula](https://github.com/TabarakoAkula).
* 🌐 Fix typo in Spanish translation for `docs/es/docs/tutorial/first-steps.md`. PR [#9571](https://github.com/tiangolo/fastapi/pull/9571) by [@lilidl-nft](https://github.com/lilidl-nft).
* 🌐 Add Russian translation for `docs/tutorial/path-operation-configuration.md`. PR [#9696](https://github.com/tiangolo/fastapi/pull/9696) by [@TabarakoAkula](https://github.com/TabarakoAkula).
-* 📝 Update `Annotated` notes in `docs/en/docs/tutorial/schema-extra-example.md`. PR [#9620](https://github.com/tiangolo/fastapi/pull/9620) by [@Alexandrhub](https://github.com/Alexandrhub).
* 🌐 Add Chinese translation for `docs/zh/docs/advanced/security/index.md`. PR [#9666](https://github.com/tiangolo/fastapi/pull/9666) by [@lordqyxz](https://github.com/lordqyxz).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/settings.md`. PR [#9652](https://github.com/tiangolo/fastapi/pull/9652) by [@ChoyeonChern](https://github.com/ChoyeonChern).
* 🌐 Add Chinese translations for `docs/zh/docs/advanced/websockets.md`. PR [#9651](https://github.com/tiangolo/fastapi/pull/9651) by [@ChoyeonChern](https://github.com/ChoyeonChern).
@@ -24,12 +29,18 @@
* 🌐 Add Russian translation for `docs/tutorial/cors.md`. PR [#9608](https://github.com/tiangolo/fastapi/pull/9608) by [@ivan-abc](https://github.com/ivan-abc).
* 🌐 Add Polish translation for `docs/pl/docs/features.md`. PR [#5348](https://github.com/tiangolo/fastapi/pull/5348) by [@mbroton](https://github.com/mbroton).
* 🌐 Add Russian translation for `docs/ru/docs/tutorial/body-nested-models.md`. PR [#9605](https://github.com/tiangolo/fastapi/pull/9605) by [@Alexandrhub](https://github.com/Alexandrhub).
-* ✏️ Fix typo `Annotation` -> `Annotated` in `docs/en/docs/tutorial/query-params-str-validations.md`. PR [#9625](https://github.com/tiangolo/fastapi/pull/9625) by [@mccricardo](https://github.com/mccricardo).
+
+### Internal
+
+* ⬆ Bump ruff from 0.0.272 to 0.0.275. PR [#9721](https://github.com/tiangolo/fastapi/pull/9721) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Update uvicorn[standard] requirement from <0.21.0,>=0.12.0 to >=0.12.0,<0.23.0. PR [#9463](https://github.com/tiangolo/fastapi/pull/9463) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump mypy from 1.3.0 to 1.4.0. PR [#9719](https://github.com/tiangolo/fastapi/pull/9719) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Update pre-commit requirement from <3.0.0,>=2.17.0 to >=2.17.0,<4.0.0. PR [#9251](https://github.com/tiangolo/fastapi/pull/9251) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6. PR [#9482](https://github.com/tiangolo/fastapi/pull/9482) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ✏️ Fix tooltips for light/dark theme toggler in docs. PR [#9588](https://github.com/tiangolo/fastapi/pull/9588) by [@pankaj1707k](https://github.com/pankaj1707k).
* 🔧 Set minimal hatchling version needed to build the package. PR [#9240](https://github.com/tiangolo/fastapi/pull/9240) by [@mgorny](https://github.com/mgorny).
* 📝 Add repo link to PyPI. PR [#9559](https://github.com/tiangolo/fastapi/pull/9559) by [@JacobCoffee](https://github.com/JacobCoffee).
* ✏️ Fix typos in data for tests. PR [#4958](https://github.com/tiangolo/fastapi/pull/4958) by [@ryanrussell](https://github.com/ryanrussell).
-* 📝 Use in memory database for testing SQL in docs. PR [#1223](https://github.com/tiangolo/fastapi/pull/1223) by [@HarshaLaxman](https://github.com/HarshaLaxman).
-* ✨ Add allow disabling `redirect_slashes` at the FastAPI app level. PR [#3432](https://github.com/tiangolo/fastapi/pull/3432) by [@cyberlis](https://github.com/cyberlis).
* 🔧 Update sponsors, add Flint. PR [#9699](https://github.com/tiangolo/fastapi/pull/9699) by [@tiangolo](https://github.com/tiangolo).
* 👷 Lint in CI only once, only with one version of Python, run tests with all of them. PR [#9686](https://github.com/tiangolo/fastapi/pull/9686) by [@tiangolo](https://github.com/tiangolo).
From 4721405ef7c970bf3ba08259546dcc0b87cf22c0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Thu, 22 Jun 2023 19:58:22 +0200
Subject: [PATCH 38/46] =?UTF-8?q?=F0=9F=94=96=20Release=20version=200.98.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 3 +++
fastapi/__init__.py | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 752b42d3e..5a8610a09 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,9 @@
## Latest Changes
+
+## 0.98.0
+
### Features
* ✨ Allow disabling `redirect_slashes` at the FastAPI app level. PR [#3432](https://github.com/tiangolo/fastapi/pull/3432) by [@cyberlis](https://github.com/cyberlis).
diff --git a/fastapi/__init__.py b/fastapi/__init__.py
index 46a056363..038e1ba86 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.97.0"
+__version__ = "0.98.0"
from starlette import status as status
From 42d0d6e4a51273dca8eb2ab58eda8d840c87c6f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Fri, 23 Jun 2023 19:55:09 +0200
Subject: [PATCH 39/46] =?UTF-8?q?=F0=9F=91=B7=20Build=20and=20deploy=20doc?=
=?UTF-8?q?s=20only=20on=20docs=20changes=20(#9728)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.github/workflows/build-docs.yml | 26 +++++++++++++++++++++++++-
.github/workflows/preview-docs.yml | 5 +++++
2 files changed, 30 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index a0e83e5c8..fb1fa6f09 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -4,9 +4,33 @@ on:
branches:
- master
pull_request:
- types: [opened, synchronize]
+ types:
+ - opened
+ - synchronize
jobs:
+ changes:
+ runs-on: ubuntu-latest
+ # Required permissions
+ permissions:
+ pull-requests: read
+ # Set job outputs to values from filter step
+ outputs:
+ docs: ${{ steps.filter.outputs.docs }}
+ steps:
+ - uses: actions/checkout@v3
+ # For pull requests it's not necessary to checkout the code but for master it is
+ - uses: dorny/paths-filter@v2
+ id: filter
+ with:
+ filters: |
+ docs:
+ - README.md
+ - docs/**
+ - docs_src/**
+ - requirements-docs.txt
build-docs:
+ needs: changes
+ if: ${{ needs.changes.outputs.docs == 'true' }}
runs-on: ubuntu-latest
steps:
- name: Dump GitHub context
diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/preview-docs.yml
index 298f75b02..da98f5d2b 100644
--- a/.github/workflows/preview-docs.yml
+++ b/.github/workflows/preview-docs.yml
@@ -16,19 +16,23 @@ jobs:
rm -rf ./site
mkdir ./site
- name: Download Artifact Docs
+ id: download
uses: dawidd6/action-download-artifact@v2.27.0
with:
+ if_no_artifact_found: ignore
github_token: ${{ secrets.FASTAPI_PREVIEW_DOCS_DOWNLOAD_ARTIFACTS }}
workflow: build-docs.yml
run_id: ${{ github.event.workflow_run.id }}
name: docs-zip
path: ./site/
- name: Unzip docs
+ if: steps.download.outputs.found_artifact == 'true'
run: |
cd ./site
unzip docs.zip
rm -f docs.zip
- name: Deploy to Netlify
+ if: steps.download.outputs.found_artifact == 'true'
id: netlify
uses: nwtgck/actions-netlify@v2.0.0
with:
@@ -40,6 +44,7 @@ jobs:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
- name: Comment Deploy
+ if: steps.netlify.outputs.deploy-url != ''
uses: ./.github/actions/comment-docs-preview-in-pr
with:
token: ${{ secrets.FASTAPI_PREVIEW_DOCS_COMMENT_DEPLOY }}
From 5a3bbb62de97f01bd4cfb64ed62592beef7523da Mon Sep 17 00:00:00 2001
From: github-actions
Date: Fri, 23 Jun 2023 17:55:46 +0000
Subject: [PATCH 40/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 5a8610a09..405916d63 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 👷 Build and deploy docs only on docs changes. PR [#9728](https://github.com/tiangolo/fastapi/pull/9728) by [@tiangolo](https://github.com/tiangolo).
## 0.98.0
From 0c66ec7da9abec87a9961a3413c09d4b4031b06d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Fri, 23 Jun 2023 20:16:41 +0200
Subject: [PATCH 41/46] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Upgrade=20MkDocs=20a?=
=?UTF-8?q?nd=20MkDocs=20Material=20(#9729)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
requirements-docs.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/requirements-docs.txt b/requirements-docs.txt
index e9d0567ed..211212fba 100644
--- a/requirements-docs.txt
+++ b/requirements-docs.txt
@@ -1,6 +1,6 @@
-e .
-mkdocs >=1.1.2,<2.0.0
-mkdocs-material >=8.1.4,<9.0.0
+mkdocs==1.4.3
+mkdocs-material==9.1.16
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
typer-cli >=0.0.13,<0.0.14
From 1471bc956cb4eff2207475c2ec2297a372d4b568 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Fri, 23 Jun 2023 18:17:17 +0000
Subject: [PATCH 42/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 405916d63..74b7f25ca 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* ⬆️ Upgrade MkDocs and MkDocs Material. PR [#9729](https://github.com/tiangolo/fastapi/pull/9729) by [@tiangolo](https://github.com/tiangolo).
* 👷 Build and deploy docs only on docs changes. PR [#9728](https://github.com/tiangolo/fastapi/pull/9728) by [@tiangolo](https://github.com/tiangolo).
## 0.98.0
From f61217a18a011c597f109be4e6033014c7ff92e9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Sat, 24 Jun 2023 01:51:56 +0200
Subject: [PATCH 43/46] =?UTF-8?q?=F0=9F=94=A5=20Remove=20old=20internal=20?=
=?UTF-8?q?GitHub=20Action=20watch-previews=20that=20is=20no=20longer=20ne?=
=?UTF-8?q?eded=20(#9730)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.github/actions/watch-previews/Dockerfile | 7 --
.github/actions/watch-previews/action.yml | 10 --
.github/actions/watch-previews/app/main.py | 101 ---------------------
3 files changed, 118 deletions(-)
delete mode 100644 .github/actions/watch-previews/Dockerfile
delete mode 100644 .github/actions/watch-previews/action.yml
delete mode 100644 .github/actions/watch-previews/app/main.py
diff --git a/.github/actions/watch-previews/Dockerfile b/.github/actions/watch-previews/Dockerfile
deleted file mode 100644
index b8cc64d94..000000000
--- a/.github/actions/watch-previews/Dockerfile
+++ /dev/null
@@ -1,7 +0,0 @@
-FROM python:3.7
-
-RUN pip install httpx PyGithub "pydantic==1.5.1"
-
-COPY ./app /app
-
-CMD ["python", "/app/main.py"]
diff --git a/.github/actions/watch-previews/action.yml b/.github/actions/watch-previews/action.yml
deleted file mode 100644
index 5c09ad487..000000000
--- a/.github/actions/watch-previews/action.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-name: "Watch docs previews in PRs"
-description: "Check PRs and trigger new docs deploys"
-author: "Sebastián Ramírez "
-inputs:
- token:
- description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
- required: true
-runs:
- using: 'docker'
- image: 'Dockerfile'
diff --git a/.github/actions/watch-previews/app/main.py b/.github/actions/watch-previews/app/main.py
deleted file mode 100644
index 51285d02b..000000000
--- a/.github/actions/watch-previews/app/main.py
+++ /dev/null
@@ -1,101 +0,0 @@
-import logging
-from datetime import datetime
-from pathlib import Path
-from typing import List, Union
-
-import httpx
-from github import Github
-from github.NamedUser import NamedUser
-from pydantic import BaseModel, BaseSettings, SecretStr
-
-github_api = "https://api.github.com"
-netlify_api = "https://api.netlify.com"
-
-
-class Settings(BaseSettings):
- input_token: SecretStr
- github_repository: str
- github_event_path: Path
- github_event_name: Union[str, None] = None
-
-
-class Artifact(BaseModel):
- id: int
- node_id: str
- name: str
- size_in_bytes: int
- url: str
- archive_download_url: str
- expired: bool
- created_at: datetime
- updated_at: datetime
-
-
-class ArtifactResponse(BaseModel):
- total_count: int
- artifacts: List[Artifact]
-
-
-def get_message(commit: str) -> str:
- return f"Docs preview for commit {commit} at"
-
-
-if __name__ == "__main__":
- logging.basicConfig(level=logging.INFO)
- settings = Settings()
- logging.info(f"Using config: {settings.json()}")
- g = Github(settings.input_token.get_secret_value())
- repo = g.get_repo(settings.github_repository)
- owner: NamedUser = repo.owner
- headers = {"Authorization": f"token {settings.input_token.get_secret_value()}"}
- prs = list(repo.get_pulls(state="open"))
- response = httpx.get(
- f"{github_api}/repos/{settings.github_repository}/actions/artifacts",
- headers=headers,
- )
- data = response.json()
- artifacts_response = ArtifactResponse.parse_obj(data)
- for pr in prs:
- logging.info("-----")
- logging.info(f"Processing PR #{pr.number}: {pr.title}")
- pr_comments = list(pr.get_issue_comments())
- pr_commits = list(pr.get_commits())
- last_commit = pr_commits[0]
- for pr_commit in pr_commits:
- if pr_commit.commit.author.date > last_commit.commit.author.date:
- last_commit = pr_commit
- commit = last_commit.commit.sha
- logging.info(f"Last commit: {commit}")
- message = get_message(commit)
- notified = False
- for pr_comment in pr_comments:
- if message in pr_comment.body:
- notified = True
- logging.info(f"Docs preview was notified: {notified}")
- if not notified:
- artifact_name = f"docs-zip-{commit}"
- use_artifact: Union[Artifact, None] = None
- for artifact in artifacts_response.artifacts:
- if artifact.name == artifact_name:
- use_artifact = artifact
- break
- if not use_artifact:
- logging.info("Artifact not available")
- else:
- logging.info(f"Existing artifact: {use_artifact.name}")
- response = httpx.post(
- "https://api.github.com/repos/tiangolo/fastapi/actions/workflows/preview-docs.yml/dispatches",
- headers=headers,
- json={
- "ref": "master",
- "inputs": {
- "pr": f"{pr.number}",
- "name": artifact_name,
- "commit": commit,
- },
- },
- )
- logging.info(
- f"Trigger sent, response status: {response.status_code} - content: {response.content}"
- )
- logging.info("Finished")
From 2848951082cf3301818b3a120b276dff91646458 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Fri, 23 Jun 2023 23:52:34 +0000
Subject: [PATCH 44/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 74b7f25ca..6f43126b0 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 🔥 Remove old internal GitHub Action watch-previews that is no longer needed. PR [#9730](https://github.com/tiangolo/fastapi/pull/9730) by [@tiangolo](https://github.com/tiangolo).
* ⬆️ Upgrade MkDocs and MkDocs Material. PR [#9729](https://github.com/tiangolo/fastapi/pull/9729) by [@tiangolo](https://github.com/tiangolo).
* 👷 Build and deploy docs only on docs changes. PR [#9728](https://github.com/tiangolo/fastapi/pull/9728) by [@tiangolo](https://github.com/tiangolo).
From c09e5cdfa70a6c0226e10d93595717bf3c0feedb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?=
Date: Sat, 24 Jun 2023 02:00:12 +0200
Subject: [PATCH 45/46] =?UTF-8?q?=F0=9F=91=B7=20Refactor=20Docs=20CI,=20ru?=
=?UTF-8?q?n=20in=20multiple=20workers=20with=20a=20dynamic=20matrix=20to?=
=?UTF-8?q?=20optimize=20speed=20(#9732)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.github/workflows/build-docs.yml | 73 ++++++---
.../{preview-docs.yml => deploy-docs.yml} | 18 +--
.gitignore | 1 +
scripts/docs.py | 152 +++++++++---------
scripts/zip-docs.sh | 11 --
5 files changed, 142 insertions(+), 113 deletions(-)
rename .github/workflows/{preview-docs.yml => deploy-docs.yml} (79%)
delete mode 100644 scripts/zip-docs.sh
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index fb1fa6f09..c2880ef71 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -23,15 +23,45 @@ jobs:
id: filter
with:
filters: |
- docs:
- - README.md
- - docs/**
- - docs_src/**
- - requirements-docs.txt
+ docs:
+ - README.md
+ - docs/**
+ - docs_src/**
+ - requirements-docs.txt
+ langs:
+ needs:
+ - changes
+ runs-on: ubuntu-latest
+ outputs:
+ langs: ${{ steps.show-langs.outputs.langs }}
+ steps:
+ - uses: actions/checkout@v3
+ - name: Set up Python
+ uses: actions/setup-python@v4
+ with:
+ python-version: "3.11"
+ - uses: actions/cache@v3
+ id: cache
+ with:
+ path: ${{ env.pythonLocation }}
+ key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v03
+ - name: Install docs extras
+ if: steps.cache.outputs.cache-hit != 'true'
+ run: pip install -r requirements-docs.txt
+ - name: Export Language Codes
+ id: show-langs
+ run: |
+ echo "langs=$(python ./scripts/docs.py langs-json)" >> $GITHUB_OUTPUT
+
build-docs:
- needs: changes
+ needs:
+ - changes
+ - langs
if: ${{ needs.changes.outputs.docs == 'true' }}
runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ lang: ${{ fromJson(needs.langs.outputs.langs) }}
steps:
- name: Dump GitHub context
env:
@@ -53,21 +83,24 @@ jobs:
- name: Install Material for MkDocs Insiders
if: ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false ) && steps.cache.outputs.cache-hit != 'true'
run: pip install git+https://${{ secrets.ACTIONS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
+ - name: Update Languages
+ run: python ./scripts/docs.py update-languages
- name: Build Docs
- run: python ./scripts/docs.py build-all
- - name: Zip docs
- run: bash ./scripts/zip-docs.sh
+ run: python ./scripts/docs.py build-lang ${{ matrix.lang }}
- uses: actions/upload-artifact@v3
with:
- name: docs-zip
- path: ./site/docs.zip
- - name: Deploy to Netlify
- uses: nwtgck/actions-netlify@v2.0.0
+ name: docs-site
+ path: ./site/**
+
+ # https://github.com/marketplace/actions/alls-green#why
+ docs-all-green: # This job does nothing and is only used for the branch protection
+ if: always()
+ needs:
+ - build-docs
+ runs-on: ubuntu-latest
+ steps:
+ - name: Decide whether the needed jobs succeeded or failed
+ uses: re-actors/alls-green@release/v1
with:
- publish-dir: './site'
- production-branch: master
- github-token: ${{ secrets.FASTAPI_BUILD_DOCS_NETLIFY }}
- enable-commit-comment: false
- env:
- NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
- NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+ jobs: ${{ toJSON(needs) }}
+ allowed-skips: build-docs
diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/deploy-docs.yml
similarity index 79%
rename from .github/workflows/preview-docs.yml
rename to .github/workflows/deploy-docs.yml
index da98f5d2b..312d835af 100644
--- a/.github/workflows/preview-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -1,4 +1,4 @@
-name: Preview Docs
+name: Deploy Docs
on:
workflow_run:
workflows:
@@ -7,9 +7,13 @@ on:
- completed
jobs:
- preview-docs:
+ deploy-docs:
runs-on: ubuntu-latest
steps:
+ - name: Dump GitHub context
+ env:
+ GITHUB_CONTEXT: ${{ toJson(github) }}
+ run: echo "$GITHUB_CONTEXT"
- uses: actions/checkout@v3
- name: Clean site
run: |
@@ -23,21 +27,15 @@ jobs:
github_token: ${{ secrets.FASTAPI_PREVIEW_DOCS_DOWNLOAD_ARTIFACTS }}
workflow: build-docs.yml
run_id: ${{ github.event.workflow_run.id }}
- name: docs-zip
+ name: docs-site
path: ./site/
- - name: Unzip docs
- if: steps.download.outputs.found_artifact == 'true'
- run: |
- cd ./site
- unzip docs.zip
- rm -f docs.zip
- name: Deploy to Netlify
if: steps.download.outputs.found_artifact == 'true'
id: netlify
uses: nwtgck/actions-netlify@v2.0.0
with:
publish-dir: './site'
- production-deploy: false
+ production-deploy: ${{ github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'master' }}
github-token: ${{ secrets.FASTAPI_PREVIEW_DOCS_NETLIFY }}
enable-commit-comment: false
env:
diff --git a/.gitignore b/.gitignore
index a26bb5cd6..3cb64c047 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,6 +16,7 @@ Pipfile.lock
env3.*
env
docs_build
+site_build
venv
docs.zip
archive.zip
diff --git a/scripts/docs.py b/scripts/docs.py
index e0953b8ed..c464f8dbe 100644
--- a/scripts/docs.py
+++ b/scripts/docs.py
@@ -1,3 +1,4 @@
+import json
import os
import re
import shutil
@@ -133,75 +134,83 @@ def build_lang(
build_lang_path = build_dir_path / lang
en_lang_path = Path("docs/en")
site_path = Path("site").absolute()
+ build_site_path = Path("site_build").absolute()
+ build_site_dist_path = build_site_path / lang
if lang == "en":
dist_path = site_path
else:
dist_path: Path = site_path / lang
shutil.rmtree(build_lang_path, ignore_errors=True)
shutil.copytree(lang_path, build_lang_path)
- shutil.copytree(en_docs_path / "data", build_lang_path / "data")
- overrides_src = en_docs_path / "overrides"
- overrides_dest = build_lang_path / "overrides"
- for path in overrides_src.iterdir():
- dest_path = overrides_dest / path.name
- if not dest_path.exists():
- shutil.copy(path, dest_path)
- en_config_path: Path = en_lang_path / mkdocs_name
- en_config: dict = mkdocs.utils.yaml_load(en_config_path.read_text(encoding="utf-8"))
- nav = en_config["nav"]
- lang_config_path: Path = lang_path / mkdocs_name
- lang_config: dict = mkdocs.utils.yaml_load(
- lang_config_path.read_text(encoding="utf-8")
- )
- lang_nav = lang_config["nav"]
- # Exclude first 2 entries FastAPI and Languages, for custom handling
- use_nav = nav[2:]
- lang_use_nav = lang_nav[2:]
- file_to_nav = get_file_to_nav_map(use_nav)
- sections = get_sections(use_nav)
- lang_file_to_nav = get_file_to_nav_map(lang_use_nav)
- use_lang_file_to_nav = get_file_to_nav_map(lang_use_nav)
- for file in file_to_nav:
- file_path = Path(file)
- lang_file_path: Path = build_lang_path / "docs" / file_path
- en_file_path: Path = en_lang_path / "docs" / file_path
- lang_file_path.parent.mkdir(parents=True, exist_ok=True)
- if not lang_file_path.is_file():
- en_text = en_file_path.read_text(encoding="utf-8")
- lang_text = get_text_with_translate_missing(en_text)
- lang_file_path.write_text(lang_text, encoding="utf-8")
- file_key = file_to_nav[file]
- use_lang_file_to_nav[file] = file_key
- if file_key:
- composite_key = ()
- new_key = ()
- for key_part in file_key:
- composite_key += (key_part,)
- key_first_file = sections[composite_key]
- if key_first_file in lang_file_to_nav:
- new_key = lang_file_to_nav[key_first_file]
- else:
- new_key += (key_part,)
- use_lang_file_to_nav[file] = new_key
- key_to_section = {(): []}
- for file, orig_file_key in file_to_nav.items():
- if file in use_lang_file_to_nav:
- file_key = use_lang_file_to_nav[file]
- else:
- file_key = orig_file_key
- section = get_key_section(key_to_section=key_to_section, key=file_key)
- section.append(file)
- new_nav = key_to_section[()]
- export_lang_nav = [lang_nav[0], nav[1]] + new_nav
- lang_config["nav"] = export_lang_nav
- build_lang_config_path: Path = build_lang_path / mkdocs_name
- build_lang_config_path.write_text(
- yaml.dump(lang_config, sort_keys=False, width=200, allow_unicode=True),
- encoding="utf-8",
- )
+ if not lang == "en":
+ shutil.copytree(en_docs_path / "data", build_lang_path / "data")
+ overrides_src = en_docs_path / "overrides"
+ overrides_dest = build_lang_path / "overrides"
+ for path in overrides_src.iterdir():
+ dest_path = overrides_dest / path.name
+ if not dest_path.exists():
+ shutil.copy(path, dest_path)
+ en_config_path: Path = en_lang_path / mkdocs_name
+ en_config: dict = mkdocs.utils.yaml_load(
+ en_config_path.read_text(encoding="utf-8")
+ )
+ nav = en_config["nav"]
+ lang_config_path: Path = lang_path / mkdocs_name
+ lang_config: dict = mkdocs.utils.yaml_load(
+ lang_config_path.read_text(encoding="utf-8")
+ )
+ lang_nav = lang_config["nav"]
+ # Exclude first 2 entries FastAPI and Languages, for custom handling
+ use_nav = nav[2:]
+ lang_use_nav = lang_nav[2:]
+ file_to_nav = get_file_to_nav_map(use_nav)
+ sections = get_sections(use_nav)
+ lang_file_to_nav = get_file_to_nav_map(lang_use_nav)
+ use_lang_file_to_nav = get_file_to_nav_map(lang_use_nav)
+ for file in file_to_nav:
+ file_path = Path(file)
+ lang_file_path: Path = build_lang_path / "docs" / file_path
+ en_file_path: Path = en_lang_path / "docs" / file_path
+ lang_file_path.parent.mkdir(parents=True, exist_ok=True)
+ if not lang_file_path.is_file():
+ en_text = en_file_path.read_text(encoding="utf-8")
+ lang_text = get_text_with_translate_missing(en_text)
+ lang_file_path.write_text(lang_text, encoding="utf-8")
+ file_key = file_to_nav[file]
+ use_lang_file_to_nav[file] = file_key
+ if file_key:
+ composite_key = ()
+ new_key = ()
+ for key_part in file_key:
+ composite_key += (key_part,)
+ key_first_file = sections[composite_key]
+ if key_first_file in lang_file_to_nav:
+ new_key = lang_file_to_nav[key_first_file]
+ else:
+ new_key += (key_part,)
+ use_lang_file_to_nav[file] = new_key
+ key_to_section = {(): []}
+ for file, orig_file_key in file_to_nav.items():
+ if file in use_lang_file_to_nav:
+ file_key = use_lang_file_to_nav[file]
+ else:
+ file_key = orig_file_key
+ section = get_key_section(key_to_section=key_to_section, key=file_key)
+ section.append(file)
+ new_nav = key_to_section[()]
+ export_lang_nav = [lang_nav[0], nav[1]] + new_nav
+ lang_config["nav"] = export_lang_nav
+ build_lang_config_path: Path = build_lang_path / mkdocs_name
+ build_lang_config_path.write_text(
+ yaml.dump(lang_config, sort_keys=False, width=200, allow_unicode=True),
+ encoding="utf-8",
+ )
current_dir = os.getcwd()
os.chdir(build_lang_path)
- subprocess.run(["mkdocs", "build", "--site-dir", dist_path], check=True)
+ shutil.rmtree(build_site_dist_path, ignore_errors=True)
+ shutil.rmtree(dist_path, ignore_errors=True)
+ subprocess.run(["mkdocs", "build", "--site-dir", build_site_dist_path], check=True)
+ shutil.copytree(build_site_dist_path, dist_path, dirs_exist_ok=True)
os.chdir(current_dir)
typer.secho(f"Successfully built docs for: {lang}", color=typer.colors.GREEN)
@@ -271,18 +280,8 @@ def build_all():
Build mkdocs site for en, and then build each language inside, end result is located
at directory ./site/ with each language inside.
"""
- site_path = Path("site").absolute()
update_languages(lang=None)
- current_dir = os.getcwd()
- os.chdir(en_docs_path)
- typer.echo("Building docs for: en")
- subprocess.run(["mkdocs", "build", "--site-dir", site_path], check=True)
- os.chdir(current_dir)
- langs = []
- for lang in get_lang_paths():
- if lang == en_docs_path or not lang.is_dir():
- continue
- langs.append(lang.name)
+ langs = [lang.name for lang in get_lang_paths() if lang.is_dir()]
cpu_count = os.cpu_count() or 1
process_pool_size = cpu_count * 4
typer.echo(f"Using process pool size: {process_pool_size}")
@@ -397,6 +396,15 @@ def update_config(lang: str):
)
+@app.command()
+def langs_json():
+ langs = []
+ for lang_path in get_lang_paths():
+ if lang_path.is_dir():
+ langs.append(lang_path.name)
+ print(json.dumps(langs))
+
+
def get_key_section(
*, key_to_section: Dict[Tuple[str, ...], list], key: Tuple[str, ...]
) -> list:
diff --git a/scripts/zip-docs.sh b/scripts/zip-docs.sh
deleted file mode 100644
index 47c3b0977..000000000
--- a/scripts/zip-docs.sh
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-set -x
-set -e
-
-cd ./site
-
-if [ -f docs.zip ]; then
- rm -rf docs.zip
-fi
-zip -r docs.zip ./
From 7d865c9487eb8d7e6bcb508b933b17a5a6e8586b Mon Sep 17 00:00:00 2001
From: github-actions
Date: Sat, 24 Jun 2023 00:00:47 +0000
Subject: [PATCH 46/46] =?UTF-8?q?=F0=9F=93=9D=20Update=20release=20notes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/en/docs/release-notes.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md
index 6f43126b0..0a5f51e98 100644
--- a/docs/en/docs/release-notes.md
+++ b/docs/en/docs/release-notes.md
@@ -2,6 +2,7 @@
## Latest Changes
+* 👷 Refactor Docs CI, run in multiple workers with a dynamic matrix to optimize speed. PR [#9732](https://github.com/tiangolo/fastapi/pull/9732) by [@tiangolo](https://github.com/tiangolo).
* 🔥 Remove old internal GitHub Action watch-previews that is no longer needed. PR [#9730](https://github.com/tiangolo/fastapi/pull/9730) by [@tiangolo](https://github.com/tiangolo).
* ⬆️ Upgrade MkDocs and MkDocs Material. PR [#9729](https://github.com/tiangolo/fastapi/pull/9729) by [@tiangolo](https://github.com/tiangolo).
* 👷 Build and deploy docs only on docs changes. PR [#9728](https://github.com/tiangolo/fastapi/pull/9728) by [@tiangolo](https://github.com/tiangolo).
+
+您可以在输入框中输入消息并发送：
+
+
+
+您的 **FastAPI** 应用程序将回复：
+
+
+
+您可以发送（和接收）多条消息：
+
+
+
+所有这些消息都将使用同一个 WebSocket 连
+
+接。
+
+## 使用 `Depends` 和其他依赖项
+
+在 WebSocket 端点中，您可以从 `fastapi` 导入并使用以下内容：
+
+* `Depends`
+* `Security`
+* `Cookie`
+* `Header`
+* `Path`
+* `Query`
+
+它们的工作方式与其他 FastAPI 端点/ *路径操作* 相同：
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="68-69 82"
+ {!> ../../../docs_src/websockets/tutorial002_an_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="68-69 82"
+ {!> ../../../docs_src/websockets/tutorial002_an_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="69-70 83"
+ {!> ../../../docs_src/websockets/tutorial002_an.py!}
+ ```
+
+=== "Python 3.10+ 非带注解版本"
+
+ !!! tip
+ 如果可能，请尽量使用 `Annotated` 版本。
+
+ ```Python hl_lines="66-67 79"
+ {!> ../../../docs_src/websockets/tutorial002_py310.py!}
+ ```
+
+=== "Python 3.6+ 非带注解版本"
+
+ !!! tip
+ 如果可能，请尽量使用 `Annotated` 版本。
+
+ ```Python hl_lines="68-69 81"
+ {!> ../../../docs_src/websockets/tutorial002.py!}
+ ```
+
+!!! info
+ 由于这是一个 WebSocket，抛出 `HTTPException` 并不是很合理，而是抛出 `WebSocketException`。
+
+ 您可以使用规范中定义的有效代码。
+
+### 尝试带有依赖项的 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 3.9+"
+
+ ```Python hl_lines="79-81"
+ {!> ../../../docs_src/websockets/tutorial003_py39.py!}
+ ```
+
+=== "Python 3.6+"
+
+ ```Python hl_lines="81-83"
+ {!> ../../../docs_src/websockets/tutorial003.py!}
+ ```
+
+尝试以下操作：
+
+* 使用多个浏览器选项卡打开应用程序。
+* 从这些选项卡中发送消息。
+* 然后关闭其中一个选项卡。
+
+这将引发 `WebSocketDisconnect` 异常，并且所有其他客户端都会收到类似以下的消息：
+
+```
+Client #1596980209979 left the chat
+```
+
+!!! tip
+ 上面的应用程序是一个最小和简单的示例，用于演示如何处理和向多个 WebSocket 连接广播消息。
+
+ 但请记住，由于所有内容都在内存中以单个列表的形式处理，因此它只能在进程运行时工作，并且只能使用单个进程。
+
+ 如果您需要与 FastAPI 集成更简单但更强大的功能，支持 Redis、PostgreSQL 或其他功能，请查看 [encode/broadcaster](https://github.com/encode/broadcaster)。
+
+## 更多信息
+
+要了解更多选项，请查看 Starlette 的文档：
+
+* [WebSocket 类](https://www.starlette.io/websockets/)
+* [基于类的 WebSocket 处理](https://www.starlette.io/endpoints/#websocketendpoint)。
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index d71c8bf00..6c5001e2a 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -120,6 +120,7 @@ nav:
- advanced/response-cookies.md
- advanced/response-change-status-code.md
- advanced/response-headers.md
+ - advanced/websockets.md
- advanced/wsgi.md
- contributing.md
- help-fastapi.md
From 847befdc1df7c9f591568d982eafa622076d892a Mon Sep 17 00:00:00 2001
From: github-actions