面向企业应用程序的 Python 配置管理

配置管理的重要性

    在企业应用程序中，配置管理是最被低估的运算符，它使所有内容保持集成并平稳运行。它充当后台经理，确保所有灯光都就位，剧院队列准备就绪，演出可以顺利进行。特别是，在处理多环境部署时，使用紧密的 CI/CD 流程，一个错误的配置可能会带来应用程序范围的关闭风险。

    多环境企业应用程序有其自身的一系列挑战，管理配置也不例外。我们都听过著名的“但是，它在我的机器上工作”的借口比日常问候的次数还要多。

在大型 Python 应用程序中，不一致或管理不善的配置可能会导致：

1. 停机时间：一个配置错误的环境变量可以确保应用程序范围的关闭！
2. 错误：不一致的环境特定配置可以并且将确保您在尝试调试 “403：Forbidden” 错误时失去睡眠。
3. 开发人员头疼的问题：以上所有内容都会花费大量资源。

    总之，如果没有适当的配置管理，应用程序最终可能会陷入没有人愿意接触的困境。

制定配置管理战略：3 条黄金法则

遵循以下 3 项原则可以帮助您构建更高效、更健壮的配置管理策略：

1. 不要重复自己 （DRY）

    为了确保一致性和易于维护性，请集中您的配置。如果应用程序的不同组件使用相同的值，该值在代码库中分散了初始化，则它是集中式配置键值对的良好候选者。

2. 保持简单

    配置应尽可能简单。如果有人需要博士学位来理解配置文件，那你就错了。可维护性由简单性驱动。

3. 确保安全

    切勿在代码中使用核心敏感信息，如 API 密钥、密码或 PII 数据。始终使用环境变量（至少）或专用的密钥管理工具（推荐），例如 Secrets Manager/HashiCorp Vault 来确保此信息的安全。

Python 的配置管理工具

    Python 以各种库和模块的形式提供了各种配置管理工具，让生活更轻松。

1. configparser：管理类似 Windows 的 INI 文件的首选工具，它简单、有效且非常适合小型应用程序。主要缺点是没有类型安全。简单来说，这意味着您在 INI 文件中提供的每个值都被读取为字符串。
2. json 和 YAML：JSON 和 YAML 更易于阅读，非常适合具有嵌套配置的复杂应用程序。就像 INI 文件一样，JSON 和 YAML 不能确保类型安全/验证。
3. dotenv：使用 .env 文件管理环境变量。这里唯一的缺点是所有内容都以明文形式存储。这可能是中型应用程序的候选项。
4. 设置类 - Pydantic 和 dynaconf：提供开箱即用的经得起验证的类，确保配置始终经过类型检查和验证。通过允许支持多种文件格式的多层配置来提供额外的优势pydanticSettingsdynaconf

使用 Settings 类编写示例配置

请参阅以下示例以定义各种设置或配置参数及其验证。

当创建继承自 的模型时，模型初始值设定项将尝试通过访问环境来确定未作为关键字参数提供的任何字段的值。如果未设置相应的环境变量，则将使用默认值。BaseSettings

这使得：

• 创建一个明确定义的、类型提示的应用程序配置类。
• 从环境变量中自动读取对配置的修改。
• 根据需要（例如，在单元测试中）手动覆盖初始化器中的特定设置。

    正如你在这里看到的，我们定义了类，但没有分配任何值。原因是我们可以灵活地从环境文件中读取数据，也可以从更安全的基于云的密钥管理工具中读取数据。Config

结论

这是一个小的比较表，可帮助您选择最适合您需求的产品。