Python基础（九）- 模块(module)

模块化程序设计概念

• 包类似于文件夹，模块类似于文件

1. Python 程序由模块组成。一个模块对应 python 源文件，一般后缀名是：.py。
2. 模块由语句组成。运行 Python 程序时，按照模块中语句的顺序依次执行。
3. 语句是 Python 程序的构造单元，用于创建对象、变量赋值、调用函数、控制语句等。

标准库模块(standard library)

与函数类似，模块也分为标准库模块和用户自定义模块。
Python 标准库（标准库模块）提供了操作系统功能、网络通信、文本处理、文件处理、数学运算等基 本的功能。比如：random(随机数)、math(数学运算)、time(时间处理)、file(文件处理)、 os(和操作系统交互)、sys(和解释器交互)等。
 另外，Python 还提供了海量的第三方模块，使用方式和标准库类似。功能覆盖了我们 能想象到的所有领域，比如：科学计算、WEB 开发、大数据、人工智能、图形系统等。

为什么要模块化编程

模块(module)对应于 Python 源代码文件(.py 文件)。模块中可以定义变量、函数、 类、普通语句。 这样，我们可以将一个 Python 程序分解成多个模块，便于后期的重 复应用。

模块化编程有如下几个重要优势：

1. 便于将一个任务分解成多个模块，实现团队协同开发，完成大规模程序
2. 实现代码复用。一个模块实现后，可以被反复调用。
3. 可维护性增强。

模块化编程的流程

模块化编程的一般流程：

1. 设计 API，进行功能描述。 （不涉及代码，用文档描述）
2. 编码实现 API 中描述的功能。
3. 在模块中编写测试代码，并消除全局代码。
4. 使用私有函数实现不被外部客户端调用的模块函数。

模块的 API 和功能描述要点

API(Application Programming Interface 应用程序编程接口)是用于描述模块中提供的函数和类的功能和使用方式。（描述类和函数的功能及使用方式）

模块化编程中，首先设计的就是模块的 API（即要实现的功能描述），然后开始编 码实现 API 中描述的功能。最后，在其他模块中导入本模块进行调用。

我们可以通过help(模块名)查看模块的API。一般使用时先导入模块 然后通过help查看。

也可以在 python 的 api 文档中查询。首先进入 python 的安装目录下的 docs 子目录；双击打开 chm 文档，即可通过索引输入“math”查询到对应的 API 内容。

我们可以通过__doc__可以获得模块的文档字符串的内容：

salary.py
"""
计算员工工资
"""

def yearSalary(monthSalary):
    """根据传入的月薪，计算出年薪
    """
    pass

def daySalary(monthSalary):
    """根据传入的月薪，计算出每天的薪资
    """
    pass
    
main.py
import salary
print(salary.__doc__)
print(salary.yearSalary.__doc__)
print(salary.daySalary.__doc__)

输出：
计算员工工资

根据传入的月薪，计算出年薪
    
根据传入的月薪，计算出每天的薪资

模块的创建和测试代码

每个模块都有一个名称，通过特殊变量__name__可以获取模块的名称。在正常情况下，模块名字对应源文件名。
仅有一个例外，就是当一个模块被作为程序入口时（主 程序、交互式提示符下），它的__name__的值为“main”。我们可以根据这个特点，将模块源代码文件中的测试代码进行独立的处理。例如：

import math 
print(math.__name__) #获取模块名称

输出:
math

通过__name==“main”独立处理模块的测试代码:

"""
计算员工工资
"""
def yearSalary(monthSalary):
    """根据传入的月薪，计算出年薪
    """
    return monthSalary*12

def daySalary(monthSalary):
    """根据传入的月薪，计算出每天的薪资
    """
    return monthSalary/12

if __name__ == '__main__':  #如果当前模块是程序入口
    print(yearSalary(30000))
    print(daySalary(30000))

输出：
360000
2500.0

模块的导入

模块化设计的好处之一就是“代码复用性高”。写好的模块可以被反复调用，重复使用。 模块的导入就是“在本模块中使用其他模块”。

import语句导入

import 语句的基本语法格式如下：

import 模块名         #导入一个模块
import 模块 1，模块 2…   #导入多个模块
import 模块名 as 模块别名   #导入模块并使用新名字

import 加载的模块分为四个通用类别：

• 使用 python 编写的代码（.py 文件）；
• 已被编译为共享库或 DLL 的 C 或 C++扩展；
• 包好一组模块的包
• 使用 C 编写并链接到 python 解释器的内置模块；

我们一般通过 import 语句实现模块的导入和使用，import 本质上是使用了内置函数__import__()
当我们通过 import 导入一个模块时，python 解释器进行执行，最终会生成一个对象， 这个对象就代表了被加载的模块。

import math
print(id(math))
print(type(math))
print(math.pi) #通过math.成员名来访问模块中的成员

输出：
2065342821784
<class 'module'>
3.141592653589793

from … import语句导入

Python 中可以使用 from…import 导入模块中的成员。基本语法格式如下：

from 模块名 import 成员 1，成员 2，…

如果希望导入一个模块中的所有成员，则可以采用如下方式：

from 模块名 import *

注意：尽量避免“from 模块名 import ”这种写法。 它表示导入模块中所有的不 是以下划线(_)开头的名字都导入到当前位置。 但你不知道你导入什么名字，很有可能 会覆盖掉你之前已经定义的名字。而且可读性极其的差。一般生产环境中尽量避免使用， 学习时没有关系。

from math import pi,sin
print(sin(pi/2))

输出：
1.0

import 语句和 from…import 语句的区别

import()动态导入

import 语句本质上就是调用内置函数__import__()，我们可以通过它实现动态导入。给__import__()动态传递不同的的参数值，就能导入不同的模块。

s = 'math'
m = __import__(s)
print(m.pi)

输出：
3.141592653589793

注意：一般不建议我们自行使用__import__()导入，其行为在 python2 和 python3 中 有差异，会导致意外错误。如果需要动态导入可以使用 importlib 模块。

import importlib
a  = importlib.import_module('math')
print(a.pi)

输出：
3.141592653589793

模块的加载问题

当导入一个模块时， 模块中的代码都会被执行。不过，如果再次导入这个模块， 则不会再次执行。
导入模块更多的时候需要的是定义模块 中 的 变 量 、 函 数 、 对 象 等 。 这 些 并 不 需 要 反 复 定 义 和 执 行 。 “ 只 导 入 一 次 import-only-once”就成了一种优化。

一个模块无论导入多少次，这个模块在整个解释器进程内有且仅有一个实例对象。

import math
print(id(math))
import math as m
print(id(m))

输出：
2250728961432
2250728961432

• 重新加载
  有时候我们确实需要重新加载一个模块，这时候可以使用：importlib.reload() 方法。

包package的使用

包(package)的概念和结构

当一个项目中有很多个模块时，需要再进行组织。我们将功能类似的模块放到一起， 形成了“包”。本质上，“包”就是一个必须有__init__.py 的文件夹。典型结构如下：
包下面可以包含“模块(module)”，也可以再包含“子包(subpackage)”。就像文件 夹下面可以有文件，也可以有子文件夹一样。

上图中，a 是上层的包，下面有一个子包：aa。可以看到每个包里面都有__init__.py 文件。

导入包操作和本质

上一节中的包结构，我们需要导入 module_AA.py。方式如下：

1. import a.aa.module_AA
   在使用时，必须加完整名称来引用，比如：a.aa.module_AA.fun_AA()
2. from a.aa import module_AA
   在使用时，可以直接使用模块名。 比如：module_AA.fun_AA()
3. from a.aa.module_AA import fun_AA
   在使用时，直接可以使用函数名。 比如：fun_AA()

• from package import item 这种语法中，item 可以是包、模块(文件)，也可以是单个函数、 类、变量。
• import item1.item2 这种语法中，item 必须是包或模块，不能是其他。

导入包的本质其实是“导入了包的__init__.py”文件。也就是说，”import pack1”意味 着执行了包 pack1 下面的__init__.py 文件。 这样，可以在__init__.py 中批量导入我们需要 的模块，而不再需要一个个导入。

init.py 的三个核心作用：

1. 作为包的标识，不能删除。 #有了它就是一个包，没有就只是一个文件而已
2. 用来实现模糊导入
3. 导入包实质是执行__init__.py 文件，可以在__init__.py 文件中做这个包的初始化、以及 需要统一执行代码、批量导入。

用*导入包

import * 这样的语句理论上是希望文件系统找出包中所有的子模块，然后导入它们。 这可能会花长时间等。Python 解决方案是提供一个明确的包索引。
这个索引由 init.py 定义 all 变量，该变量为一列表。
如上例 a 包下的 init.py 中，可定义 all = [“module_A”,“module_A2”, 这意味着， from sound.effects import * 会从对应的包中导入__all__中的两个子模块；

注意：尽管提供 import * 的方法，仍不建议在生产代码中使用这种写法。（这样导入可能根本不知道代码导入了什么，会对代码编写、调试产生困扰）

包内引用

包之间的引用：
如果是子包内的引用，可以按相对位置引入子模块 ；以 aa 包下的 module_AA 中导入 a 包下内容为例：

from … import module_A  #…表示上级目录 .表示同级目录
from . import module_A2   #.表示同级目录

sys.path 和模块搜索路径

当我们导入某个模块文件时， Python 解释器去哪里找这个文件呢？只有找到这个文 件才能读取、装载运行该模块文件。它一般按照如下路径寻找模块文件（按照顺序寻找，找 到即停不继续往下寻找）：

1. 内置模块
2. 当前目录
3. 程序的主目录
4. pythonpath 目录（如果已经设置了 pythonpath 环境变量）
5. 标准链接库目录
6. 第三方库目录（site-packages 目录）
7. .pth 文件的内容（如果存在的话）
   建立.pth文件，文件名为：.pth.（系统不允许创建空文件）
8. sys.path.append()临时添加的目录

当任何一个 python 程序启动时，就将上面这些搜索路径(除内置模块以外的路径)进行收集， 放到 sys 模块的 path 属性中（sys.path）。

import sys
sys.path.append('d:/') #添加一个临时目录
print(sys.path)

输出：
['C:\\Users\\test\\Desktop', 'D:\\Software\\Python\\Python36\\Lib\\idlelib', 'D:\\Software\\Python\\Python36\\python36.zip', 'D:\\Software\\Python\\Python36\\DLLs', 'D:\\Software\\Python\\Python36\\lib', 'D:\\Software\\Python\\Python36', 'D:\\Software\\Python\\Python36\\lib\\site-packages', 'd:/']

• pythonpath 环境变量的设置
  
  
  

• .pth 文件的写法
  我们可以在 site-packages 目录下（例如：D:\Software\Python\Python36\Lib\site-packages）添加.pth 文件。并在文件中增加内容：
  
  需确保 g:\a,g:\b,g:\c 对应的目录真实存在。在 windows 系统中建立.pth 文件，由于没有文件名不能直接建立。需要输入：“.pth.”才能正常建立.pth 文件。

模块发布和安装

模块的本地发布

当我们完成了某个模块开发后，可以将他对外发布，其他开发者也可以以“第三方扩展 库”的方式使用我们的模块。我们按照如下步骤即可实现模块的发布：
1.为模块文件创建如下结构的文件夹（一般，文件夹的名字和模块的名字一样）
在这里插入图片描述

其中：

demo1.py内容
def func1():
	print('demo1')
demo2.py内容
def func2():
    print('demo2')
__init__.py内容：空

2. 在文件夹中创建一个名为『setup.py』的文件，内容如下：

from distutils.core import setup
setup(
    name = 'MyModules', #对外我们的模块名字
    version = '1.0', #版本号
    description='这是第一个对外发布的模块，测试', #描述
    author='sherry',#作者
    author_email='sherry@163.com',
    py_modules=['MyModules.demo1', 'MyModules.demo2']
)

3. 构建一个发布文件。通过终端，cd 到模块文件夹 c 下面，再键入命令：

python setup.py sdist

执行完毕后，目录结构变为：

本地模块的安装

将发布安装到你的本地计算机上。仍在 cmd 命令行模式下操作，进 setup.py 所在目 录，键入命令：

python setup.py install

安装成功后，我们进入 python 目录/Lib/site-packages 目录（第三方模块都安装的这 里,python 解释器执行时也会搜索这个路径）：

使用：

import MyModules.demo1
MyModules.demo1.func1()

输出：
demo1

上传模块到PyPI

将自己开发好的模块上传到 PyPI 网站上，将成为公开的资源，可以让全球用户自由使 用。按照如下步骤做，很容易就实现上传模块操作。

• 注册 PyPI 网站

http://pypi.python.org

• 创建用户信息文件.pypirc
  *方式 1： 使用命令(适用 Linux)
  输入并执行后

python setup.py register

，然后输入用户名和密码，即可。

*方式 2：使用文件（适用 windows,Linux）
在用户的家目录里创建一个文件名为.pypirc, 内容为：

【注】
Linux 的家目录： ~/.pypirc
Windows 的家目录是： c:/user/用户名
在 windows 下直接创建不包含文件名的文件会失败，因此创建时文件名为“.pypirc.”， 前后都有两个点即可。

• 上传并远程发布
  进入 setup.py 文件所在目录，使用命令

python setup.py sdist upload，

即可以 将模块代码上传并发布：

• 管理你的模块
  我们登录 pypi 官网，可以看到： 如果你的模块已经上传成功，那么当你登录 PyPI 网站后应该能在右侧导航栏看到管理 入口。

让别人使用你的模块

模块发布完成后，其他人只需要使用 pip 就可以安装你的模块文件。比如：

pip install package-name

如果你更新了模块，别人可以可以通过–update 参数来更新：

pip install package-name update