Python中__init__.py文件深入理解

1. 简介

1.1 模块（Module）和包（Package）的概念

模块是程序，任何Python程序都可以作为模块导入。写在脚本.py文件中的函数，比如xx.py，可以在另一个模块或者脚本中通过import xx进行导入。如果要导入xx.py中的函数yy，就写成from xx import yy。可见模块可以简单的理解为一个.py文件。

包就是模块所在的目录。和文件夹不同的是，包的根目录下存在__init__.py。一个文件夹根目录下存在__init__.py那就会认为该文件夹是Python包，否则那这个文件夹就是一个普通的文件夹。

1.2 __init__.py文件简介

__init__.py文件的作用是将文件夹变为一个Python的包，Python中每个包中，都有__init__.py文件。通常__init__.py文件为空，但是我们还可以为它增加其他的功能。我们在导入一个包时，实际上是导入了它的__init__.py文件。这样我们可以在__init__.py文件中批量导入我们所需要的模块，而不再需要一个一个的导入。

2. __init__.py内容写法

2.1 __init__.py文件内容

以PySolid代码为例。PySolid包的目录结构如下：

.
├── grid.py
├── point.py
└── __init__.py

__init__.py内容：

# top-level functions
from pysolid.grid import (
    calc_solid_earth_tides_grid,
    plot_solid_earth_tides_grid,
)
from pysolid.point import (
    TIDES,
    calc_solid_earth_tides_point,
    plot_solid_earth_tides_point,
    plot_power_spectral_density4tides,
)

__all__ = [
    '__version__',
    'calc_solid_earth_tides_grid',
    'plot_solid_earth_tides_grid',
    'TIDES',
    'calc_solid_earth_tides_point',
    'plot_solid_earth_tides_point',
    'plot_power_spectral_density4tides',
]

2.2 __init__.py内容解释

从grid.py中导入两个函数：

 calc_solid_earth_tides_grid
 plot_solid_earth_tides_grid

从point.py中导入四个函数：

TIDES,
calc_solid_earth_tides_point
plot_solid_earth_tides_point
plot_power_spectral_density4tides

在__init__.py中通过定义__all__变量来控制外部调用者能够调用的范围，除了以下列表中的函数，其它函数都无法被使用，类似于私有函数或变量。

__all__ = [
    '__version__',
    'calc_solid_earth_tides_grid',
    'plot_solid_earth_tides_grid',
    'TIDES',
    'calc_solid_earth_tides_point',
    'plot_solid_earth_tides_point',
    'plot_power_spectral_density4tides',
]

参考：
[1] 深入理解 __init__.py的作用
[2] 关于Python项目文件夹里建立__init__.py的理解