要在Python项目中安全地加载环境变量(如API密钥),可以按照以下步骤使用 python-dotenv
库:
1 安装库
pip install python-dotenv
2 创建 .env
文件
在项目根目录下创建 .env
文件,内容格式为 键=值
:
API_KEY=your_api_key_here
# 示例:OPENAI_API_KEY=sk-xxxxx
3 加载环境变量
在Python代码中导入并调用 load_dotenv
:
from dotenv import load_dotenv
import os
# 自动从项目根目录的 .env 文件加载环境变量
load_dotenv()
# 使用环境变量(示例)
api_key = os.getenv("API_KEY")
print(api_key) # 调试时确认是否加载成功(正式代码勿泄露)
4 注意事项
-
路径问题:如果
.env
不在项目根目录,需指定路径:
load_dotenv("/path/to/.env") # 绝对路径
# 或
from dotenv import find_dotenv
load_dotenv(find_dotenv()) # 自动查找 .env 位置
-
安全保护:
-
将
.env
添加到.gitignore
,避免提交到版本控制。 -
不要在代码中硬编码敏感信息。
-
-
变量命名:建议使用大写(如
API_KEY
),这是环境变量的常见约定。
5 完整示例
假设 .env
内容:
OPENAI_API_KEY=sk-abc123
代码:
from dotenv import load_dotenv
import os
load_dotenv() # 加载 .env 文件
# 安全获取API密钥
openai_api_key = os.getenv("OPENAI_API_KEY")
# 使用密钥(示例:调用OpenAI API)
# import openai
# openai.api_key = openai_api_key
# ...其他操作...