Python-dotenv 处理多行环境变量的最佳实践

在 Python 项目中使用环境变量管理敏感信息时，python-dotenv 是一个常用的工具。然而当遇到包含换行符的多行内容（如 RSA 私钥）时，开发者可能会遇到一些特殊挑战。本文将深入探讨如何正确处理这类场景。

多行环境变量的常见问题

典型的应用场景包括存储以下内容：

• 加密密钥（如 RSA 私钥）
• 证书文件内容
• 多行配置文本

当这些内容被直接写入 .env 文件时，例如：

PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nMII...\n-----END PRIVATE KEY-----\n"

使用常规的 dotenv list 命令输出后，如果直接通过 eval 执行会导致 Bash 解析错误，因为换行符会被解释为命令分隔符。

python-dotenv 的解决方案

1. 使用正确的输出格式

python-dotenv 提供了多种输出格式选项，其中对 Shell 环境友好的有：

• shell 格式：生成适合 Shell 解析的带引号输出
• export 格式：生成带 export 关键字的 Shell 可执行格式

正确用法示例：

eval $(dotenv -f .env list --format shell)

2. 文件写入时的注意事项

当使用 dotenv set 命令写入变量时：

• -e/--export 参数控制是否添加 export 前缀
• 换行符会自动转换为 \n 转义序列

写入示例：

dotenv -e 1 set MULTILINE "Line1\nLine2"

3. 替代方案：Base64 编码

对于特别复杂的多行内容，可以采用编码方案：

# 写入时编码
dotenv set CERT_BASE64 "$(base64 cert.pem)"

# 读取时解码
eval $(dotenv list --format shell)
echo $CERT_BASE64 | base64 -d > cert.pem

最佳实践建议

1. 对于需要被 Shell 脚本使用的环境变量：

   • 始终使用 --format shell 或 --format export
   • 避免直接 eval 简单列表输出

2. 对于 Python 程序内部使用：

   • 标准 .env 文件格式即可良好支持
   • python-dotenv 会自动处理换行符转义

3. 敏感信息存储：

   • 考虑结合加密方案
   • 对于密钥类内容，优先使用专用密钥管理系统

通过理解这些机制，开发者可以安全可靠地在项目中管理各种复杂的环境变量配置。