4. Python模块

为了编写可维护的代码，需要把很多函数分组，分别放到不同的文件里，这样，每个文件包含的代码就相对较少，很多编程语言都采用这种组织代码的方式。在Python中，一个.py文件就称之为一个模块（Module）

基本定义

模块有什么好处？

• 大大提高了代码的可维护性。
• 编写代码不必从零开始。当一个模块编写完毕，就可以被其他地方引用。
• 避免函数名和变量名冲突。相同名字的函数和变量完全可以分别存在不同的模块中，因此，在编写模块时，不必考虑名字会与其他模块冲突。但是尽量不要与内置函数名字冲突。

为了避免模块名冲突，Python又引入了按目录来组织模块的方法，称为包（Package）。
一个abc.py的文件就是一个名字叫abc的模块，一个xyz.py的文件就是一个名字叫xyz的模块。
假设abc和xyz这两个模块名字与其他模块冲突了，于是我们可以通过包来组织模块，避免冲突。方法是选择一个顶层包名，比如mycompany，按照如下目录存放
mycompany
├─ init.py
├─ abc.py
└─ xyz.py
引入了包以后，只要顶层的包名不与别人冲突，那所有模块都不会与别人冲突。现在，abc.py模块的名字就变成了mycompany.abc，类似的，xyz.py的模块名变成了mycompany.xyz。
**每一个包目录下面都会有一个__init__.py的文件，这个文件是必须存在的，**否则，Python就把这个目录当成普通目录，而不是一个包。init.py可以是空文件，也可以有Python代码，因为__init__.py本身就是一个模块，而它的模块名就是mycompany。
自己创建模块时要注意命名，不能和Python自带的模块名称冲突。例如，系统自带了sys模块，自己的模块就不可命名为sys.py，否则将无法导入系统自带的sys模块
模块名要遵循Python变量命名规范，不要使用中文、特殊字符

模块使用与参数示意

一个标准的程序应包括：标准注释、文档注释、作者、导包、代码主体等

#!/usr/bin/env python3
# -*- coding: utf-8 -*- 
'''
上面这两行是标准注释
第1行注释可以让这个hello.py文件直接在Unix/Linux/Mac上运行
第2行注释表示.py文件本身使用标准UTF-8编码；
'''

' a test module '
# 这一行是一个字符串，表示模块的文档注释
# 任何模块代码的第一个字符串都被视为模块的文档注释

__author__ = 'XXX'
# 使用__author__变量把作者写进去

import sys
# 导包，导入sys模块后就有了变量sys指向该模块，利用sys变量就可以访问sys模块的所有功能

def test():
    args = sys.argv
    # sys模块有一个argv变量，用list存储了命令行的所有参数
    # argv至少有一个元素，因为第一个参数永远是该.py文件的名称
    # 例如：在命令行中
    # 运行python3 hello.py获得的sys.argv就是['hello.py']
    # 运行python3 hello.py Michael获得的sys.argv就是['hello.py', 'Michael']
    if len(args)==1:
        print('Hello, world!')
    elif len(args)==2:
        print('Hello, %s!' % args[1])
    else:
        print('Too many arguments!')

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

作用域

在一个模块中，可能会定义很多函数和变量，但有的函数和变量我们希望给别人使用，有的函数和变量我们希望仅仅在模块内部使用。在Python中，是通过_前缀来实现的。
正常的函数和变量名是公开的（public），可以被直接引用
类似__xxx__这样的变量是特殊变量，可以被直接引用，但是有特殊用途，比如上面的__author__，__name__就是特殊变量，模块定义的文档注释也可以用特殊变量__doc__访问，自定义变量一般不要用这种变量名
类似_xxx和__xxx这样的函数或变量就是非公开的（private），不应该被直接引用，比如_abc，__abc等
Python并没有一种方法可以完全限制访问private函数或变量，但是，从编程习惯上不应该引用private函数或变量。
外部不需要引用的函数全部定义成private，只有外部需要引用的函数才定义为public

安装第三方模块

使用pip
模块搜索路径：当我们试图加载一个模块时，Python会在指定的路径下搜索对应的.py文件，如果找不到，就会报错。默认情况下，Python解释器会搜索当前目录、所有已安装的内置模块和第三方模块，搜索路径存放在sys模块的path变量中

>>> import sys
>>> sys.path
['', 'D:\\Python37\\python37.zip', 'D:\\Python37\\DLLs', 
'D:\\Python37\\lib', 'D:\\Python37', 'D:\\Python37\\lib\\site-packages', 
'D:\\Python37\\lib\\site-packages\\win32', 'D:\\Python37\\lib\\site-packages\\win32\\lib', 
'D:\\Python37\\lib\\site-packages\\Pythonwin']

如果我们要添加自己的搜索目录，有两种方法：一是直接修改sys.path，添加要搜索的目录，这种方法是在运行时修改，运行结束后失效。第二种方法是设置环境变量PYTHONPATH，该环境变量的内容会被自动添加到模块搜索路径中。设置方式与设置Path环境变量类似。注意只需要添加你自己的搜索路径，Python自己本身的搜索路径不受影响。