Pythoninit.py作用详解

__init__.py该文件的作用就是相当于把自身整个文件夹当做一个包来管理,每当有外部import的时候就会自动执行里面的函数

1.标识该目录是一个python的模块包(module package)

如果是使用python的IDE,如果目录中存在该文件,该目录会被识别为module package

2.简化模块导入操作

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

.
└── mypackage
    ├── subpackage_1
    │   ├── test11.py
    │   └── test12.py
    ├── subpackage_2
    │   ├── test21.py
    │   └── test22.py
    └── subpackage_3
        ├── test31.py
        └── test32.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

2.1 init.py是怎么工作的

实际上,如果目录中包含__init__.py,当用import导入该目录时.会执行__init__.py里面的代码.我们在mypackage目录下增加一个__init__.py文件来做一个实验:

.
└── mypackage
    ├── __init__.py
    ├── subpackage_1
    │   ├── test11.py
    │   └── test12.py
    ├── subpackage_2
    │   ├── test21.py
    │   └── test22.py
    └── subpackage_3
        ├── test31.py
        └── test32.py

__init__.py加一行print("You have imported mypackage")

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

>>> import mypackage
You have imported mypackage

__init__.py是自动执行的

2.2 控制模块导入

在mypackage/init.py添加以下语句: from subpackage_1 import test11

导入时出现问题:

>>> 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'

需要完整的包名 from mypackage.subpackage_1 import test11

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

2.3 偷懒的导入方法

导入时可以偷懒,将包中的所有内容导入 from mypackage import *

__all__ 变量关联了一个模块列表,当执行from xx import *时,就会导入列表中的模块.将__init__.py修改成: __all__ = ['subpackage_1', 'subpackage_2']

这里没有包含subpackage3,是为了证明__all__起作用,而不是导入所有子目录.

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

子目录中的模块没有导入! 修改子目录下的__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']

3.配置模块的初始化操作

在了解了__init__.py的工作原理后，应该能理解该文件就是一个正常的python代码文件。因此可以将初始化代码放入该文件中。

Python中init详解

Python__init__.py作用详解