我们常常看到的 init.py 到底是个啥？

柔光的暖阳◎ 2023-10-06 15:14 10阅读 0赞

当你去看一些 Python 相关的项目时，常常会看到 \_\_init\_\_.py，当你使用某些编辑器创建 Python Package 的时候，它也会自动给你生成一个 \_\_init\_\_.py 文件。

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py]

这玩意有什么用呢？

我们知道， Python 中的包是可以包含多个 py 模块的，我们可以在不同的地方通过包名区分使用这些模块。

话不多说，咱们先来创建一下这样的目录：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 1]

我们在这里面创建了三个 Python 子包，里面都有 \_\_init\_\_ 和 module 的 py 文件。

我们分别在不同包下的 \_\_init\_\_ 中写一个 print 语句：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 2]

接着我们进入 Python ，分别来导入这些模块：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 3]

可以看到，当我们导入父模块中的子模块的时候，它会优先执行父模块中的 init ，接着会执行指定模块中的 init。  
当然，只是导入父模块的时候只会执行父模块中的 init：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 4]

也就是说，当我们去 import 一个 Package 的时候，它会隐性的去执行 \_\_init\_\_.py ， 而在 \_\_init\_\_.py 中定义的对象，会被绑定到当前的命名空间里面来。

比如有时候我们会这样去导入一个包下的所有模块，会这样操作：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 5]

但这个时候你会发现并没有将相关的子模块导入进来：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 6]

这时候你可能想到了，可以在父模块中的 \_\_init\_\_.py 做文章，先把它们导入进来不就行了：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 7]

这里的 \_\_all\_\_ 相当于导入 \[\] 里面定义的模块。

这次再导入：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 8]

可以看到，所有子模块就都一并导入进来了。

当然，你也可以在 \_\_init\_\_.py 做一些初始化的操作，比如数据库 session 的创建：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 9]

其实在 Python3.2 版本之前，定义的 Package 下面一定要有 \_\_init\_\_.py 文件，这样 Python 才知道它是一个 Package，才可以寻找到相关模块的路径从而被 import。

而在 Python3.2 之后的版本就不需要再额外的去专门创建一个 \_\_init\_\_.py 来告诉 Python 它是一个 Package 了，因为现在创建的包叫 Namespace package， Python 可以自动搜寻 Package 路径，哪怕你的父包路径发生了改变，你在下次导入的时候， Python 还是会自动重新搜索包路径。

我们把刚刚定义的 \_\_init\_\_ 都给删掉试试：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 10]

接着我们在 Python3.8 版本导入看看：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 11]

可以看到，尽管我们在 package 中没有定义 \_\_init\_\_.py，依然可以导入使用。

以同样的形式，我们在 Python2 中导入看看：

![你常常看到的 \_\_init\_\_.py 到底是个啥？][_init_.py 12]

可以看到，它被整懵逼了...

综上，\_\_init\_\_.py 会在 import 的时候被执行，而空的 \_\_init\_\_.py 在Python 新版本中已经不需要你额外去定义了，因为就算你不定义 init， Python 也知道你导入的包路径，但是如果你想要做一些初始化操作，或者像我们刚刚说的预先导入相关的模块，那么定义 \_\_init\_\_.py 还是很有必要的哟。

[_init_.py]: https://img-blog.csdnimg.cn/img_convert/fdfe55f88a7f00abd91583b1ed7c4cb6.png
[_init_.py 1]: https://img-blog.csdnimg.cn/img_convert/948462ec241b5d4268cf1a1e85cd3d00.png
[_init_.py 2]: https://img-blog.csdnimg.cn/img_convert/b097905e63723a9836404278228cfeb7.png
[_init_.py 3]: https://img-blog.csdnimg.cn/img_convert/c2f7f01e1b03d85e76c5415c01cccb29.png
[_init_.py 4]: https://img-blog.csdnimg.cn/img_convert/339aa44d943a03edd07df4e14cc9ca1d.png
[_init_.py 5]: https://img-blog.csdnimg.cn/img_convert/b22dc81bf43c9996d76eef07501015ad.png
[_init_.py 6]: https://img-blog.csdnimg.cn/img_convert/506323ac850736ff26d6a0bad7a46440.png
[_init_.py 7]: https://img-blog.csdnimg.cn/img_convert/44891960465190f1dfed739b267f13e3.png
[_init_.py 8]: https://img-blog.csdnimg.cn/img_convert/ec7d56355850c690f8deec2264967ee4.png
[_init_.py 9]: https://img-blog.csdnimg.cn/img_convert/8c483140d0114ab0c90798501b374997.png
[_init_.py 10]: https://img-blog.csdnimg.cn/img_convert/ee47b0fe9f6e55a45415a8f982c84287.png
[_init_.py 11]: https://img-blog.csdnimg.cn/img_convert/cfc931d0b0dc7f6d21c74553123cb074.png
[_init_.py 12]: https://img-blog.csdnimg.cn/img_convert/0ba9835cbb7eaf2842eb4df0f53c256e.png