前言
在Python工程里,当检测到一个目录下存在__init__.py
文件时,python就会把它当成一个包。
Module
在计算机程序的开发过程中,随着程序代码越写越多,在一个文件里代码就会越来越长,越来越不容易维护。
为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在Python中,一个.py
文件就称之为一个模块(Module)。
除了提高代码的可维护性外,使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突。但是也要注意,尽量不要与内置函数名字冲突。
Package
那么,如果不同的人编写的模块名相同怎么办?为了避免模块名冲突,Python又引入了按目录来组织模块的方法,称为包(Package)。
举个例子,一个abc.py
的文件就是一个名字叫abc的模块,一个xyz.py
的文件就是一个名字叫xyz的模块。
现在,假设我们的abc和xyz这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany
,按照如下目录存放:
1 | mycompany |
引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py
模块的名字就变成了mycompany.abc
。
__init__.py
请注意,每一个包目录下面都会有一个__init__.py
的文件,这个文件是必须存在的,否则,Python就把这个目录当成普通目录,而不是一个包。__init__.py
可以是空文件,也可以有Python代码,因为__init__.py
本身就是一个模块,而它的模块名就是mycompany
。
类似的,可以有多级目录,组成多级层次的包结构。比如如下的目录结构:
1 | mycompany |
文件www.py
的模块名就是mycompany.web.www
,两个文件utils.py
的模块名分别是mycompany.utils
和mycompany.web.utils
。
自己创建模块时要注意命名,不能和Python自带的模块名称冲突。例如,系统自带了sys模块,自己的模块就不可命名为
sys.py
,否则将无法导入系统自带的sys模块。
总之,模块是一组Python代码的集合,可以使用其他模块,也可以被其他模块使用。
实践
现在,让我们来处理一个实际问题。已有utils
目录结构如下:
1 | utils |
其中loginForm.py
和registerForm.py
中分别存在类LoginForm
、RegisterForm
。
此时如果我们想引用这两个类,需要这样做:
1 | # author: SilenceZheng66 |
这显得十分啰嗦,我们想要将utils
作为模块包,直接从utils
包中引入表单,于是我们更改目录结构为如下形式:
1 | utils |
并在__init__.py
中写入如下内容:
1 | # author: SilenceZheng66 |
现在,我们就可以以如下方式引入我们想要的类,而不用记忆一连串繁琐的模块路径了。
1 | # author: SilenceZheng66 |
参考文献
[1]https://www.liaoxuefeng.com/wiki/1016959663602400/1017454145014176
[2]https://www.cnblogs.com/tp1226/p/8453854.html
后记
首发于 silencezheng.top,转载请注明出处。