使用 Pydantic 和 .env 文件管理环境配置

原创

已于 2025-03-30 20:50:18 修改 · 1k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#python

于 2025-03-16 16:44:18 首次发布

该文章已生成可运行项目，

Pydantic 是一个 Python 第三方包，用于数据验证和设置管理。它通过类型注解自动验证和解析数据，确保数据符合预期格式，并且能够生成清晰的错误信息。

这里主要介绍使用 Pydantic 和 .env 文件来管理环境配置。

1、安装依赖库

Pydantic 第一个版本时，安装 Pydantic 库就可以了，而第二个版本之后，settings 相关的功能被拆分到独立的包了。独立出来的包叫 pydantic-settings ，目前最新版本为 2.8.1。

现在只需要安装 pydantic-settings 包，安装命令如下：

pip install pydantic-settings==2.8.1

安装 pydantic-settings 包时，会自动安装其他 pydantic、python-dotenv 等依赖包。

2、创建 .env 文件

创建一个 .env 文件，根据具体项目需要填入相应的内容。例如：

DATABASE_URL=your_database_url
DATABASE_USERNAME=your_username
DATABASE_PASSWORD=your_password

3、创建 config.py 文件

创建一个 config.py 文件，在里面创建一个 Settings 类，该类继承自 pydantic_settings 的 BaseSettings 类。Settings 类添加和 .env 文件里的环境变量相同的类属性，并创建一个 model_config 类属性，用 SettingsConfigDict 初始化该类属性。

代码如下：

from pydantic_settings import BaseSettings, SettingsConfigDict  
  
  
class Settings(BaseSettings):  
    DATABASE_URL: str  
    DATABASE_USERNAME: str  
    DATABASE_PASSWORD: str  
  
    model_config = SettingsConfigDict(  
        env_file=