你常常看到却常常忽视的__init__.py有什么用？

你常常看到却常常忽视的init.py有什么用？

摄影：产品经理
有了它，乐高已经不香了
Python 初学者在阅读一些 Python 开源项目时，经常会看到一个叫作init.py的文件。下图为著名的第三方库requests的源代码：

那么init.py有什么用呢？本文介绍它的两个用途。

精简导入路径

假设咱们有两个文件main.py与writer.py，他们所在的文件结构以下图所示：

main.py在DocParser文件夹下面；writer.py在DocParser/microsoft/docx/文件夹下面。writer.py文件中有一个函数write。其内容以下：

如今我想在main.py文件夹调用这个函数，那么我有3种写法：

from microsoft.word.docx.writer import write

write()

运行效果以下图所示：

或者这样写：

from microsoft.word.docx import writer

writer.write()

运行效果以下图所示：

或者这样写：

import microsoft.word.docx.writer

microsoft.word.docx.writer.write()

运行效果以下图所示：

但不管那种方法，都要写长长的路径，甚为不便。这个时候，咱们能够在microsoft文件夹下面建立一个init.py文件，并在里面填写以下内容：

此时，在 main.py，咱们导入write函数，就像是从microsoft.py 文件中导入同样。以下图所示：

注意上面我说的是就像从microsoft.py 文件中导入同样，这里是用的文件而不是文件夹。

这是由于，当一个文件夹里面有init.py之后，这个文件夹就会被 Python 做为一个包(package)来处理。此时，对于这个包里面层级比较深的函数、常量、类，咱们能够先把它们导入到init.py中。这样以来，包外面再想导入这些内容时，就能够用from 包名 import 函数名来导入了。

无视工做区的相对引用

为何会有包这个东西呢？这是由于，当有一些代码会在不少地方被使用时，咱们能够把这些代码打包起来，做为一个公共的部分提供给其余模块调用。

因为调用包的其余模块所在的绝对路径是变幻无穷的，因此在包的内部调用自身其余文件中的函数、常量、类，就应该使用相对路径，而不是绝对路径。

例如，如今我在microsoft文件夹下面再建立一个parse.py文件，它须要导入microsoft/word/docx/writer.py中的write函数，那么代码能够写为：

from .word.docx.writer import write

def parse_doc():
    print('如今在 parse.py 中调用 write 函数')
    write()

以下图所示：

能够看到，此时from .word.docx.writer中的.表示当前包，因此.word.docx.writer表示当前包下面的word 文件夹下面的 docx 文件夹下面的 writer.py 文件。

而后咱们修改init.py，把parse_doc函数导入进去，以下图所示：

最后，在main.py中调用这个parse_doc函数，以下图所示：

能够看到，在包里面的一个文件调用这个包里面的另外一个文件，只须要知道另外一个文件的相对位置就能够了，不用关心这个包被放在哪里。

而且，上面parse.py中导入write函数的代码还能够进一步简化，因为write函数已经被导入到了init.py中，因此咱们能够直接从.里面导入write函数：

from . import write

运行效果以下图所示：

总结

当一个文件夹里面包含init.py时，这个文件夹会被 Python 认为是一个包(package)，此时，包内部的文件之间互相导入可使用相对导入，而且经过提早把函数、常量、类导入到init.py中再在其余文件中导入，能够精简代码。