像Django一样开发FastAPI之: AppBoot settings使用

本文将介绍 AppBoot Settings 的工作原理及其使用方式。

原理说明

虽然 AppBoot Settings 的设计与 Django settings 相似,但它的实现方式有明显的不同。你可以将整个 settings.py 模块理解为 pydantic-settings 的一个配置类。因此,在 AppBoot 项目中,配置 settings.py 文件时,必须为每个配置变量明确指定类型注解,否则设置将无法生效。只有明确定义了类型注解,pydantic-settings 才能正确解析配置,从而更好地与 mypy 结合,帮助构建规范且稳定的 Python 项目。

内置默认配置项介绍

python 复制代码
from appboot.conf import DataBases, DictConfig
PROJECT_NAME: str = ''  # 项目名称
USE_TZ: bool = True  # 是否使用时区
TIME_ZONE: str = 'Asia/Shanghai'  # 时区配置
DATABASES: DataBases = DataBases(default=dict(url='sqlite+aiosqlite:///:memory:'))  # 数据库配置
FASTAPI: DictConfig = {}  # FastAPI 应用初始化参数配置
ALLOWED_HOSTS: list[str] = ['*']  # 允许的跨站请求域名,默认所有域名都允许
ROOT_URLCONF: str = ''  # 项目路由配置文件
DEFAULT_TABLE_NAME_PREFIX: str = ''  # 全局数据表名称前缀配置

如何覆盖不同环境下的配置项

由于 AppBoot 是通过 pydantic-settings 实现的,因此天然支持通过环境变量或配置文件加载设置。详细使用方法可以参考 pydantic-settings 文档。

配置覆盖的优先级如下:
settings.py < 文件配置 < 环境变量配置

例如,配置数据库连接如下:

python 复制代码
from appboot.conf import DataBases
DATABASES: DataBases = DataBases(
    default=dict(url=f'sqlite+aiosqlite:///db.sqlite3')
)

可以通过设置以下环境变量来覆盖数据库配置:

shell 复制代码
# 设置环境变量
export DATABASES='{"default": {"url": "sqlite+aiosqlite:///environment.sqlite3"}}'

或者使用嵌套属性:

shell 复制代码
# 设置环境变量
export DATABASES__default__url='sqlite+aiosqlite:///environment.sqlite3'

这两种方式都可以覆盖 settings.py 中的默认配置,因为环境变量的优先级最高。此外,AppBoot 默认支持从 .env 文件中加载配置, 配置的格式和环境变量一致。

相关推荐
酷飞飞34 分钟前
Python网络与多任务编程:TCP/UDP实战指南
网络·python·tcp/ip
数字化顾问2 小时前
Python:OpenCV 教程——从传统视觉到深度学习:YOLOv8 与 OpenCV DNN 模块协同实现工业缺陷检测
python
学生信的大叔3 小时前
【Python自动化】Ubuntu24.04配置Selenium并测试
python·selenium·自动化
计算机编程小央姐3 小时前
跟上大数据时代步伐:食物营养数据可视化分析系统技术前沿解析
大数据·hadoop·信息可视化·spark·django·课程设计·食物
诗句藏于尽头4 小时前
Django模型与数据库表映射的两种方式
数据库·python·django
智数研析社4 小时前
9120 部 TMDb 高分电影数据集 | 7 列全维度指标 (评分 / 热度 / 剧情)+API 权威源 | 电影趋势分析 / 推荐系统 / NLP 建模用
大数据·人工智能·python·深度学习·数据分析·数据集·数据清洗
扯淡的闲人4 小时前
多语言编码Agent解决方案(5)-IntelliJ插件实现
开发语言·python
moxiaoran57534 小时前
Flask学习笔记(一)
后端·python·flask
秋氘渔5 小时前
迭代器和生成器的区别与联系
python·迭代器·生成器·可迭代对象
Gu_shiwww5 小时前
数据结构8——双向链表
c语言·数据结构·python·链表·小白初步