设置和环境变量¶

在许多情况下，您的应用程序可能需要一些外部设置或配置，例如密钥、数据库凭据、电子邮件服务凭据等。

这些设置中的大多数是可变的（可以更改），例如数据库 URL。许多可能是敏感的，例如密钥。

因此，通常将它们作为环境变量提供，由应用程序读取。

提示

要了解环境变量，您可以阅读环境变量。

类型和验证¶

这些环境变量只能处理文本字符串，因为它们独立于 Python，并且必须与其他程序和系统其余部分（甚至与不同的操作系统，如 Linux、Windows、macOS）兼容。

这意味着从环境变量中读取的任何值在 Python 中都将是 str，任何转换为不同类型或任何验证都必须在代码中完成。

Pydantic `Settings`¶

幸运的是，Pydantic 提供了一个出色的工具来处理来自环境变量的这些设置，使用Pydantic：设置管理。

安装 `pydantic-settings`¶

首先，请确保创建虚拟环境，激活它，然后安装 pydantic-settings 包

$ pip install pydantic-settings
---> 100%

当您安装 all 额外项时，它也包含在内

$ pip install "fastapi[all]"
---> 100%

信息

在 Pydantic v1 中，它包含在主包中。现在它作为这个独立的包分发，这样您就可以选择安装它，或者如果不需要该功能则不安装。

创建 `Settings` 对象¶

从 Pydantic 导入 BaseSettings 并创建一个子类，这与 Pydantic 模型非常相似。

与 Pydantic 模型一样，您声明带有类型注释的类属性，并可能包含默认值。

您可以使用与 Pydantic 模型相同的所有验证功能和工具，例如不同的数据类型和使用 Field() 进行的额外验证。

Pydantic v2Pydantic v1

Python 3.8+

from fastapi import FastAPI
from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50


settings = Settings()
app = FastAPI()


@app.get("/info")
async def info():
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

信息

在 Pydantic v1 中，您将直接从 pydantic 导入 BaseSettings，而不是从 pydantic_settings 导入。

Python 3.8+

from fastapi import FastAPI
from pydantic import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50


settings = Settings()
app = FastAPI()


@app.get("/info")
async def info():
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

提示

如果您想要快速复制粘贴，请不要使用此示例，请使用下面的最后一个示例。

然后，当您创建该 Settings 类的一个实例（在本例中，在 settings 对象中）时，Pydantic 将以不区分大小写的方式读取环境变量，因此，大写变量 APP_NAME 仍将用于属性 app_name。

接下来它将转换并验证数据。因此，当您使用该 settings 对象时，您将拥有声明类型的数据（例如 items_per_user 将是一个 int）。

使用 `settings`¶

然后您可以在应用程序中使用新的 settings 对象

Python 3.8+

from fastapi import FastAPI
from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50


settings = Settings()
app = FastAPI()


@app.get("/info")
async def info():
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

运行服务器¶

接下来，您将运行服务器，将配置作为环境变量传递，例如您可以设置 ADMIN_EMAIL 和 APP_NAME

$ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" fastapi run main.py

<span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

提示

要为一个命令设置多个环境变量，只需用空格分隔它们，并将它们全部放在命令之前。

然后 admin_email 设置将设置为 "deadpool@example.com"。

app_name 将是 "ChimichangApp"。

items_per_user 将保持其默认值 50。

在另一个模块中的设置¶

您可以将这些设置放在另一个模块文件中，如您在大型应用程序 - 多个文件中看到的那样。

例如，您可以有一个 config.py 文件

Python 3.8+

from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50


settings = Settings()

然后在一个 main.py 文件中使用它

Python 3.8+

from fastapi import FastAPI

from .config import settings

app = FastAPI()


@app.get("/info")
async def info():
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

提示

您还需要一个 __init__.py 文件，如您在大型应用程序 - 多个文件中看到的那样。

依赖中的设置¶

在某些情况下，从依赖项提供设置可能很有用，而不是拥有一个全局对象 settings 在所有地方使用。

这在测试期间特别有用，因为使用自定义设置覆盖依赖项非常容易。

配置文件¶

根据前面的示例，您的 config.py 文件可能如下所示

Python 3.8+

from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50

请注意，现在我们不创建默认实例 settings = Settings()。

主应用程序文件¶

现在我们创建一个返回新的 config.Settings() 的依赖项。

Python 3.8+

from functools import lru_cache
from typing import Annotated

from fastapi import Depends, FastAPI

from .config import Settings

app = FastAPI()


@lru_cache
def get_settings():
    return Settings()


@app.get("/info")
async def info(settings: Annotated[Settings, Depends(get_settings)]):
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

提示

我们稍后将讨论 @lru_cache。

现在您可以假设 get_settings() 是一个普通函数。

然后我们可以将其作为依赖项从 _路径操作函数_ 中请求，并在任何需要的地方使用它。

Python 3.8+

from functools import lru_cache
from typing import Annotated

from fastapi import Depends, FastAPI

from .config import Settings

app = FastAPI()


@lru_cache
def get_settings():
    return Settings()


@app.get("/info")
async def info(settings: Annotated[Settings, Depends(get_settings)]):
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

设置和测试¶

然后，通过为 get_settings 创建一个依赖项覆盖，在测试期间提供不同的设置对象将非常容易

Python 3.8+

from fastapi.testclient import TestClient

from .config import Settings
from .main import app, get_settings

client = TestClient(app)


def get_settings_override():
    return Settings(admin_email="testing_admin@example.com")


app.dependency_overrides[get_settings] = get_settings_override


def test_app():
    response = client.get("/info")
    data = response.json()
    assert data == {
        "app_name": "Awesome API",
        "admin_email": "testing_admin@example.com",
        "items_per_user": 50,
    }

在依赖项覆盖中，我们在创建新的 Settings 对象时为 admin_email 设置一个新值，然后返回该新对象。

然后我们可以测试它是否被使用。

读取 `.env` 文件¶

如果您有许多可能在不同环境中经常更改的设置，将它们放在文件中，然后像环境变量一样从文件中读取它们可能很有用。

这种做法很常见，以至于它有一个名称，这些环境变量通常放在 .env 文件中，该文件被称为“dotenv”。

提示

以点（.）开头的文件在类 Unix 系统（如 Linux 和 macOS）中是隐藏文件。

但 dotenv 文件实际上不一定具有该确切的文件名。

Pydantic 支持使用外部库从这些类型的文件中读取。您可以在Pydantic 设置：Dotenv (.env) 支持中阅读更多内容。

提示

为此，您需要 pip install python-dotenv。

`.env` 文件¶

您可以有一个 .env 文件

ADMIN_EMAIL="deadpool@example.com"
APP_NAME="ChimichangApp"

从 `.env` 读取设置¶

然后使用以下内容更新您的 config.py

Pydantic v2Pydantic v1

Python 3.8+

from pydantic_settings import BaseSettings, SettingsConfigDict


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50

    model_config = SettingsConfigDict(env_file=".env")

提示

model_config 属性仅用于 Pydantic 配置。您可以在Pydantic：概念：配置中阅读更多内容。

Python 3.8+

from pydantic import BaseSettings


class Settings(BaseSettings):
    app_name: str = "Awesome API"
    admin_email: str
    items_per_user: int = 50

    class Config:
        env_file = ".env"

提示

Config 类仅用于 Pydantic 配置。您可以在Pydantic 模型配置中阅读更多内容。

信息

在 Pydantic 版本 1 中，配置是在内部类 Config 中完成的，在 Pydantic 版本 2 中，它是在属性 model_config 中完成的。此属性接受一个 dict，为了获得自动补全和内联错误，您可以导入并使用 SettingsConfigDict 来定义该 dict。

这里我们在 Pydantic Settings 类中定义配置 env_file，并将其值设置为我们想要使用的 dotenv 文件的文件名。

使用 `lru_cache` 只创建一次 `Settings`¶

从磁盘读取文件通常是一个代价高昂（缓慢）的操作，因此您可能希望只执行一次，然后重用相同的设置对象，而不是为每个请求读取它。

但是每次我们执行

Settings()

都会创建一个新的 Settings 对象，并且在创建时会再次读取 .env 文件。

如果依赖函数只是像

def get_settings():
    return Settings()

我们将在每个请求中创建该对象，并且我们将在每个请求中读取 .env 文件。⚠️

但是由于我们在顶部使用了 @lru_cache 装饰器，Settings 对象将只创建一次，即首次调用时。✔️

Python 3.8+

from functools import lru_cache

from fastapi import Depends, FastAPI
from typing_extensions import Annotated

from . import config

app = FastAPI()


@lru_cache
def get_settings():
    return config.Settings()


@app.get("/info")
async def info(settings: Annotated[config.Settings, Depends(get_settings)]):
    return {
        "app_name": settings.app_name,
        "admin_email": settings.admin_email,
        "items_per_user": settings.items_per_user,
    }

然后对于后续请求中依赖项对 get_settings() 的任何调用，它将返回首次调用时返回的相同对象，而不是执行 get_settings() 的内部代码并创建新的 Settings 对象。

`lru_cache` 技术细节¶

@lru_cache 修改它装饰的函数，使其返回首次返回的相同值，而不是每次都执行函数代码再次计算。

因此，下面的函数将为每种参数组合执行一次。然后，这些参数组合返回的值将在每次函数以完全相同的参数组合调用时再次使用。

例如，如果您有一个函数

@lru_cache
def say_hi(name: str, salutation: str = "Ms."):
    return f"Hello {salutation} {name}"

您的程序可能会这样执行

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 function code
        execute ->> code: return the result
    end

    rect rgba(0, 255, 255, .1)
        code ->> function: say_hi(name="Camila")
        function ->> code: return stored result
    end

    rect rgba(0, 255, 0, .1)
        code ->> function: say_hi(name="Rick")
        function ->> execute: execute function code
        execute ->> code: return the result
    end

    rect rgba(0, 255, 0, .1)
        code ->> function: say_hi(name="Rick", salutation="Mr.")
        function ->> execute: execute function code
        execute ->> code: return the result
    end

    rect rgba(0, 255, 255, .1)
        code ->> function: say_hi(name="Rick")
        function ->> code: return stored result
    end

    rect rgba(0, 255, 255, .1)
        code ->> function: say_hi(name="Camila")
        function ->> code: return stored result
    end

在我们的依赖项 get_settings() 的情况下，该函数甚至不接受任何参数，因此它总是返回相同的值。

这样，它的行为几乎就像一个全局变量。但由于它使用了一个依赖函数，因此我们可以轻松地在测试中覆盖它。

@lru_cache 是 functools 的一部分，而 functools 是 Python 标准库的一部分，您可以在Python 文档中查看 @lru_cache 的更多信息。

总结¶

您可以使用 Pydantic Settings 来处理应用程序的设置或配置，并充分利用 Pydantic 模型的功能。

通过使用依赖项，您可以简化测试。
您可以与它一起使用 .env 文件。
使用 @lru_cache 可以避免为每个请求反复读取 dotenv 文件，同时允许您在测试期间覆盖它。

设置和环境变量¶

类型和验证¶

Pydantic Settings¶

安装 pydantic-settings¶

创建 Settings 对象¶

使用 settings¶

运行服务器¶

在另一个模块中的设置¶

依赖中的设置¶

配置文件¶

主应用程序文件¶

设置和测试¶

读取 .env 文件¶

.env 文件¶

从 .env 读取设置¶

使用 lru_cache 只创建一次 Settings¶

lru_cache 技术细节¶

总结¶

Pydantic `Settings`¶

安装 `pydantic-settings`¶

创建 `Settings` 对象¶

使用 `settings`¶

读取 `.env` 文件¶

`.env` 文件¶

从 `.env` 读取设置¶

使用 `lru_cache` 只创建一次 `Settings`¶

`lru_cache` 技术细节¶