python工程下方的__init__.py 的隐藏用法，学到了！

Posted 2021-06-30 七月的小尾巴

python的__init__.py文件的作用

平时创建工程的时候，下方都会自动生成一个__init__.py 的文件，但是几乎从来都没有用过，今天我们就来看看，这个文件究竟是做什么用的呢？

简化模块导入操作

假设我们的模块包的目录结构如下：

如果我们使用最直接的导入方式，将整个文件拷贝到工程目录下，然后直接导入：

from mypackage.subpackage_1 import test11
from mypackage.subpackage_1 import test12
from mypackage.subpackage_2 import test21
from mypackage.subpackage_2 import test22
from mypackage.subpackage_3 import test31
from mypackage.subpackage_3 import test32

当然这个例子里面文件比较少，如果模块比较大，目录比较深的话，可能自己都记不清该如何导入。（很有可能，哪怕只想导入一个模块都要在目录中找很久）

这种情况下，init.py 就很有作用了。我们先来看看该文件是如何工作的。

init.py 是怎么工作的？

实际上，如果目录中包含了 init.py 时，当用 import 导入该目录时，会执行 init.py 里面的代码。

我们在 MyPackAge 目录下增加一个 init.py 文件来做一个实验：

MyPackAge/init.py 里面加一个print，如果执行了该文件就会输出：

print("You have imported mypackage")

下面直接用交互模式进行 import

>>> import mypackage
You have imported mypackage

很显然，init.py 在包被导入时会被执行。

控制模块导入

我们再做一个实验，在 mypackage/init.py 添加以下语句：

from subpackage_1 import test11

我们导入 mypackage 试试:

>>> import mypackage
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/taopeng/Workspace/Test/mypackage/__init__.py", line 2, in <module>
    from subpackage_1 import test11
ImportError: No module named 'subpackage_1'

报错了。。。怎么回事？

原来，在我们执行import时，当前目录是不会变的（就算是执行子目录的文件），还是需要完整的包名。

from mypackage.subpackage_1 import test11

综上，我们可以在__init__.py 指定默认需要导入的模块

偷懒的导入方法

有时候我们在做导入时会偷懒，将包中的所有内容导入

from mypackage import *

这是怎么实现的呢？ all 变量就是干这个工作的。

all 关联了一个模块列表，当执行 from xx import * 时，就会导入列表中的模块。我们将 init.py 修改为 。

__all__ = ['subpackage_1', 'subpackage_2']

这里没有包含 subpackage_3，是为了证明 all 起作用了，而不是导入了所有子目录。

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__doc__', '__loader__', '__name__', '__package__', '__path__', '__spec__']

子目录的中的模块没有导入！！！

该例子中的导入等价于

from mypackage import subpackage_1, subpackage_2

因此，导入操作会继续查找 subpackage_1 和 subpackage_2 中的 init.py 并执行。（但是此时不会执行 import *）

我们在 subpackage_1 下添加 init.py 文件:

__all__ = ['test11', 'test12']

# 默认只导入test11
from mypackage.subpackage_1 import test11

再来导入试试

>>> from mypackage import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'subpackage_1', 'subpackage_2']
>>> 
>>> dir(subpackage_1)
['__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', 'test11']

如果想要导入子包的所有模块，则需要更精确指定。

>>> from mypackage.subpackage_1 import *
>>> dir()
['__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'test11', 'test12']

配置模块的初始化操作

在了解了 init.py 的工作原理后，应该能理解该文件就是一个正常的python代码文件。

因此可以将初始化代码放入该文件中。