在python中使用模块的教程

python本身就内置了很多非常有用的模块,只要安装完毕,这些模块就可以立刻使用。

我们以内建的sys模块为例,编写一个hello的模块:

#!/usr/bin/env python
# -*- 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行和第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文件的名称,例如:

运行python hello.py获得的sys.argv就是[‘hello.py’];

运行python hello.py michael获得的sys.argv就是[‘hello.py’, ‘michael]。

最后,注意到这两行代码:

if __name__==’__main__’:
test()

当我们在命令行运行hello模块文件时,python解释器把一个特殊变量__name__置为__main__,而如果在其他地方导入该hello模块时,if判断将失败,因此,这种if测试可以让一个模块通过命令行运行时执行一些额外的代码,最常见的就是运行测试。

我们可以用命令行运行hello.py看看效果:

$ python hello.py
hello, world!
$ python hello.py michael
hello, michael!

如果启动python交互环境,再导入hello模块:

$ python
python 2.7.5 (default, aug 25 2013, 00:04:04)
[gcc 4.2.1 compatible apple llvm 5.0 (clang-500.0.68)] on darwin
type “help”, “copyright”, “credits” or “license” for more information.
>>> import hello
>>>

导入时,没有打印hello, word!,因为没有执行test()函数。

调用hello.test()时,才能打印出hello, word!:

>>> hello.test()
hello, world!

别名

导入模块时,还可以使用别名,这样,可以在运行时根据当前环境选择最合适的模块。比如python标准库一般会提供stringio和cstringio两个库,这两个库的接口和功能是一样的,但是cstringio是c写的,速度更快,所以,你会经常看到这样的写法:

try:
import cstringio as stringio
except importerror: # 导入失败会捕获到importerror
import stringio

这样就可以优先导入cstringio。如果有些平台不提供cstringio,还可以降级使用stringio。导入cstringio时,用import … as …指定了别名stringio,因此,后续代码引用stringio即可正常工作。

还有类似simplejson这样的库,在python 2.6之前是独立的第三方库,从2.6开始内置,所以,会有这样的写法:

try:
import json # python >= 2.6
except importerror:
import simplejson as json # python 3:
return _private_1(name)
else:
return _private_2(name)

我们在模块里公开greeting()函数,而把内部逻辑用private函数隐藏起来了,这样,调用greeting()函数不用关心内部的private函数细节,这也是一种非常有用的代码封装和抽象的方法,即:

外部不需要引用的函数全部定义成private,只有外部需要引用的函数才定义为public。

Posted in 未分类