模块概述
在Python中,一个 .py 文件就是一个模块(Module)。
为了避免模块名冲突,Python又引入了按目录来组织模块的方法,称为包(Package)。mycompany
├─ web
│ ├─ __init__.py
│ ├─ utils.py
│ └─ www.py
├─ __init__.py
├─ abc.py
├─ xyz.py
└─ utils.py
引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。
现在,abc.py模块的名字就变成了mycompany.abc,xyz.py的模块名变成了mycompany.xyz;www.py模块的名字就变成了mycompany.web.www,两个文件utils.py的模块名分别是mycompany.utils和mycompany.web.utils。
每一个包目录下面都会有一个__init__.py的文件,这个文件是必须存在的,否则,Python就把这个目录当成普通目录,而不是一个包。__init__.py可以是空文件,也可以有Python代码。
模块名不能和系统模块名冲突,最好先查看系统是否已存在该模块,查看方法是在Python交互环境中执行import abc,若成功则说明系统已经存在此模块。
编写模块
编写一个 hello.py 模块:#!/usr/bin/env python3
# -*- coding: utf-8 -*-
' a test module '
__author__ = 'Michael Liao'
import sys
def test():
args = sys.argv
if len(args)==1:
print('Hello, world!')
elif len(args)==2:
print('Hello, %s!' % args[1])
else:
print('Too many arguments!')
if __name__=='__main__':
test()
第1行是标准注释,可以让这个 .py 文件直接在 Unix/Linux/Mac 上运行;
第2行是标准注释,表示 .py 文件使用标准UTF-8编码;
第4行是一个字符串,表示模块的文档注释,任何模块代码的第一个字符串都被视为模块的文档注释;
第6行使用 __author__ 特殊变量记录作者名称;
第8行导入系统内建的sys模块,sys 模块有一个 argv 变量,用list存储了命令行的所有参数。argv至少有一个元素,第一个参数永远是该 .py 文件的名称。运行python3 hello.py获得的sys.argv就是['hello.py'];
运行python3 hello.py Wu获得的sys.argv就是['hello.py', 'Wu']。
最后两行代码的意义为:当我们在命令行运行 hello 模块文件时,Python解释器把一个特殊变量 __name__ 置为 __main__,而如果在其他地方导入该hello模块时则不会设置,因此这种if测试可以让一个模块通过命令行运行时执行一些额外的代码,最常见的就是运行测试。
测试运行
我们可以用命令行运行 hello.py 看看效果:$ python3 hello.py
Hello, world!
$ python hello.py Wu
Hello, Wu!
如果启动Python交互环境,再导入hello模块:$ python3
>>> import hello
>>>
导入时,没有打印 Hello, word!,因为没有执行test()函数。
这时候需要调用 hello.test() ,才能打印出Hello, word!:>>> hello.test()
Hello, world!