poetry init 生成 pyproject.toml,必须手动修改 name(需小写字母/数字/下划线且字母开头)、requires-python(建议显式写 >=3.9)、license(留空则 publish 失败)及 authors 邮箱格式(错误格式导致 wheel 元数据非法)。

poetry init 会生成什么,哪些字段必须手动改
poetry init 启动交互式向导,最终生成 pyproject.toml。它默认填的 name 是当前目录名,version 是 0.1.0,description 和 authors 需要你输入——但这里容易忽略:如果作者邮箱写错格式(比如漏掉 @),后续 poetry build 不报错,但生成的 wheel 元数据会不合法;license 字段留空会导致 poetry publish 拒绝上传。
建议操作:
- 运行
poetry init --no-interaction --name mypkg --description "A utility lib" --author "Alice <alice>" --license MIT</alice>跳过交互,减少手误 - 生成后立刻检查
pyproject.toml中的[project]块,确认requires-python显式声明(如">=3.9"),否则 Poetry 默认写"^3.9",语义上等价但部分 CI 工具解析不稳定 - 删掉自动生成的
keywords、classifiers空字段,避免后期发布时被 PyPI 拒绝
poetry add 和直接改 pyproject.toml 有什么区别
poetry add 不只是写依赖到 [project.dependencies],它还会同步更新 poetry.lock 并校验兼容性;而手动编辑 pyproject.toml 后不运行 poetry lock,下次 poetry install 可能拉取不一致的子依赖版本。
典型陷阱:
立即学习“Python免费学习笔记(深入)”;
将测试、lint、构建和文档流程编码为命名的Python会话,以便人类和代理每次运行相同的workflow。
- 用
poetry add requests@2.28.2锁死精确版本,但poetry add requests默认加^2.28.2(即允许2.x升级),行为差异极大 - 添加开发依赖必须用
poetry add pytest --group dev,写成poetry add --dev pytest在 Poetry 1.4+ 已弃用,会静默失败 - 如果项目已有
poetry.lock,poetry add会尝试复用现有约束;想强制重算全部依赖,得先poetry lock --no-update
为什么 poetry install 后找不到模块,却能 import 成功
这是 Poetry 的虚拟环境路径和 Python 解释器绑定问题。执行 poetry install 后,包安装在 Poetry 管理的虚拟环境中,但如果你在外部终端直接运行 python -m mypackage,调用的是系统 Python,不是 Poetry 的环境。
验证与修复步骤:
- 运行
poetry env info --path查看当前环境路径,再用该路径下的 Python 执行:$(poetry env info --path)/bin/python -m mypackage(macOS/Linux)或$(poetry env info --path)\Scripts\python.exe -m mypackage(Windows) - 更稳妥的方式是始终用
poetry run python -m mypackage,它自动注入正确解释器和 PATH - 如果用 VS Code,需在命令面板中选 “Python: Select Interpreter”,然后选择 Poetry 环境下的
python可执行文件,否则调试器无法识别本地包
CI 中 poetry install 失败常见于哪几个环节
CI 流水线里最常卡在缓存、权限和 Python 版本三处。Poetry 默认不读取 PYTHONPATH,也不继承 CI 环境的全局 pip 配置。
关键检查点:
- 确保 CI 步骤中先运行
poetry env use $(cat .python-version)(如果项目有.python-version),否则 Poetry 可能用错 Python 版本,尤其在 GitHub Actions 的ubuntu-latest上默认是 3.11,而项目要求 3.9 - 缓存
~/.cache/pypoetry和poetry.lock文件本身,但不要缓存poetry.lock生成后的dist/或.venv/,它们体积大且易冲突 - 在
poetry install前加poetry config virtualenvs.in-project true,让虚拟环境建在项目根目录下.venv,避免多作业并发时环境路径竞争
PyPI 私有源配置错误也常被忽略:若 pyproject.toml 里写了 [[tool.poetry.source]],但 CI 中没配置对应凭据,poetry install 会卡住超时而非报明确错误。

















