__init__.py 是做什么用的？

Question

什么是 __init__.py Python源目录？

Answer 1

它曾经是包的必需部分（old, pre-3.3 "常规包”，而不是较新的 3.3+“命名空间包”< /a>）。

这是文档。

Python定义了两种类型的包，常规包和命名空间包。 常规包是 Python 3.2 及更早版本中存在的传统包。 常规包通常实现为包含 __init__.py 文件的目录。 导入常规包时，会隐式执行此 __init__.py 文件，并且它定义的对象将绑定到包命名空间中的名称。 __init__.py 文件可以包含与任何其他模块可以包含的相同的 Python 代码，并且 Python 在导入该模块时会向该模块添加一些附加属性。

但只需单击链接，它包含一个示例、更多信息以及命名空间包的说明，即没有 __init__.py 的包。

Answer 2

名为 __init__.py 的文件用于将磁盘上的目录标记为 Python 包目录。
如果您有这些文件

mydir/spam/__init__.py
mydir/spam/module.py

并且 mydir 在您的路径上，则可以将 module.py 中的代码导入为

import spam.module

或

from spam import module

如果删除 __init__.py 文件时，Python 将不再在该目录中查找子模块，因此尝试导入该模块将失败。

__init__.py 文件通常为空，但可用于以更方便的名称导出包的选定部分，保存方便的函数等。
鉴于上面的示例，可以访问 init 模块的内容，因为

import spam

此答案基于 此网页。

Answer 3

除了将目录标记为 Python 包并定义 __all__ 之外，__init__.py 还允许您在包级别定义任何变量。如果一个包以类似 API 的方式定义了经常导入的内容，那么通常会很方便。 这种模式促进了对 Pythonic“扁平优于嵌套”哲学的坚持。

示例

下面是我的一个项目中的一个示例，其中我经常导入一个名为 Session 的 sessionmaker 来与我的数据库交互。 我编写了一个包含几个模块的“数据库”包：

database/
    __init__.py
    schema.py
    insertions.py
    queries.py

我的 __init__.py 包含以下代码：

import os

from sqlalchemy.orm import sessionmaker
from sqlalchemy import create_engine

engine = create_engine(os.environ['DATABASE_URL'])
Session = sessionmaker(bind=engine)

由于我在这里定义了 Session，我可以使用以下语法启动一个新会话以下。 该代码与从“database”包目录内部或外部执行的代码相同。

from database import Session
session = Session()

当然，这是一个小小的便利 - 另一种方法是在我的数据库包中的新文件（例如“create_session.py”）中定义 Session ，并使用以下命令启动新会话：

from database.create_session import Session
session = Session()

进一步阅读

有一个非常有趣的 reddit 线程，涵盖了 __init__.py 的适当用法：

http:// /www.reddit.com/r/Python/comments/1bbbwk/whats_your_opinion_on_what_to_include_in_init_py/

大多数意见似乎是 __init__.py 文件应该非常薄，以避免违反“明确的是比隐含的更好”的哲学。

Answer 4

__init__.py

为了方便起见，有两个主要原因

1. ：其他用户不需要知道您的函数在包层次结构中的确切位置（文档）。

   your_package/ 
       __init__.py 
       文件1.py 
       文件2.py 
         ... 
       文件N.py 
     

   __init__.py 中的

   # 
     从 .file1 导入 * 
     从 .file2 导入 * 
     ... 
     从 .fileN 导入 * 
     

   file1.py 中的

   # 
     def 添加（）： 
         经过 
     

   然后其他人可以通过以下方式调用add()

    from your_package import add 
     

   不知道 file1 的内部函数，例如

    from your_package.file1 import add 
     

2. ，例如

   如果你想要初始化某些东西； 例如，日志记录（应放在顶层）：

    导入logging.config 
      logging.config.dictConfig(Your_logging_config) 
     

Answer 5

__init__.py 文件使 Python 将包含它的目录视为模块。

此外，这是模块中加载的第一个文件，因此您可以使用它来执行每次加载模块时要运行的代码，或指定要导出的子模块。

Answer 6

从 Python 3.3 开始，不再需要 __init__.py 将目录定义为可导入的 Python 包。

检查 PEP 420：隐式命名空间包 ：

对不需要 __init__.py 标记文件的包目录的本机支持，可以自动跨越多个路径段（受到各种第三方命名空间包方法的启发，如 PEP 420）

这是测试：

$ mkdir -p /tmp/test_init
$ touch /tmp/test_init/module.py /tmp/test_init/__init__.py
$ tree -at /tmp/test_init
/tmp/test_init
├── module.py
└── __init__.py
$ python3

>>> import sys
>>> sys.path.insert(0, '/tmp')
>>> from test_init import module
>>> import test_init.module

$ rm -f /tmp/test_init/__init__.py
$ tree -at /tmp/test_init
/tmp/test_init
└── module.py
$ python3

>>> import sys
>>> sys.path.insert(0, '/tmp')
>>> from test_init import module
>>> import test_init.module

参考文献：
https://docs.python.org/3 /whatsnew/3.3.html#pep-420-implicit-namespace-packages
https://www.python.org/dev/peps/pep-0420/
Python 3 中的包不需要 __init__.py 吗？

Answer 7

尽管 Python 可以在没有 __init__.py 文件的情况下工作，但您仍然应该包含一个文件。

它指定该目录应被视为一个包，因此包含它（即使它是空的）。

还有一种情况，您实际上可能使用 __init__.py 文件：

假设您有以下文件结构：

main_methods 
    |- methods.py

和 方法.py 包含这个：

def foo():
    return 'foo'

要使用 foo() 你需要以下之一：

from main_methods.methods import foo # Call with foo()
from main_methods import methods # Call with methods.foo()
import main_methods.methods # Call with main_methods.methods.foo()

也许你需要（或想要）将 methods.py 保留在里面main_methods（例如运行时/依赖项），但您只想导入main_methods。

---

如果您将 methods.py 的名称更改为 __init__.py，那么您只需导入 main_methods 即可使用 foo() code>：

import main_methods
print(main_methods.foo()) # Prints 'foo'

这是有效的，因为 __init__.py 被视为包的一部分。

---

一些 Python 包实际上就是这样做的。 一个示例是 JSON，其中运行 import json实际上是从 json 包中导入 __init__.py (在此处查看包文件结构）：

源代码： Lib/json/__init__.py

Answer 8

在Python中，包的定义非常简单。 与Java 一样，层次结构和目录结构是相同的。 但是你必须在包中包含 __init__.py 。 我将用下面的例子解释__init__.py文件：

package_x/
|--  __init__.py
|--    subPackage_a/
|------  __init__.py
|------  module_m1.py
|--    subPackage_b/
|------  __init__.py
|------  module_n1.py
|------  module_n2.py
|------  module_n3.py

__init__.py可以为空，只要它存在。 它表明该目录应该被视为一个包。 当然，__init__.py也可以设置相应的内容。

如果我们在 module_n1 中添加一个函数：

def function_X():
    print "function_X in module_n1"
    return

运行后：

>>>from package_x.subPackage_b.module_n1 import function_X
>>>function_X()

function_X in module_n1 

然后我们按照层次结构包，调用 module_n1 函数。 我们可以在 subPackage_b 中使用 __init__.py，如下所示：

__all__ = ['module_n2', 'module_n3']

运行后：

>>>from package_x.subPackage_b import * 
>>>module_n1.function_X()

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named module_n1

因此使用 * 导入，模块包受 __init__.py 内容约束。

Answer 9

__init__.py 会将其所在的目录视为可加载模块。

对于喜欢阅读代码的人，我在这里添加了两位炼金术士的评论。

$ find /tmp/mydir/
/tmp/mydir/
/tmp/mydir//spam
/tmp/mydir//spam/__init__.py
/tmp/mydir//spam/module.py
$ cd ~
$ python
>>> import sys
>>> sys.path.insert(0, '/tmp/mydir')
>>> from spam import module
>>> module.myfun(3)
9
>>> exit()
$ 
$ rm /tmp/mydir/spam/__init__.py*
$ 
$ python
>>> import sys
>>> sys.path.insert(0, '/tmp/mydir')
>>> from spam import module
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named spam
>>> 

Answer 10

它有助于导入其他 python 文件。 当您将此文件放置在包含其他 py 文件的目录（例如 stuff）中时，您可以执行诸如 import stuff.other 之类的操作。

root\
    stuff\
         other.py

    morestuff\
         another.py

如果目录 stuff 中没有此 __init__.py，则无法导入 other.py，因为 Python 不知道 stuff 的源代码在哪里，也无法将其识别为包。

Answer 11

__init__.py 文件使导入变得容易。 当包中存在__init__.py时，可以从文件b.py导入函数a()，如下所示：

from b import a

没有它，但是，您不能直接导入。 需要修改系统路径：

import sys
sys.path.insert(0, 'path/to/b.py')

from b import a

Answer 12

__init__.py 允许的一件事是将模块转换为包，而不会破坏 API 或创建无关的嵌套命名空间或私有模块*。 当我想扩展命名空间时这会很有帮助。

如果我有一个包含 util.py 的文件

def foo():
    ...

，那么用户将通过以下方式访问 foo

from util import foo

如果我想添加用于数据库交互的实用程序函数，并且我希望他们在 util 下拥有自己的命名空间code>，我需要一个新目录**，并保持 API 兼容性（以便 from util import foo 仍然有效），我将其称为 util/。 我可以像这样将 util.py 移动到 util/ 中，

util/
  __init__.py
  util.py
  db.py

并在 util/__init__.py 中这样做

from util import *

，但这是多余的。 我们可以将 util.py 内容放入 __init__.py 中，而不是使用 util/util.py 文件，用户现在可以

from util import foo
from util.db import check_schema

我认为这很好地突出了 util 包的 __init__.py 的作用与 util 模块类似的方式

* 这在其他答案中有所暗示，但我想在这里强调它
** 缺少采用进口体操。 请注意，创建与文件同名的新包将不起作用，请参阅此

Answer 13

__init__.py ：它是在包目录中找到的Python文件，当导入包或包中的模块时调用它。 您可以使用它来执行包初始化代码，即每当导入包时，都会先执行 python 语句，然后再执行该文件夹中的其他模块。 它类似于c或Java程序的main函数，但它存在于Python包模块（文件夹）中而不是核心Python文件中。
当模块导入到 Python 文件中时，它还可以访问此 __init__.py 文件中定义的全局变量。

例如。
我在名为 pymodlib 的文件夹中有一个 __init__.py 文件，该文件包含以下语句：

print(f'Invoking __init__.py for {__name__}')
pystructures = ['for_loop', 'while__loop', 'ifCondition']

当我在解决方案中导入此包 pymodlib 时模块或笔记本或 python 控制台：
这两条语句在导入时执行。
因此，在日志或控制台中，您将看到以下输出：

>>> import pymodlib
Invoking __init__.py for pymodlib

在 python 控制台的下一个语句中： 我可以访问全局变量：

>> pymodlib.pystructures

它给出以下输出：

['for_loop', 'while__loop', 'ifCondition']

现在，从 Python 3.3 开始，可以选择使用此文件文件夹 Python 模块。 所以你可以跳过将其包含在 python 模块文件夹中。

Answer 14

如果您使用的是 Python 2 并且想要加载文件的同级文件，您只需将文件的父文件夹添加到会话的系统路径中即可。 其行为与当前文件是 init 文件大致相同。

import os
import sys
dir_path = os.path.dirname(__file__)
sys.path.insert(0, dir_path)

之后，相对于文件目录的常规导入将正常工作。 例如，

import cheese
from vehicle_parts import *
# etc.

通常您希望使用适当的 init.py 文件，但是在处理遗留代码时，您可能会陷入 f.ex 的困境。 一个硬编码的库来加载特定的文件，仅此而已。 对于这些情况，这是一种替代方案。