在我的包中导入模块的 Python 最佳实践

Question

我对 Python 打包路径系统有点困惑（实际上很多）。

我有这个项目：

myproject/
    package1/
       setup.py
       src/
          __init__.py
          module1.py
          module2.py
          module3.py
       tests/
          __init__.py
          test_package1.py

    package2/
       setup.py
       src/
          __init__.py
          module1.py
          module2.py
          module3.py
       tests/
          test_package2.py

    package3/
       setup.py
       src/
          __init__.py
          module1.py
          module2.py
          module3.py
       tests/
          test_package3.py

这些包应该在 CI 过程之后发布在私有存储库中（如果测试通过）。

重要提示： Package1 使用 package2，而 package2 使用 package3。

所以 package1 的setup.py看起来像这样：

setuptools.setup(
    name='package1',
    version='1.4.0.dev1',
    install_requires=['setuptools~=50.3.2',
                      'boto3~=1.17.0',
                      'pandas~=1.3.4',
                      'package2~=1.4.0.dev1'],
    package_dir={"package1": "src"},
    packages=["package1"],
    include_package_data=True,
    setup_requires=['pytest-runner'],
    tests_require=['pytest'],
    python_requires=">=3.6"
)

package2 的setup.py看起来像这样：

setuptools.setup(
    name='package2',
    version='1.4.0.dev1',
    install_requires=['PyYAML~=5.3.1'
                      'package3~=1.4.0.dev1'],
    package_dir={"package2": "src"},
    packages=["package2"],
    include_package_data=True,
    setup_requires=['pytest-runner'],
    tests_require=['pytest'],
    python_requires=">=3.6"
)

CI流程：

1. 我正在运行pip install . 对于每个包（来自相应的包目录）
2. 从 package3 目录运行测试： python -m pytest tests -vvv
3. 从 package2 目录运行测试： python -m pytest tests -vvv
4. 从 package1 目录运行测试： python -m pytest tests -vvv

对 package2 和 package3 的测试成功通过，但最后一步 - 当为 package1 运行 pytest 时，它在ModuleNotFoundError中抱怨 ModuleNotFoundError：

module1.py（包2的）：

from module2 import AwsService
...

AwsService只是在module2.py定义的一个类。

我将导入更改为： from . import AwsService from . import AwsService ，重新安装包并再次重新运行 package1 测试。 这次pytest抱怨package3中的import：

module1.py（包3）：

import module2
...

所以我将导入更改为from . import module2 from . import module2并开始运行测试。

但是在 package2 的 module3 中，我有from module2 import AwsService并且没关系，那么我怎么知道什么时候必须进行相对导入，什么时候不需要？！。

我完全对所有这些路径行为感到困惑。

也许我的setup.py不好或项目结构或我测试它的方式？

Answer 1

我的问题的解决方案只是将 myproject 的路径分配给 PYTHONPATH：

export PYTHONPATH=/Users/yuri/projects/myproject/

当您通过pip install .在本地安装软件包时pip install . 并执行pip freeze你会看到你的包已经安装，但你也会看到你的包附近的路径，路径是这样的： file:///Users/yuri/projects/myproject/package1作为对原始文件的引用location 和 Python 看不到它。 所以你必须手动添加路径。