（六）模块

        为了编写可维护的代码，我们把很多函数分组，分别放到不同的文件里，这样每个文件包含的代码就相对较少，很多编程语言都采用这种组织代码的方式。在Python中，一个.py文件就称之为一个模块（Module）。其最大的好处是大大提高了代码的可维护性。其次，编写代码不必从零开始。当一个模块编写完毕，就可以被其他地方引用。我们在编写程序的时候，也经常引用其他模块，包括Python内置的模块和来自第三方的模块。

        使用模块还可以避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，我们自己在编写模块时，不必考虑名字会与其他模块冲突。但是也要注意，尽量不要与内置函数名字冲突。你也许还想到，如果不同的人编写的模块名相同怎么办？为了避免模块名冲突，Python又引入了按目录来组织模块的方法，称为包（Package）。

        举个例子，一个 abc.py 的文件就是一个名字叫 abc 的模块，现在假设我们的 abc 这两个模块名字与其他模块冲突了，于是我们可以通过包来组织模块，避免冲突。方法是选择一个顶层包名，比如 mycompany ，按照如下目录存放：

mycompany
├─ __init__.py
├─ abc.py
└─ xyz.py

引入了包以后，只要顶层的包名不与别人冲突，那所有模块都不会与别人冲突。现在， abc.py 模块的名字就变成了 mycompany .abc。

请注意，每一个包目录下面都会有一个 __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 。

        自己创建模块时要注意命名，不能和Python自带的模块名称冲突。例如，系统自带了sys模块，自己的模块就不可命名为sys.py，否则将无法导入系统自带的sys模块。最好先查看系统是否已存在该模块，检查方法是在Python交互环境执行 import XXX，若成功则说明系统存在此模块。

使用模块

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

#!/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存储了命令行的所有参数。

        最后，注意到这两行代码：

if __name__=='__main__':
    test()

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

作用域

        在一个模块中，我们可能会定义很多函数和变量，但有的函数和变量我们希望给别人使用，有的函数和变量我们希望仅仅在模块内部使用。在Python中，是通过 _ 前缀来实现的。

        正常的函数和变量名是公开的（public），类似 __xxx__ 这样的变量是特殊变量，可以被直接引用，但是有特殊用途，比如上面的 __author__ ，__name__ 就是特殊变量， hello 模块定义的文档注释也可以用特殊变量 __doc__ 访问，我们自己的变量一般不要用这种变量名；

        类似 _xxx和 __xxx这样的函数或变量就是非公开的（private），不应该被直接引用。之所以我们说，private函数和变量“不应该”被直接引用，而不是“不能”被直接引用，是因为Python并没有一种方法可以完全限制访问private函数或变量，但是，从编程习惯上不应该引用private函数或变量。

        private函数或变量不应该被别人引用，那它们有什么用呢？请看例子：

def _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。