浅谈Python中的模块
模块
为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在python中,一个.py文件就称之为一个模块(module)。
使用模块有什么好处?
当一个模块编写完毕,就可以被其他地方引用。我们在编写程序的时候,也经常引用其他模块,包括python内置的模块和来自第三方的模块。
模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中。但是也要注意,尽量不要与内置函数名字冲突。
如果不同的人编写的模块名相同怎么办?为了避免模块名冲突,python又引入了按目录来组织模块的方法,称为包(package)。
假设我们的abc和xyz这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany,按照如下目录存放:
引入了包以后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py模块的名字就变成了mycompany.abc,类似的,xyz.py的模块名变成了mycompany.xyz。
请注意,每一个包目录下面都会有一个__init__.py的文件,这个文件是必须存在的,否则,python就把这个目录当成普通目录,而不是一个包。init.py可以是空文件,也可以有python代码,因为__init__.py本身就是一个模块,而它的模块名就是mycompany。
使用模块
!/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行和第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 hello.py michael获得的sys.argv就是['hello.py', 'michael]。
工具脚本就是通过sys.argv读取使用参数
最后,注意到这两行代码
if __name__=='__main__': test()
当我们在命令行运行hello模块文件时,python解释器把一个特殊变量__name__置为__main__,而如果在其他地方导入该hello模块时,__name__则为其他地方,if判断将失败,因此,这种if测试可以让一个模块通过命令行运行时执行一些额外的代码,最常见的就是运行测试
比如:
如果直接命令行使用python3 hello.py,__name__
为__main__
,满足if,执行test()
如果从test.py导入使用hello.py模块,__name__
就为test,不满足if,也就不会执行test()
作用域
在一个模块中,我们可能会定义很多函数和变量,但有的函数和变量我们希望给别人使用,有的函数和变量我们希望仅仅在模块内部使用。在python中,是通过_前缀来实现的。
正常的函数和变量名是公开的(public),可以被直接引用,比如:abc,x123,pi等;
类似__xxx__这样的变量是特殊变量,可以被直接引用,但是有特殊用途,比如上面的__author__,__name__就是特殊变量,hello模块定义的文档注释也可以用特殊变量__doc__访问,我们自己的变量一般不要用这种变量名;
类似_xxx和__xxx这样的函数或变量就是非公开的(private),不应该被直接引用,比如_abc,__abc等;
之所以我们说,private函数和变量“不应该”被直接引用,而不是“不能”被直接引用,是因为python并没有一种方法可以完全限制访问private函数或变量,但是,从编程习惯上不应该引用private函数或变量。
换句话说,仅仅是声明而已,要访问还是能访问的,private函数或变量不应该被别人引用,那它们有什么用呢?
ef _private_1(name): return 'hello, %s' % name def _private_2(name): return 'hi, %s' % name def greeting(name): if len(name) > 3: return _private_1(name) else: return _private_2(name)
我们在模块里公开greeting()函数,而把内部逻辑用private函数隐藏起来了,这样,调用greeting()函数不用关心内部的private函数细节,这也是一种非常有用的代码封装和抽象的方法,即:
外部不需要引用的函数全部定义成private,只有外部需要引用的函数才定义为public。
以上就是浅谈python中的模块的详细内容,更多关于python模块的资料请关注其它相关文章!