Python init.py 作用？

August 7, 2024 · 5 min read

在 Python 中，__init__.py 文件是一个特殊的文件，它的主要作用是在包（package）目录中标识该目录是一个 Python 包，使得该目录下的模块可以被导入和使用。以下是关于 __init__.py 的一些主要功能和用途：

标识包：当目录中包含 __init__.py 文件时，该目录就被认为是一个 Python 包。这使得包中的模块可以使用点号（.）进行导入，例如 import mypackage.mymodule。
初始化代码：__init__.py 文件可以包含包的初始化代码。当包第一次被导入时，__init__.py 中的代码会被执行。这可以用来设置包级别的变量、导入子模块或者执行任何需要的初始化任务。
定义公共接口：可以在 __init__.py 中定义包的公共接口，通过 __all__ 列表来指定包中的哪些模块或对象是公共的。这样，当使用 from mypackage import * 时，只有在 __all__ 列表中指定的模块或对象会被导入。
简化导入路径：可以在 __init__.py 中直接导入子模块，使得用户在使用包时可以简化导入路径。例如，如果在 __init__.py 中导入了子模块 mymodule，那么用户可以直接使用 import mypackage 而不是 import mypackage.mymodule。

下面是一个简单的例子，假设我们有以下目录结构：

mypackage/
    __init__.py
    module1.py
    module2.py

其中，__init__.py 文件的内容如下：

# __init__.py
from .module1 import foo
from .module2 import bar

__all__ = ['foo', 'bar']

module1.py 的内容如下：

# module1.py
def foo():
    return "foo from module1"

module2.py 的内容如下：

# module2.py
def bar():
    return "bar from module2"

在这种情况下，用户可以这样导入和使用包：

import mypackage

print(mypackage.foo())  # 输出: foo from module1
print(mypackage.bar())  # 输出: bar from module2

通过在 __init__.py 中导入 foo 和 bar，用户可以直接从 mypackage 导入它们，而不需要知道具体的子模块名称。这样可以提高代码的组织性和可维护性。

从 Python 3.3 开始，不写 __init__.py 文件的目录也可以被当作包。这是由于引入了“隐式命名空间包”这一概念。隐式命名空间包允许包在文件系统上以分布的方式存在，无需包含 __init__.py 文件。

隐式命名空间包的引入主要是为了简化和增强包的分布式组织管理。它的工作方式如下：

目录中不需要包含 __init__.py 文件即可被识别为包。
可以将一个包分散在多个位置，只要每个位置都包含一个相同名字的目录，这些目录会被合并成一个单一的包命名空间。

例如，如果你有以下目录结构：

/path/to/parent/
    mypackage/
        module1.py

/another/path/to/parent/
    mypackage/
        module2.py

在这两个位置上都有一个名为 mypackage 的目录，但它们并不需要包含 __init__.py 文件。Python 会将这两个目录合并成一个命名空间包 mypackage，从而可以如下导入：

import sys
sys.path.extend(['/path/to/parent', '/another/path/to/parent'])

import mypackage.module1
import mypackage.module2

print(mypackage.module1)  # 可以使用模块1
print(mypackage.module2)  # 可以使用模块2

这种方法对于需要将包分布在多个目录中的场景特别有用。例如，当你有多个独立的项目需要共享一个公共的命名空间时，隐式命名空间包可以非常方便地实现这一点。

不过，如果你仍然使用传统的包结构（即目录中包含 __init__.py 文件），它们仍然会被识别为包，并且这种方式在处理包的初始化逻辑时更为常见和直接。