Python 3.3+ 中的软件包不需要 __init__.py
Is __init__.py not required for packages in Python 3.3+
我正在使用 Python 3.5.1。我在这里阅读了文档和包部分：https://docs.python.org/3/tutorial/modules.html#packages
现在，我有以下结构：
/home/wujek/Playground/a/b/module.py
module.py:
class Foo:
def __init__(self):
print('initializing Foo')
现在，在 /home/wujek/Playground 中：
~/Playground $ python3
>>> import a.b.module
>>> a.b.module.Foo()
initializing Foo
<a.b.module.Foo object at 0x100a8f0b8>
同样，现在在家里，Playground 的超级文件夹：
~ $ PYTHONPATH=Playground python3
>>> import a.b.module
>>> a.b.module.Foo()
initializing Foo
<a.b.module.Foo object at 0x10a5fee10>
其实我什么都能做:
~ $ PYTHONPATH=Playground python3
>>> import a
>>> import a.b
>>> import Playground.a.b
为什么这行得通？我虽然需要在 a 和 b 中有 __init__.py 文件（空文件可以工作），以便在 Python 路径指向时导入 module.py Playground 文件夹？
这似乎已从 Python 2.7 更改为：
~ $ PYTHONPATH=Playground python
>>> import a
ImportError: No module named a
>>> import a.b
ImportError: No module named a.b
>>> import a.b.module
ImportError: No module named a.b.module
在 ~/Playground/a 和 ~/Playground/a/b 中使用 __init__.py 都可以正常工作。
Python 3.3+ 有 Implicit Namespace Packages 允许它创建没有 __init__.py 文件的包。
Allowing implicit namespace packages means that the requirement to provide an __init__.py file can be dropped completely, and affected ... .
使用 __init__.py 文件的旧方法仍然像 Python 中那样工作 2.
概述
@Mike 的回答是正确的，但是太不精确。的确，Python 3.3+ 支持 隐式命名空间包 ，允许它创建一个没有 __init__.py 文件的包。这被称为 命名空间包 与 常规包 形成对比，后者确实有一个 __init__.py 文件（空或非空）。
但是，创建 命名空间包 应该只在需要时才进行。对于大多数用例和开发人员来说，这并不适用，因此无论如何您都应该坚持使用 EMPTY __init__.py 文件。
命名空间包用例
为了演示两种类型的 python 包之间的区别，让我们看下面的例子：
google_pubsub/ <- Package 1
google/ <- Namespace package (there is no __init__.py)
cloud/ <- Namespace package (there is no __init__.py)
pubsub/ <- Regular package (with __init__.py)
__init__.py <- Required to make the package a regular package
foo.py
google_storage/ <- Package 2
google/ <- Namespace package (there is no __init__.py)
cloud/ <- Namespace package (there is no __init__.py)
storage/ <- Regular package (with __init__.py)
__init__.py <- Required to make the package a regular package
bar.py
google_pubsub 和 google_storage 是独立的包，但它们共享相同的命名空间 google/cloud。为了共享同一个命名空间，需要将公共路径的每个目录都做成一个命名空间包，即google/和cloud/。 这应该是创建命名空间包的唯一用例，否则没有必要。
重要的是 google 和 google/cloud 目录中没有 __init__py 文件，这样两个目录都可以被解释为 命名空间包 . In Python 3.3+ any directory on the sys.path with a name that matches the package name being looked for will be recognized as contributing modules and subpackages to that package。因此，当您从 google_pubsub 和 google_storage 导入时，Python 解释器将能够找到它们。
这不同于常规包，后者是自包含的，意味着所有部分都位于同一目录层次结构中。当导入一个包并且 Python 解释器在 sys.path 上遇到一个带有 __init__.py 文件的子目录时，它将创建一个仅包含该目录中的模块的目录包，而不是查找所有的模块该目录外适当命名的子目录。 这对于不想共享命名空间的包来说完全没问题。我强烈建议您查看 Traps for the Unwary in Python’s Import System 以更好地了解 Python 导入如何使用常规和命名空间包以及需要注意哪些 __init__.py 陷阱。
总结
- 如果要创建 命名空间包 ，则只跳过
__init__.py 个文件。如果您有位于不同位置的不同库并且您希望它们每个都为父包贡献一个子包，即命名空间包，则只创建命名空间包。
- 继续向您的目录添加空
__init__.py，因为 99% 的时间您只想创建 常规包 。此外，Python 工具，如 mypy 和 pytest 需要空的 __init__.py 文件来相应地解释代码结构。如果不小心，这可能会导致奇怪的错误。
资源
我的回答只触及了 常规包 和 命名空间包 的工作原理，因此请查看以下资源以进一步了解信息：
我会说，只有在想要 implicit namespace package 时才应该省略 __init__.py。如果你不知道它是什么意思，你可能不想要它，因此你应该继续使用 __init__.py 即使在 Python 3.
如果您的项目中有 setup.py 并在其中使用 find_packages()，则必须在每个目录中都有一个 __init__.py 文件以便自动找到包。
Packages are only recognized if they include an __init__.py file
UPD：如果你想在没有 __init__.py 的情况下使用隐式命名空间包，你只需要使用 find_namespace_packages() 而不是
根据我的经验，即使是 python 3.3+，有时仍然需要一个空的 __init__.py。一种情况是当您想要将子文件夹作为包引用时。比如我运行python -m test.foo的时候，直到我在test文件夹下新建了一个空的__init__.py才生效。我在这里谈论的是 3.6.6 版本，它是最近的。
除此之外，即使出于与现有源代码或项目指南兼容的原因，在您的包文件夹中有一个空 __init__.py 也很好。
我正在使用 Python 3.5.1。我在这里阅读了文档和包部分：https://docs.python.org/3/tutorial/modules.html#packages
现在，我有以下结构：
/home/wujek/Playground/a/b/module.py
module.py:
class Foo:
def __init__(self):
print('initializing Foo')
现在，在 /home/wujek/Playground 中：
~/Playground $ python3
>>> import a.b.module
>>> a.b.module.Foo()
initializing Foo
<a.b.module.Foo object at 0x100a8f0b8>
同样，现在在家里，Playground 的超级文件夹：
~ $ PYTHONPATH=Playground python3
>>> import a.b.module
>>> a.b.module.Foo()
initializing Foo
<a.b.module.Foo object at 0x10a5fee10>
其实我什么都能做:
~ $ PYTHONPATH=Playground python3
>>> import a
>>> import a.b
>>> import Playground.a.b
为什么这行得通？我虽然需要在 a 和 b 中有 __init__.py 文件（空文件可以工作），以便在 Python 路径指向时导入 module.py Playground 文件夹？
这似乎已从 Python 2.7 更改为：
~ $ PYTHONPATH=Playground python
>>> import a
ImportError: No module named a
>>> import a.b
ImportError: No module named a.b
>>> import a.b.module
ImportError: No module named a.b.module
在 ~/Playground/a 和 ~/Playground/a/b 中使用 __init__.py 都可以正常工作。
Python 3.3+ 有 Implicit Namespace Packages 允许它创建没有 __init__.py 文件的包。
Allowing implicit namespace packages means that the requirement to provide an
__init__.pyfile can be dropped completely, and affected ... .
使用 __init__.py 文件的旧方法仍然像 Python 中那样工作 2.
概述
@Mike 的回答是正确的，但是太不精确。的确，Python 3.3+ 支持 隐式命名空间包 ，允许它创建一个没有 __init__.py 文件的包。这被称为 命名空间包 与 常规包 形成对比，后者确实有一个 __init__.py 文件（空或非空）。
但是，创建 命名空间包 应该只在需要时才进行。对于大多数用例和开发人员来说，这并不适用，因此无论如何您都应该坚持使用 EMPTY __init__.py 文件。
命名空间包用例
为了演示两种类型的 python 包之间的区别，让我们看下面的例子：
google_pubsub/ <- Package 1
google/ <- Namespace package (there is no __init__.py)
cloud/ <- Namespace package (there is no __init__.py)
pubsub/ <- Regular package (with __init__.py)
__init__.py <- Required to make the package a regular package
foo.py
google_storage/ <- Package 2
google/ <- Namespace package (there is no __init__.py)
cloud/ <- Namespace package (there is no __init__.py)
storage/ <- Regular package (with __init__.py)
__init__.py <- Required to make the package a regular package
bar.py
google_pubsub 和 google_storage 是独立的包，但它们共享相同的命名空间 google/cloud。为了共享同一个命名空间，需要将公共路径的每个目录都做成一个命名空间包，即google/和cloud/。 这应该是创建命名空间包的唯一用例，否则没有必要。
重要的是 google 和 google/cloud 目录中没有 __init__py 文件，这样两个目录都可以被解释为 命名空间包 . In Python 3.3+ any directory on the sys.path with a name that matches the package name being looked for will be recognized as contributing modules and subpackages to that package。因此，当您从 google_pubsub 和 google_storage 导入时，Python 解释器将能够找到它们。
这不同于常规包，后者是自包含的，意味着所有部分都位于同一目录层次结构中。当导入一个包并且 Python 解释器在 sys.path 上遇到一个带有 __init__.py 文件的子目录时，它将创建一个仅包含该目录中的模块的目录包，而不是查找所有的模块该目录外适当命名的子目录。 这对于不想共享命名空间的包来说完全没问题。我强烈建议您查看 Traps for the Unwary in Python’s Import System 以更好地了解 Python 导入如何使用常规和命名空间包以及需要注意哪些 __init__.py 陷阱。
总结
- 如果要创建 命名空间包 ，则只跳过
__init__.py个文件。如果您有位于不同位置的不同库并且您希望它们每个都为父包贡献一个子包，即命名空间包，则只创建命名空间包。 - 继续向您的目录添加空
__init__.py，因为 99% 的时间您只想创建 常规包 。此外，Python 工具，如mypy和pytest需要空的__init__.py文件来相应地解释代码结构。如果不小心，这可能会导致奇怪的错误。
资源
我的回答只触及了 常规包 和 命名空间包 的工作原理，因此请查看以下资源以进一步了解信息：
我会说，只有在想要 implicit namespace package 时才应该省略 __init__.py。如果你不知道它是什么意思，你可能不想要它，因此你应该继续使用 __init__.py 即使在 Python 3.
如果您的项目中有 setup.py 并在其中使用 find_packages()，则必须在每个目录中都有一个 __init__.py 文件以便自动找到包。
Packages are only recognized if they include an
__init__.pyfile
UPD：如果你想在没有 __init__.py 的情况下使用隐式命名空间包，你只需要使用 find_namespace_packages() 而不是
根据我的经验，即使是 python 3.3+，有时仍然需要一个空的 __init__.py。一种情况是当您想要将子文件夹作为包引用时。比如我运行python -m test.foo的时候，直到我在test文件夹下新建了一个空的__init__.py才生效。我在这里谈论的是 3.6.6 版本，它是最近的。
除此之外，即使出于与现有源代码或项目指南兼容的原因，在您的包文件夹中有一个空 __init__.py 也很好。