我是否需要将 __init__.py 放在通向我的班级的目录树中的每个目录中？

Question

我正在使用 Python 3.6 构建一个 Django 项目。我已经创建了这个目录结构...

project
- manage.py
- scripts
  - run_commands.py
- commons
  - util
    - __init__.py
    - my_class.py

init.py的内容是

from . import my_class

在另一个类中，我尝试像这样导入我的 MyClass

from commons.util import MyClass

但我收到此错误

ModuleNotFoundError: No module named 'commons'

我是否正确地创建了我的 init.py？

Answer 1

问题似乎是MyClass 不在commons.util 中，因为您只导入了名为my_class 的模块，而不是类本身。

文件commons/util/__init__.py 应该包含以下导入：

from .my_class import MyClass

我认为这不会解决您的问题，因为您会遇到与所示错误不同的错误，但您最终会遇到此错误。

更新

首先，我建议阅读this answer 以获得关于导入如何在 python 中工作的一个很好的解释。

基本上，当您执行from commons.util import MyClass 时，解释器会扫描sys.path 的内容以查找名为commons 的模块。
我假设您没有设置 sys.path 以包含您的项目文件夹，因此 ModuleNotFoundError。

TLDR;你有两个选择：

• 在run_commands.py 中手动设置sys.path 以检查您的项目文件夹（不要这样做！）
• 使用 Django 的 Command 类

要使用 Django 的 Command 类，您需要调整项目文件夹，如下所示：

project
- manage.py
- commons
- management
  - commands
    run_commands.py     
  - util
    - __init__.py
    - my_class.py

现在在 run_commands.py 中：

from django.core.management.base import BaseCommand

from commons.util import MyClass

class Command(BaseCommand):
    def handle(*args, **options):
        print("handling", MyClass)

您可以使用以下命令执行新命令：

python3 manage.py run_commands

Answer 2

过去的情况是，您需要在每个将被视为 python 模块的目录中放置一个__init__.py，因为没有__init__.py，python 不会在该目录中查找可导入代码.

- project
  - __init__.py
  - commons
    - __init__.py
    - util
      - __init__.py
      - my_class.py

但正如Reinstate Monica 在下面指出的那样，这是no longer true as of Python 3.3+。因此，根据您的 Python 版本，您需要做出明智的决定。

注意，您可能需要也可能不需要根 project 目录中的 __init__.py（如果您需要它们），这取决于它是否具有属于源代码树一部分的定义。但如果它只是一个容器，你就不需要它，就像你在大多数 Django 项目的组织方式中看到的那样。

https://docs.python.org/3/tutorial/modules.html。 https://docs.python.org/3/tutorial/modules.html#packages