os.getenv 和 load_dotenv 的使用方法
1. os.getenv
的用法
os.getenv
是 Python 标准库 os
模块提供的方法,用于读取操作系统环境变量。若需读取 .env
文件中的变量,需先通过 load_dotenv
将变量加载到环境变量中。
代码示例:
import os
# 直接读取系统环境变量(需确保变量已存在)
api_key = os.getenv("API_KEY", "default_value") # 若未找到则返回默认值
print(api_key)
2. load_dotenv
的用法
load_dotenv
是第三方库 python-dotenv
提供的函数,用于从 .env
文件加载环境变量到当前进程。需先安装库:
pip install python-dotenv
代码示例:
import os
from dotenv import load_dotenv
# 默认加载当前目录下的 .env 文件
load_dotenv()
# 指定自定义路径加载 .env 文件
load_dotenv(dotenv_path="path/to/.env", override=True) # override=True 覆盖系统变量
# 读取变量
db_host = os.getenv("DB_HOST")
secret_key = os.getenv("SECRET_KEY", "fallback_key") # 默认值
对比分析
1. 核心作用
-
load_dotenv
:
将.env
文件中的键值对加载到 Python 进程的环境变量中,支持从文件动态注入配置 。
可指定文件路径、覆盖系统变量(override=True
)和文件编码(encoding="utf-8"
)。 -
os.getenv
:
仅用于读取已存在的环境变量(无论是系统变量还是load_dotenv
加载的变量)。
若变量不存在,可返回默认值(default
参数)。
2. 使用场景
-
load_dotenv
:
适用于开发环境,通过文件管理敏感配置(如 API 密钥、数据库密码),避免硬编码 。
支持多环境配置(如.env.prod
,.env.dev
),通过加载不同文件切换环境 。 -
os.getenv
:
适用于任何需要读取环境变量的场景,包括生产环境(如从 Docker/Kubernetes 环境变量读取配置)。
3. 优先级与覆盖规则
.env
文件中的变量默认不会覆盖系统环境变量,但可通过override=True
强制覆盖 。- 变量优先级:
系统变量 >.env
文件变量(默认) → 若需优先使用.env
,需设置override=True
。
4. 错误处理
load_dotenv
:
若文件不存在,函数静默失败(不报错)。需手动检查文件是否存在:
from pathlib import Path
if Path(".env").exists():
load_dotenv()
os.getenv
:
若变量不存在且未指定默认值,返回None
。
完整示例
import os
from pathlib import Path
from dotenv import load_dotenv
# 加载 .env 文件
env_path = Path("config/.env.prod") # 自定义路径
load_dotenv(dotenv_path=env_path, override=True)
# 读取变量
database_url = os.getenv("DATABASE_URL")
api_key = os.getenv("API_KEY", "default_key")
# 使用变量
print(f"Connecting to database: {database_url}")
总结
load_dotenv
是配置加载工具,os.getenv
是变量读取工具,两者配合使用实现配置与代码的解耦。- 关键区别:
load_dotenv
用于从文件动态注入配置到环境变量,而os.getenv
仅负责读取这些变量。 - 最佳实践:
- 在开发环境使用
.env
文件管理敏感配置 。 - 生产环境通过系统环境变量或容器平台注入配置,避免提交
.env
文件到版本控制 。
- 在开发环境使用