Python中的__init__.py以及from . import xxx

对比理解__init__.py以及from . import xxx的使用方法

精简导入路径

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

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

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

1、这样写：

from microsoft.word.docx.writer import write

write()

运行效果如下图所示：

2、或者这样写：

from microsoft.word.docx import writer

writer.write()

运行效果如下图所示：

3、或者这样写：

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​​中再在其他文件中导入，可以精简代码。

去期待陌生，去拥抱惊喜。