概要
在 Python 应用中,为了将配置信息与代码分离、增强安全性并支持多环境(开发、测试、生产)运行,使用专门的模块来管理环境变量是最佳实践。常见工具包括:
-
标准库
os.environ
:直接读取操作系统环境变量,适合简单场景; -
python-dotenv
:从.env
文件加载变量到os.environ
,符合十二要素应用 (PyPI); -
python-decouple
:更严格地将配置与代码分离,支持类型转换、INI 和.env
双格式文件 (PyPI); -
environs
:简化变量解析与验证,支持多种类型、变量前缀、.env
文件和框架集成 (PyPI); -
django-environ
:面向 Django 项目,解析数据库 URL 等特殊变量并填充os.environ
(django-environ.readthedocs.io); -
dynaconf
:分层配置系统,支持多格式配置文件(TOML/YAML/JSON/INI)、Vault/Redis、环境变量覆盖和 CLI 工具 (dynaconf.com, dynaconf.readthedocs.io); -
Pydantic
BaseSettings
:利用类型注解和校验,从环境变量或.env
文件自动生成配置对象,并内建校验功能 (docs.pydantic.dev)。
下面将逐一介绍这些方案的特点、安装与使用示例,并给出选型建议与最佳实践。
1. 标准库:os.environ
特点
-
直接映射操作系统的环境变量为字典接口,无额外依赖 (GeeksforGeeks)。
-
适用于简单脚本或少量变量的场景。
用法
import os
# 读取
DEBUG = os.getenv('DEBUG', 'False') == 'True'
# 或抛错获取
DATABASE_URL = os.environ['DATABASE_URL']
局限
-
不支持
.env
文件或类型转换; -
管理大量环境变量时难以维护;
-
无法本地化加载,开发调试不便利。
2. python-dotenv
安装
pip install python-dotenv
``` :contentReference[oaicite:7]{index=7}
### 主要功能
- 从项目根目录或指定路径的 `.env` 文件加载键值对到 `os.environ`;
- 支持多行值、变量展开(`${VAR}`)、命令行接口 :contentReference[oaicite:8]{index=8}。
### 用法示例
```python
# app.py
from dotenv import load_dotenv
import os
# 自动从当前目录或上级目录查找 .env
load_dotenv()
SECRET_KEY = os.getenv('SECRET_KEY')
DEBUG = os.getenv('DEBUG', 'False') == 'True'
3. python-decouple
安装
pip install python-decouple
``` :contentReference[oaicite:9]{index=9}
### 主要功能
- 严格分离设置与代码:支持 INI 或 `.env` 文件;
- 自动类型转换(`int`, `bool`, `list` 等);
- 默认值与必需参数校验;
- 单一配置模块管理所有环境 :contentReference[oaicite:10]{index=10}。
### 用法示例
```ini
# .env
DEBUG=True
SECRET_KEY=abc123
TIMEOUT=30
# settings.py
from decouple import config, Csv
DEBUG = config('DEBUG', default=False, cast=bool)
SECRET_KEY = config('SECRET_KEY')
ALLOWED_HOSTS = config('ALLOWED_HOSTS', default='', cast=Csv())
TIMEOUT = config('TIMEOUT', default=10, cast=int)
4. environs
安装
pip install environs
``` :contentReference[oaicite:11]{index=11}
### 主要功能
- 类型安全的变量解析(支持 `list`、`datetime`、`URL` 等多种类型);
- 读取 `.env` 文件到 `os.environ`;
- 支持前缀过滤、变量展开、延迟验证;
- 与 Flask、Django 集成 :contentReference[oaicite:12]{index=12}。
### 用法示例
```python
from environs import Env
env = Env()
# 读取 .env
env.read_env()
DEBUG = env.bool("DEBUG", default=False)
DATABASE_URL = env.str("DATABASE_URL")
ALLOWED_HOSTS = env.list("ALLOWED_HOSTS", default=["*"])
5. django-environ
安装
pip install django-environ
``` :contentReference[oaicite:13]{index=13}
### 主要功能
- 专为 Django 设计,解析数据库、缓存、邮件等 URL 格式配置;
- 读取 `.env` 文件并填充 `os.environ`;
- 简化 Django `settings.py` 的多环境管理。
### 用法示例
```python
# settings.py
import environ
env = environ.Env(DEBUG=(bool, False))
# 从项目根目录加载 .env
environ.Env.read_env()
DEBUG = env('DEBUG')
DATABASES = {'default': env.db()} # 解析 DATABASE_URL
CACHES = {'default': env.cache()} # 解析 CACHE_URL
SECRET_KEY = env('SECRET_KEY')
6. dynaconf
安装
pip install dynaconf
``` :contentReference[oaicite:14]{index=14}
### 主要功能
- 支持多种配置格式:TOML(推荐)、YAML、JSON、INI、Python 文件;
- 分层环境 (`[default]`, `[development]`, `[production]`);
- 环境变量覆盖与 `.env` 文件支持;
- 可选 Vault、Redis 等外部存储;
- CLI 工具 (`dynaconf init`, `dynaconf list`, `dynaconf export`);
- Flask/Django 扩展;
- 校验与特性开关。 :contentReference[oaicite:15]{index=15}
### 用法示例
```bash
# 初始化项目
dynaconf init -f toml
# settings.toml
[default]
DEBUG = true
[production]
DEBUG = false
# config.py
from dynaconf import Dynaconf
settings = Dynaconf(
settings_files=['settings.toml', '.secrets.toml'],
environments=True,
)
# 使用
print(settings.DEBUG)
7. Pydantic BaseSettings
安装
pip install pydantic-settings
``` :contentReference[oaicite:16]{index=16}
### 主要功能
- 利用 Pydantic 模型与类型注解,自动载入环境变量或 `.env` 文件;
- 内建类型校验与默认值;
- 支持多源(环境、文件、命令行);
- 易于测试,可通过 `_env_file` 参数指定 `.env` 路径 :contentReference[oaicite:17]{index=17}。
### 用法示例
```python
from pydantic_settings import BaseSettings, SettingsConfigDict
class Settings(BaseSettings):
DEBUG: bool = False
DATABASE_URL: str
model_config = SettingsConfigDict(env_file=".env")
# 全局单例获取
settings = Settings()
print(settings.DATABASE_URL)
最佳实践
-
不将
.env
文件提交到 VCS,使用.env.example
提供模板; -
在 CI/CD 中安全注入环境变量,避免明文出现在日志;
-
使用单一配置入口(如
config.py
或settings.py
),集中管理; -
对必需变量进行启动时校验,及早发现配置缺失;
-
在大型项目中推荐分层或工厂模式(如 Dynaconf 环境分层、应用工厂模式)以利扩展;
-
注重类型与验证,优先选择 Pydantic、Environs 等支持自动校验的库。
通过上述工具和实践,你可以为不同规模和需求的 Python 应用,选用最合适的环境变量管理方案,确保配置安全、可维护且易于切换。