如何在由诗歌管理的 python 项目中使用与工作目录相关的路径导入模块？

Question

我正在使用诗歌来管理我的 python 项目，这是该项目：

my_project/
├── pyproject.toml
├── module.py
└── scripts/
    └── main.py

我想知道如何将 function 从module.py正确地导入到my_scripts/main.py中。

我的 pyproject.toml：

[tool.poetry]
name = "my_project"
version = "0.1.0"
description = ""
authors = []

[tool.poetry.dependencies]
python = "^3.11"

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

我试过这个：

# In my_scripts/main.py

from module import my_function

并运行这些命令：

poetry install
poetry shell
python my_scripts/main.py

然后得到这个错误：

ModuleNotFoundError: No module named 'module'

我还在my_project/下放了一个__init__.py但没有成功。

Answer 1

对我有用的是在你的根目录中创建一个与 pyproject.toml 文件中的pyproject.toml的文件夹。 如果你不这样做，poetry 将找不到你的项目，也不会以可编辑模式安装它。

你还需要让 Python 知道一个文件夹是 package 或子包，方法是在其中放置一个__init__.py文件。

my_project/
├─ pyproject.toml
├─ my_project/
   ├─ __init__.py
   ├─ module.py
   ├─ scripts/
      ├─ __init__.py
      ├─ main.py

初始化文件夹时，您应该会看到项目已安装。

...> poetry install
Installing dependencies from lock file

Installing the current project: my_project (0.1.0)

最后一件事，您需要更改main.py中的导入。

# main.py

from my_project.module import my_function

print("my_function imported")

您现在可以激活虚拟环境（如果它尚未激活）并运行您的脚本。

...> poetry shell
Spawning shell within: C:\...\my_project\.venv
...
...> python my_project\scripts\main.py
my_function imported

聚苯乙烯

正如@sinoroc 在评论中指出的那样，可以（并且根据他的说法更可取）使用python -m my_project.scripts.main运行模块。

我是这个话题的新手，但根据这个 SO answer ：

__package__ 设置为 <modulename> 中的直接父级 package [当通过带有-m选项的命令行运行 python 时]

这意味着像下面这样的相对导入神奇地起作用了。

# main.py

from ..module import my_function

# ..module tells python to look in the parent directory for module.py

print("my_function imported")

...> python -m my_project.scripts.main
my_function imported
...> python my_project\scripts\main.py
Traceback (most recent call last):
...
ImportError: attempted relative import with no known parent package

Answer 2

我设法通过将此行添加到 [ pyproject.toml [tool.poetry]部分下的 pyproject.toml 来使其工作：

[tool.poetry]
# ...other fields
packages = [{ include = "**/*" }]

不需要__init__.py 。 赶紧跑：

poetry install
poetry shell
python scripts/main.py