在python中__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
中再在其他文件中导入,可以精简代码。
本文由 帝一博客 原创发布。用户在本站发布的原创内容(包括但不仅限于回答、文章和评论),著作权均归用户本人所有。独家文章转载,请联系邮箱:17762131@qq.com。获得授权后,须注明本文地址: https://bubukou.com/pythonpachong/1776.html
-
【原创】python_docx制作word文档实例demo
2019-10-29 16:15
-
python遍历字典dict
2019-09-22 12:05
-
python 两个list合并成一个dict的方法
2019-09-22 11:56
-
【原创】python 爬取wowo扣扣爬虫代码
2019-09-05 14:46
-
windows 怎么安装 python 的 win32 wi...
2019-08-10 18:15
-
[原创]python 证书验证http 304问题
2019-08-07 14:02
-
【原创】python 爬取小清新唯美图片
2019-07-18 22:19
-
Python简单计算文件MD5值的方法示例
2019-07-18 22:13
-
从零开始Python对redis作为消息队列的使用
2019-07-10 08:37
-
如何安装python到setuptools、pip工具安装
2019-07-10 07:52
网友留言评论