Read the Docs 项目中 Poetry 1.8 构建问题的分析与解决方案

问题背景

在 Read the Docs 项目中，使用 Poetry 1.8 版本进行文档构建时出现了依赖安装问题。具体表现为构建过程中提示"找不到名为'furo'的主题"，尽管日志显示该主题已成功安装。这一问题在降级到 Poetry 1.7 版本后消失。

问题根源分析

经过深入调查，发现问题的根本原因在于 Poetry 1.8 版本对虚拟环境检测机制的变更。新版本中，Poetry 对虚拟环境的检测更加严格，要求必须设置 VIRTUAL_ENV 环境变量才能正确识别当前环境为虚拟环境。

在 Read the Docs 的构建环境中，虽然使用了虚拟环境，但没有显式设置 VIRTUAL_ENV 变量。这导致 Poetry 1.8 将依赖安装到了系统 Python 而非项目虚拟环境中，造成了后续构建步骤无法找到已安装的依赖包。

解决方案

针对这一问题，我们推荐以下几种解决方案：

方案一：显式设置虚拟环境变量

version: 2
build:
  os: "ubuntu-22.04"
  tools:
    python: "3.10"
  jobs:
    post_create_environment:
      - python -m pip install poetry
    post_install:
      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry install --with docs

此方案通过显式设置 VIRTUAL_ENV 环境变量，帮助 Poetry 正确识别当前虚拟环境。$READTHEDOCS_VIRTUALENV_PATH 是 Read the Docs 提供的环境变量，指向项目虚拟环境路径。

方案二：使用 Poetry 导出依赖并手动安装

version: 2
build:
  os: "ubuntu-22.04"
  tools:
    python: "3.11"
  jobs:
    post_create_environment:
      - python -m pip install poetry poetry-plugin-export
    post_install:
      - poetry export -f requirements.txt --without-hashes --only docs -o only-docs.txt
      - pip install --requirement only-docs.txt

此方案利用 poetry-plugin-export 插件将依赖导出为 requirements.txt 文件，然后使用 pip 手动安装。这种方法绕过了 Poetry 的虚拟环境检测问题。

方案三：使用 pipx 安装 Poetry

version: 2
build:
  os: "ubuntu-22.04"
  tools:
    python: "3.10"
  jobs:
    post_create_environment:
      - python -m pip install --user pipx
      - python -m pipx ensurepath
      - pipx install poetry
    post_install:
      - poetry install --with docs

pipx 是 Python 应用隔离安装工具，可以避免 Poetry 与项目依赖之间的冲突。虽然 Read the Docs 环境默认不包含 pipx，但可以轻松安装。

最佳实践建议

1. 优先考虑方案一：显式设置虚拟环境变量是最直接、最轻量的解决方案，与现有构建流程兼容性最好。

2. 长期考虑方案三：使用 pipx 安装 Poetry 是官方推荐的方式，能更好地隔离 Poetry 与项目环境，避免潜在冲突。

3. 避免使用 virtualenvs.create=false：Poetry 团队明确指出这不是推荐做法，之前的可用性实际上是源于一个 bug。

4. 保持构建环境一致性：无论采用哪种方案，都应确保构建环境中的 Python 解释器路径与 Read the Docs 后续构建步骤使用的解释器一致。

技术原理深入

Poetry 1.8 的变更反映了 Python 虚拟环境管理的最佳实践。虚拟环境的正确识别对于依赖隔离至关重要。在传统开发环境中，激活虚拟环境时会自动设置 VIRTUAL_ENV 变量，但 CI/CD 环境中这一步骤常被忽略。

Read the Docs 的构建系统内部已经创建了虚拟环境，只是没有按照标准方式"激活"它（即设置相关环境变量）。理解这一机制有助于开发者更好地调试类似的环境问题。

总结

Poetry 1.8 的变更促使我们重新审视 Python 项目构建中的环境管理实践。通过本文提供的解决方案，开发者可以顺利在 Read the Docs 上使用最新版 Poetry 构建文档。建议开发者根据项目具体情况选择合适的方案，并考虑将环境变量设置作为长期解决方案。