模块

为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少。在Python中,一个.py文件就称为一个模块(Module)。
使用模块有什么好处?
最大的好处是大大提高了代码的可维护性。其次,编写代码不必从零开始。当一个模块编写完毕,就可以被其他地方引用。我们在编写程序时,也经常引用其他模块,包括Python内置的模块和第三方的模块。
使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中,因此,我们自己在编写模块时,不必考虑名字会与其他模块冲突。但是也要注意,尽量不要与内置函数名字冲突。

你也许还想到,如果不同的人编写的模块名字相同怎么办?为了避免模块名冲突,Python又引入了按目录来组织模块的方法,称为包(Package)。

举个例子,有abc.py和xyz.py两个模块。现在我们假设我们的abc和xyz这两个模块名字与其他模块冲突了,于是我们可以通过包来组织模块,避免冲突。方法是选择一个顶层包名,比如mycompany,按照如下目录存放:
(五)【重拾Python】模块_python
引入包后,只要顶层的包名不与别人冲突,那所有模块都不会与别人冲突。现在,abc.py模块名字就变成了mycompany.abc,类似的,xyz.py的模块名变成了mycompany.xyz。

注意,每一个包目录下都有一个__init__.py的文件,它告诉Python这个目录是一个包,而不是普通目录。__init__可以是空文件,也可以有代码,因为__init__.py,本身就是一个模块,而它的模块名就是mycompany。
类似的,可以有多级目录,组成多级层次的包结构。如:
(五)【重拾Python】模块_python_02
文件www.py的模块名就是mycompany.web.www。
创建模块时注意命名,不能和Python自带的模块名称冲突。例如sys模块。

我们以内建的sys模块为例,编写一个hello模块:
(五)【重拾Python】模块_python_03
第一行和第二行是标准注释,第一行注释可以让这个hello.py文件直接在Unix/Linux/Mac上运行,第二行注释表示.py文件本身使用标准UTF-8编码;
第四行是一个字符串,表示模块的文档注释,任何模块代码的第一个字符串都被视为模块的文档注释;
第六行使用__author__变量把作者写进去,这样当你公开源代码后别人就可以瞻仰你的大名了。

可以注意到,使用sys模块的第一步,就是导入该模块:
(五)【重拾Python】模块_python_04
导入sys模块后,我们就有了变量sys指向该模块,利用sys这个变量,就可以访问sys模块的所有功能。
sys模块有一个argv变量,用list存储了命令行的所有参数。argv至少有一个元素,因为第一个参数永远是该.py文件的名称,例如:
(五)【重拾Python】模块_python_05
最后注意:
(五)【重拾Python】模块_python_06

当我们在命令行运行hello模块文件时,Python解释器把一个特殊变量__name__置为__main__,而如果在其他地方导入该hello模块时,if判断将失败,因此,这种if测试可以让一个模块通过命令行运行时执行一些额外的代码,最常用的的就是运行测试。
也就是说,导入hello模块时判断为False,命令行执行时判断为Ture。
作用域
在一个模块中,我们可能会定义很多函数和变量,但有的函数和变量我们希望给别人使用,有的函数和变量我们希望仅仅在模块内部使用。在Python中,是通过_前缀来实现的。
正常的函数和变量名是公开的(public),可以被直接引用,比如:abc ,x123, PI等。
类似__xxx__这样的变量是特殊变量,可以被直接引用,但是有特殊用途,比如__author__,__name__就是特殊变量,hello模块定义的文档注释也可以用特殊变量__doc__访问,我们自己的变量一般不要用这种便变量;
类似_xxx和__xxx这样的函数或变量就是非公开的(private),不应该被直接引用,比如_abc, __abc等;
之所以我们说,private函数和变量"不应该“被直接引用,而不是”不能“被直接引用,是因为Python并没有一种方法可以完全限制private函数或变量,但是,从编程习惯上不应该引用private函数或变量。

private函数或变量不应该被别人引用,那有什么用呢:
(五)【重拾Python】模块_python_07

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

模块搜索路径
当我们试图加载一个模块时,Python会在指定的路径下搜索对应的.py文件,如果找不到,就会报错:
(五)【重拾Python】模块_python_08

默认情况下,Python解释器会搜索当前目录、安装已安装的内置模块和第三方模块,搜索路径存放在sys模块的path变量中:
(五)【重拾Python】模块_python_09

如果我们要添加自己的搜索目录,有两种方法:
一是直接修改sys.path,添加要搜索的目录:
(五)【重拾Python】模块_python_10
这种方法是在运行时修改,运行结束后失效。

第二种方法是设置环境变量PYTHONPATH,该环境变量的内容会被自动添加到模块搜索路径中。设置方式与设置Path环境变量类似。注意只需要添加你自己的搜索路径,Python自己本身的搜索路径不受影响。