Python中模块(Module)和包(Package)的区别
1. 模块(module)
在计算机程序的开发过程中,随着程序代码越写越多,在一个文件里代码就会越来越长,越来越不容易维护。
为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在python中,一个.py
文件就称之为一个模块(module)。
使用模块有什么好处?
最大的好处是大大提高了代码的可维护性。其次,编写代码不必从零开始。当一个模块编写完毕,就可以被其他地方引用。我们在编写程序的时候,也经常引用其他模块,包括python内置的模块和来自第三方的模块。
使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突。但是也要注意,尽量不要与内置函数名字冲突。
你也许还想到,如果不同的人编写的模块名相同怎么办?为了避免模块名冲突,python又引入了按目录来组织模块的方法,称为包(package)。
举个例子,一个abc.py
的文件就是一个名字叫abc
的模块,一个xyz.py
的文件就是一个名字叫xyz
的模块。
现在,假设我们的abc
和xyz
这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany
,按照如下目录存放
mycompany ├─ __init__.py ├─ abc.py └─ xyz.py
引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py
模块的名字就变成了mycompany.abc
,类似的,xyz.py
的模块名变成了mycompany.xyz
。
请注意,每一个包目录下面都会有一个__init__.py
的文件,这个文件是必须存在的,否则,python就把这个目录当成普通目录,而不是一个包。__init__.py
可以是空文件,也可以有python代码,因为__init__.py
本身就是一个模块,而它的模块名就是mycompany。
类似的,可以有多级目录,组成多级层次的包结构。比如如下的目录结构:
mycompany ├─ web │ ├─ __init__.py │ ├─ utils.py │ └─ www.py ├─ __init__.py ├─ abc.py └─ xyz.py
文件www.py
的模块名就是mycompany.web.www
notes: 自己创建模块时要注意命名,不能和python自带的模块名称冲突。例如,系统自带了sys模块,自己的模块就不可命名为sys.py,否则将无法导入系统自带的sys模块。
2. 使用模块
python本身就内置了很多非常有用的模块,只要安装完毕,这些模块就可以立刻使用。
我们以内建的sys
模块为例,编写一个hello
的模块:
#!/usr/bin/env python3 # -*- coding: utf-8 -*- ' a test module ' __author__ = 'michael liao' import sys def test(): args = sys.argv # argv参数用列表存储命令行的所有参数 if len(args)==1: # 当列表长度为1时即只有一个参数时 print('hello, world!') elif len(args)==2: # 当命令行有两个参数时 print('hello, %s!' % args[1]) else: print('too many arguments!') if __name__=='__main__': test()
第1行和第2行是标准注释,第1行注释可以让这个hello.py文件直接在unix/linux/mac上运行,第2行注释表示.py文件本身使用标准utf-8编码;
第4行是一个字符串,表示模块的文档注释,任何模块代码的第一个字符串都被视为模块的文档注释;
第6行使用__author__
变量把作者写进去,这样当你公开源代码后别人就可以瞻仰你的大名;
以上就是python模块的标准文件模板,当然也可以全部删掉不写,但是,按标准办事肯定没错。
后面开始就是真正的代码部分。
你可能注意到了,使用sys
模块的第一步,就是导入该模块:
import sys
导入sys
模块后,我们就有了变量sys
指向该模块,利用sys这个变量,就可以访问sys模块的所有功能。
sys
模块有一个argv
变量,用list
存储了命令行的所有参数。argv
至少有一个元素,因为第一个参数永远是该.py文件的名称,例如:
运行python3 hello.py
获得的sys.argv
就是['hello.py']
,注意这里python3
不算是参数;
运行python3 hello.py michael
获得的sys.argv
就是['hello.py', 'michael]
。
最后,注意到这两行代码:
if __name__=='__main__': test()
当我们在命令行运行hello
模块文件时,python解释器把一个特殊变量__name__
置为__main__
,而如果在其他地方导入该hello
模块时,if
判断将失败,因此,这种if
测试可以让一个模块通过命令行运行时执行一些额外的代码,最常见的就是运行测试。
我们可以用命令行运行hello.py
看看效果:
$ python3 hello.py hello, world! $ python hello.py michael hello, michael!
如果启动python交互环境,再导入hello
模块:
>>> import hello >>>
导入时,没有打印hello, word!
,因为没有执行test()
函数。
调用hello.test()
时,才能打印出hello, word!
:
>>> hello.test() hello, world!
上一篇: vue+element项目中过滤输入框特殊字符小结
下一篇: [Linux]F5负载均衡器