如何为Python非Web/API应用配置多环境专属参数及最佳实践咨询

一、Stage/Prod环境数据库配置的指定方式（结合ADO构建发布管道） #

1. 管道变量组注入（推荐，完全解耦代码与配置） #

在ADO中创建两个独立的变量组，比如Stage-DB-Config和Prod-DB-Config，分别存储对应环境的数据库信息：DB_HOST、DB_NAME、DB_USER、DB_PASSWORD等。

• 发布到Stage环境时，关联Stage-DB-Config变量组；发布到Prod时关联Prod-DB-Config。
• 在发布管道的任务中，将变量写入目标VM的配置文件，或者直接作为环境变量注入应用运行环境：
  • 示例：用PowerShell生成.env文件（适合用python-dotenv读取的场景）：

    @"
    DB_HOST=$(DB_HOST)
    DB_NAME=$(DB_NAME)
    DB_USER=$(DB_USER)
    DB_PASSWORD=$(DB_PASSWORD)
    "@ | Out-File -FilePath "C:\your-app-path\.env" -Encoding utf8
    

  • 示例：直接设置环境变量并启动应用（Windows CMD）：

    set DB_HOST=$(DB_HOST) && set DB_NAME=$(DB_NAME) && python your-app.py
    

2. 模板配置文件+管道替换 #

在代码仓库中存放模板配置文件（如config.template.ini），用占位符标记需要替换的环境专属内容：

[database]
host = {{DB_HOST}}
name = {{DB_NAME}}
user = {{DB_USER}}
password = {{DB_PASSWORD}}

在ADO发布管道中添加「Replace Tokens」任务，根据目标环境的变量替换占位符，生成对应环境的config.ini后推送到VM。

二、非Web/API型Python应用配置最佳实践 #

1. 配置与代码完全解耦 #

绝对不要在代码中硬编码任何环境专属配置（数据库地址、密码等），所有配置都从外部读取：环境变量、配置文件或安全存储（如密钥库）。这样同一套代码可以直接在所有环境运行，无需修改。

2. 敏感信息加密保护 #

• 数据库密码、密钥这类敏感数据，在ADO变量组中设置为「保密」变量，避免明文暴露；
• 若使用Azure环境，可将敏感配置存储在Azure Key Vault，发布管道中通过任务拉取密钥值，全程不泄露明文。

3. 分层配置策略 #

采用「默认配置+环境覆盖」的模式，确保基础配置统一，环境专属配置按需覆盖：

from dotenv import load_dotenv
import os

# 加载默认基础配置（存于代码仓库，如.env.default）
load_dotenv('.env.default')
# 加载环境专属配置（管道生成，如.env），覆盖默认值
load_dotenv('.env', override=True)

db_config = {
    'host': os.getenv('DB_HOST'),
    'name': os.getenv('DB_NAME'),
    'user': os.getenv('DB_USER'),
    'password': os.getenv('DB_PASSWORD')
}

4. 启动时配置验证 #

应用启动前强制验证所有必要配置项是否存在，避免运行中因缺失配置导致崩溃：

required_configs = ['DB_HOST', 'DB_NAME', 'DB_USER', 'DB_PASSWORD']
missing_configs = [key for key in required_configs if not os.getenv(key)]
if missing_configs:
    raise ValueError(f"Missing required configurations: {', '.join(missing_configs)}")

5. 环境差异化日志配置 #

不同环境设置不同日志级别：Stage环境用DEBUG便于排查问题，Prod环境用INFO减少日志量。将LOG_LEVEL加入环境配置，代码中动态设置：

import logging

log_level = os.getenv('LOG_LEVEL', 'INFO').upper()
logging.basicConfig(level=getattr(logging, log_level))

6. 配置文件版本化规范 #

• 模板配置文件、默认配置文件需存入代码仓库，便于版本管理；
• 环境专属的实际配置文件不要存入代码仓库，由发布管道动态生成或从安全存储拉取，防止敏感信息泄露。

内容的提问来源于stack exchange，提问作者lem