背景
- 在许多情况下，应用程序可能需要一些外部设置或配置，例如密钥、数据库凭据、电子邮件服务凭据等。
- 大多数这些设置都是可变的（可以更改），例如数据库 URL，很多可能是敏感数据，比如密码
- 出于这个原因，通常在应用程序读取的环境变量中提供它们
Pydantic Settings
- Pydantic 提供了一个很好的实用程序来处理环境变量的设置
- 从 Pydantic 导入 BaseSettings 并创建一个子类，非常类似于 Pydantic 的 BaseModel
- 与 Pydantic Model 一样，可以使用类型注释和默认值声明类属性
- 可以使用和 Pydantic Model 的所有相同验证功能和工具，例如不同的数据类型和使用 Field()
#!usr/bin/env python # -*- coding:utf-8 _*- """ # author: 小菠萝测试笔记 # blog: https://www.cnblogs.com/poloyy/ # time: 2021/10/9 7:25 下午 # file: 52_settings_env.py """ import os import uvicorn 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 该类的实例时，Pydantic 将以不区分大小写的方式读取环境变量
- 因此，仍会为属性 app_name 读取为大写变量 APP_NAME
- 接下来它将转换和验证数据
- 因此，当使用该 settings 对象时，将拥有声明的类型的数据（例如 items_per_user 是 int）
运行 uvicorn 服务器
要为单个命令设置多个环境变量，只需用空格分隔它们，并将它们全部放在命令之前
ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp" uvicorn main:app
访问 /info 接口
Settings 跨模块调用
config.py
from pydantic import BaseSettings class Settings(BaseSettings): app_name: str = "Awesome API" admin_email: str items_per_user: int = 50 settings = Settings()
main.py
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, }
Settings 在依赖项中
前言
- 在某些情况下，提供依赖项的 Settings 会有用，而不是让全局对象拥有可随处使用的 Settings
- 在测试期间会有用，因为使用自定义 Settings 覆盖依赖项非常容易
config.py
from pydantic import BaseSettings
class Settings(BaseSettings):
app_name: str = "Awesome API"
admin_email: str
items_per_user: int = 50
这里不创建默认实例 settings = Settings()
main.py
from fastapi import FastAPI, Depends from functools import lru_cache from .config import Settings app = FastAPI() @lru_cache def get_settings(): return Settings @app.get("/info") async def info(settings: Settings = Depends(get_settings)): return { "app_name": settings.app_name, "admin_email": settings.admin_email, "items_per_user": settings.items_per_user, }
测试上述接口
from fastapi.testclient import TestClient from .config import Settings from .main import app, get_settings client = TestClient(app) # 依赖覆盖，为 Settings 对象设置一个新的 admin_email 值 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, }
