在多模块项目中设置导入和 __init__.py

Question

问题

我找到了几十篇关于在 Python 中使用 import 的基础知识的文章和教程，但没有一篇文章和教程可以提供有关使用多个包设置您自己的 Python 项目的全面指南。

这是我项目的结构：

• codename/
  • __init__.py
  • package1.py（有class1，是一个脚本）
  • package2.py（有class2）
  • package3.py（有function1，是一个脚本）
• test/
  • __init__.py
  • test_package1.py（有 package1 的单元测试）
  • test_package3.py（有 package3 的单元测试）

我如何设置我的导入来满足以下要求（并且所有这些都有意义？）：

1. class1、class2 和 function1 在命名空间 codename 中，即这样可以：

   import codename
   obj = codename.class1()
   codename.function1(obj)
   

2. 可以使用from codename import * 或from codename import class1 以相同的方式导入它们

3. function1 可以轻松访问class1（如何？）
4. package1 和 package2 是可执行脚本
5. test_package1.py 和 test_package3.py 也是如此
6. 测试也可以通过python -m unittest discover执行
7. 脚本也可以通过python -m codename.package1 执行

由于某些原因，我遇到了所有这些问题，当我尝试解决一个问题时，另一个问题会弹出。

我尝试了什么？

• 将codename/__init__.py 留空满足几乎所有要求，因为一切正常，但在其模块的命名空间中留下class1 之类的名称 - 而我希望将它们导入包中。

• 添加from codename.package1 import class1 等再次满足大部分要求，但通过python -m codename.package1 执行脚本时收到警告：

  RuntimeWarning: 'codename.package2' found in sys.modules \
  after import of package 'codename', but prior to execution of \
  'codename.package2'; this may result in unpredictable behaviour
  

哪一种有意义... 通过python codename/package1.py 函数运行脚本，但我想我可能会喜欢这两种工作方式。

• 我遇到an answer to a similar question 说内部模块不应该也是脚本，但我不明白为什么我们得到-m 开关？无论如何，将mains 提取到外部scripts 目录中是可行的，但这是设置所有这些的唯一规范方法吗？

Answer 1

1. 您需要将codename/ 的父目录添加到PYTHONPATH 环境变量（或写入/使用setup.py 文件，或在运行时修改sys.path）

2. 您需要在codename/__init__.py中导入所有要导出的名称

3. from .package1 import function1 如果您编写/使用setup.py 文件，否则from codename.package1 import function1

4. 您应该为脚本/可执行文件使用 setup.py 文件，因为它可以让一切变得更加整洁（而且您迟早会需要一个 setup.py 文件）

5. （和 6.）我建议使用 py.test，它会自动为您找到所有测试（并且可以并行运行等）

6. 这应该是开箱即用的，但是如果您编写了setup.py，那么您可以在任何地方（和任何平台）运行它们，就像package1一样。