Python：奇怪的导入行为

Question

我有一个结构如下的包

projectX
├── data 
├── results
└── projectX
    ├── stats
    │   ├── __init__.py
    │   ├── stats_worker.py
    │   └── stats_wroker2.py
    ├── __init__.py
    ├── main_worker.py
    └── interface.py

请注意，项目文件夹和源文件夹共享相同的名称 (projectX)。

问题有点复杂，需要做一些前提

场地：

我总是启动界面并且总是启动界面。没有调用其他脚本

我的问题首先出现在尝试从 stats_worker2 导入 main_worker 时。

我无法将其作为相对导入。所以我试图 从 stats_worker2 和接口（分别）将父目录附加到 sys.path。我尝试了各种我不记得的方法。

最终通过在 stats_worker2 中添加以下行来实现

sys.path.append('../projectX')
from projectX import main_worker

现在开始奇怪了

在调用了几次脚本之后（我不记得具体有多少次了），上面的 sintax 不再起作用了。因为有一个： ImportError: 没有名为 projectX 的模块

编辑：上面的斜体部分是由于我在 projectX 源文件夹中缺少__init__.py。所有其他症状仍然存在。

但是，很奇怪，我现在可以从 stats_worker2 成功导入主要工作人员：

import main_worker

没有任何目录被附加到 sys.path！

但是，Sphinx 不再工作了！ 具体来说，它无法导入 projectX 包的所有模块。

额外的怪异

我曾经从界面成功导入 stats_worker，现在我仍然可以导入它，但是我的 IDE (Pycharm) 将导入标记为未使用。它实际上已被使用，如果我评论导入，界面会按预期崩溃（我已经使 Pycharm 缓存失效）

Answer 1

1. 将一个空的__init__.py 文件添加到源根目录^†。
2. 需要设置您的运行时环境，以便 项目根目录^†† 在 sys.path 中可见。项目根目录应该不有__init__.py。项目目录名称不必与包名称匹配，但这也不会真正损害任何东西。
3. 从 python 源文件中删除任何 sys.path.append 内容，并且不要再这样做了。
4. from projectX import main_worker 是 stats_worker2.py 模块的正确导入语句。不要使用import main_worker。

对于第 2 步，执行此操作的常用方法是使用 python setup.py develop“安装”您的包。即你需要写一个setup.py。由于您显然没有setup.py，因此作为一种廉价的解决方法，您可以改为export PYTHONPATH=<absolute_path_to_project_root>。

^†_{源根是更深的projectX 目录，它与包含main_worker.py 模块的目录相同。}

^††_{项目根目录是浅层projectX 目录，它与包含data 和results 子目录的目录相同。}