使用Poetry管理Python项目时如何让Python识别根目录自定义库？

Poetry专属解决方法 #

Poetry原生支持通过可编辑安装的方式自动注册项目包路径，不需要手动修改系统或环境变量配置，操作步骤如下：

• 第一步：修改项目根目录下的pyproject.toml，在[tool.poetry]配置块中添加src目录包声明，示例如下：

[tool.poetry]
name = "你的项目名称"
version = "0.1.0"
authors = ["你的信息 <你的邮箱>"]
packages = [{include = "src"}]

• 第二步：在项目根目录执行poetry install，Poetry会自动将src目录作为可编辑包安装到当前项目的虚拟环境中。如果之前已经执行过安装命令，修改配置后重新执行该命令即可生效。

配置完成后，不管你在哪个目录下，只要使用当前项目虚拟环境的Python（通过poetry shell进入虚拟环境，或者用poetry run python前缀执行命令），都可以直接通过from src.data import xyz的方式导入自定义模块。

通用场景处理方案 #

如果不想依赖Poetry的包安装能力，也可以用以下常规方案解决路径识别问题：

• 动态添加根目录到sys.path：在需要运行的脚本开头添加如下代码，根据脚本所在层级调整路径计算规则，直到定位到项目根目录即可：

import sys
from pathlib import Path
# 示例中脚本在src/models目录下，向上跳两级即可到项目根目录
sys.path.append(str(Path(__file__).parent.parent.resolve()))

• 临时指定PYTHONPATH环境变量：执行脚本前添加路径声明，比如在项目根目录下运行命令：PYTHONPATH=$(pwd) python src/models/你的脚本名.py
• 固定工作目录：始终在项目根目录下执行Python命令，不要切换到src/models等子目录启动Python shell或者运行脚本，此时Python会默认将当前工作目录加入模块搜索路径，可直接识别src包。

注意：不建议手动修改虚拟环境site-packages下的配置文件添加路径，也不要在全局Python环境中注册项目路径，会导致多项目之间的路径冲突。

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