扩展Conda的标准方法：如何在conda.yaml中安全添加自定义元数据

存在完全兼容原生Conda的标准扩展方案，不会对不使用相关工具的普通用户造成任何影响，核心是使用Conda官方预留的metadata顶层字段。

实现原理 #

• Conda 环境配置文件（常被称为 conda.yaml，官方推荐命名为 environment.yml）的官方规范中，明确预留了顶层metadata字段作为自定义扩展入口
• 原生 Conda 执行环境创建、更新等所有操作时，会自动忽略metadata字段下的全部内容，普通用户正常使用 Conda 命令时完全感知不到这部分内容的存在，无任何兼容性问题

配置示例 #

name: your-env-name
channels:
  - defaults
  - conda-forge
dependencies:
  - python=3.10
  - cudatoolkit=11.7
  # 其他常规依赖声明
# 自定义元数据区域，原生Conda完全忽略该字段下所有内容
metadata:
  commit_sha: a1b2c3d4e5f67890abcdef1234567890abcdef12
  driver_versions:
    cuda: "11.7.0"
    nvidia_driver: "515.48.07"
  system_info:
    os: "Ubuntu 20.04 LTS"
    arch: "x86_64"
  # 其余自定义字段均可放置在此处

注意事项 #

• 所有自定义元数据统一放在metadata字段下即可，不要在name、channels、dependencies等官方顶层字段中插入自定义内容，避免和未来 Conda 官方新增的字段产生冲突
• 该方案兼容所有 Conda 4.0+ 版本，即使是更旧的 Conda 版本，遇到未知的metadata字段也会直接跳过，不会抛出错误
• 你自行开发的配套工具需要读取信息时，直接解析 YAML 文件提取metadata节点内容即可，无需修改 Conda 核心逻辑

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