关于模块操作

第七章 模块

1. 模块化程序设计理念

1.1 模块和包
随着数量增加，管理方式会发生本质变化
函数的诞生：语句越来越多，程序越来越复杂，将同一个功能的语句封装到函数当中
类与对象的诞生：函数和变量变多了，将同一类型对象的”数据和行为“，放到一起统一管理和迪奥哟
模块的诞生：函数和类增多，将实现类似功能的函数与类统一放到一个模块当中
包的诞生：实现类似功能的模块放在一起

1.2 标准库模块
与函数类似，模块也分为标准库模块和用户自定义模块
Python标准库提供操作系统功能、网络通信、文本处理、文件处理、数学运算等基本的功能。比如：random(随机数)、math(数学运算)、time(时间处理)、file(文件处理)、os(和操作系统交互)、sys(和解释器交互)等。
另外，Python 还提供了海量的第三方模块，使用方式和标准库类似。功能覆盖了我们能想象到的所有领域，比如：科学计算、WEB 开发、大数据、人工智能、图形系统等。
1.3 为什么需要模块化编程
模块(module)对应于 Python 源代码文件(.py 文件)。模块中可以定义变量、函数、类、普通语句。 这样，我们可以将一个 Python 程序分解成多个模块，便于后期的重复应用。
模块化编程（Modular Programming）将一个任务分解成多个模块。每个模块就像一个积木一样，便于后期的反复使用、反复搭建。
模块化编程有如下几个重要优势：

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

1.4 模块化编程的一般流程
模块化编程的一般流程：
1 设计API进行功能描述
2. 编码实现API功能
3. 在模块中编写测试代码，并消除全局代码
4. 使用私有函数实现不被外部客户端调用的模块函数
1.5 模块的API和功能描述要点
API(Application Programming Interface 应用程序编程接口)是用于描述模块中提供的函数和类的功能描述和使用方式描述
API(Application Programming Interface 应用程序编程接口)是用于描述模块中提供的函数和类的功能描述和使用方式描述
可以通过help(模块名)查看模块API，使用时先导入模块，然后通过help函数查看。
**【操作】**导入math模块，通过help(math)查看

也可以在python中的api文档中查询。首先进入 python 的安装目录下的 docs 子目

[示例]设计计算薪水模块的API

"""
本模块用于计算公司员工的薪资
"""
company="Tianjin University"
def yearSalary(monthsalary):
    """根据传入月薪，计算年薪"""
    pass
def daysalary(monthsalary):
    """根据传入月薪，计算日薪"""
    pass

如上模块只有功能描述和规范，剩下的编码需要编码人员按要求实现。通过__doc__获得模块的文档字符串内容

import salary
print(salary.__doc__)
print(salary.yearSalary.__doc__)

运行结果：

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

import math
print(math.__name__)

【示例】通过__name=="main"独立处理模块的测试代码

ompany="天津大学"
def yearSalary(monthSalary):
    """根据输入月薪，计算年薪"""
    return monthSalary*12
def daySalary(monthSalary):
    """根据输入月薪，计算日薪"""
    return monthSalary/22.5

if __name__=="__main__": #测试代码
    print(yearSalary(3000))
    print(daySalary(3000))

1.7 模块文档字符串和API设计
我们可以在模块的第一行增加一个文档字符串，用于描述模块的相关功能。然后，通过__doc__可以获得文档字符串的内容。具体参见API文档

2. 模块导入

模块化设计的好处之一就是“代码复用性高”。写好的模块可以被反复调用，重复使用。模块的导入就是“在本模块中使用其他模块”。
2.1 import 语句导入
import语句的基本语法几个事：
import 模块名 #导入一个模块
import 模块1，模块2…#导入多个模块
import 模块名 as 模块别名#导入模块并使用新名字

import加载的模块分为四个通用类别：
a.使用 python 编写的代码（.py 文件）；
b.已被编译为共享库或 DLL 的 C 或 C++扩展；
c.包好一组模块的包
d.使用 C 编写并链接到 python 解释器的内置模块；
一般是通过import语句来实现模块的导入和使用，import本质是使用了内置函数__import__（）
当通过import导入一个模块，python解释器就会开始执行，生成一个对象，这个对象就是被加载的模块

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

执行结果是：

根据执行结果可知，math模块被执行以后，生成一个type为module的对象，这个对象被math变量引用，math变量可以引用模块中的所有内容。
import导入多个模块，即生成多个module类的对象；给模块起别名，即新创建一个变量引用加载的模块对象。

2.2 from…import 导入
from…import可以用于导入模块中的成员，基本的语法格式如下：
from 模块名 import 成员1，成员2
如果希望导入一个模块所有成员则，可以
from 模块名 import *
【注】尽量避免“from 模块名 import ”这种写法。 它表示导入模块中所有的不是以下划线(_)开头的名字都导入到当前位置。 但你不知道你导入什么名字，很有可能
会覆盖掉你之前已经定义的名字。而且可读性极其的差。一般生产环境避免使用

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

2.3 import语句和from…import语句的区别
import是导入模块，from…import导入的是模块中的函数或者类。
import 导入的是“文件”，我们要使用该“文件”下的内容，必须前面加“文件名称”。from…import 导入的是文件下的“内容”，我们直接使用这些“内容”即可，前面再也不需要加“文件名称”了。

import calculator #导入文件，使用时必须加文件名称才能引用内容
a=calculator.add(10,20)
#add(10,20)就会报错，不加模块名无法识别
print(a)

from calculator import * #不用文件名，可以直接引用里面的内容
b=add(20,20)
print(b)
c=MyNum()
c.print123()

执行结果：

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


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

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

import math as n
print(n.sin(n.pi/2))

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

2.5 模块的加载问题
当导入一个模块时， 模块中的代码都会被执行。不过，如果再次导入这个模块，则不会再次执行。
Python 的设计者为什么这么设计？因为，导入模块更多的时候需要的是定义模块中 的 变 量 、 函 数 、 对 象 等 。 这 些 并 不 需 要 反 复 定 义 和 执 行 。 “ 只 导 入 一 次import-only-once”就成了一种优化。
一个模块无论导入多少次，这个模块在整个解释器进程内有且仅有一个实例对象。
重新加载
有时候确实需要重新加载，可以用：importlib.reload()

3. 包package的使用

3.1 包（package）的概念和结构
当一个项目中有很多个模块时，需要再进行组织。我们将功能类似的模块放到一起，形成了“包”。本质上，“包”就是一个必须有__init__.py 的文件夹。典型结构如下：

包下面可以包含“模块(module)”，也可以再包含“子包(subpackage)”。就像文件夹下面可以有文件，也可以有子文件夹一样

上图中，a 是上层的包，下面有一个子包：aa。可以看到每个包里面都有__init__.py 文件。
3.2 pycharm中创建包
在 pycharm 开发环境中创建包，非常简单。在要创建包的地方单击右键：New–>Python package 即可。pycharm 会自动帮助我们生成带有__init__.py 文件的包。

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

【注】

1. from package import item 这种语法中，item 可以是包、模块，也可以是函数、
   类、变量。
2. import item1, item2 这种语法中，item 必须是包或模块，不能是其他
   导入包的本质其实是“导入了包的__init__.py”文件。也就是说，”import pack1”意味着执行了包 pack1 下面的__init__.py 文件。 这样，可以在__init__.py 中批量导入我们需要的模块，而不再需要一个个导入.
   init.py 的三个核心作用:
3. 包的表示，不能删除
4. 模糊导入
5. 导入包的实质是执行__init__.py文件，可以在__init__.py文件中做包的初始化，以及需要统一执行代码，批量导入
   【示例】测试包的__init__.py文件本质用法

import turtle
import math
print("导入a包")

b包下的module_B1.py文件中导入a包，代码如下：

import a
print(a.math.pi)

【注】如上测试我们可以看出 python 的设计者非常巧妙的通过__init__.py 文件将包转成了模块的操作。因此，可以说“包的本质还是模块”
3.4 用*导入包
import * 这样的语句理论上是希望文件系统找出包中所有的子模块，然后导入它们。这可能会花长时间等。Python 解决方案是提供一个明确的包索引。
这个索引由 init.py 定义 all 变量，该变量为一列表，如上例 a 包下的__init__.py 中，可定义 all = [“module_A”,“module_A2”]
如果包定义文件 init.py 存在一个叫做 all 的列表变量，那么在使用 from package import * 的时候就把这个列表中的所有名字作为包内容导入。如果 all 真的没有定义，那么使用from sound.effects import *这种语法的时候，就不会导入包 sound.effects 里的任何子模块。他只是把包sound.effects和它里面定义的所有内容导入进来（可能运行__init__.py里定义的初始化代码）
**[示例]**没有__all__时在b包引用a包的calculator

import a
print(a.math.pi)
from a import *
print(a.calculator.add(1,2))

执行结果

【示例】有__all__时在b包引用a包的calculator
a包__init__程序

import turtle
import math
__all__=["calculator"]
print("导入a包")

b包程序

import a
print(a.math.pi)
from a import *
print(a.calculator.add(1,2))

执行结果

3.5 包内引用
如果是子包内的引用，可以按相对位置引入子模块。比如以aa包下的 module_AA 中导入 a包下内容为例：
from…import module_A #…表示上级目录，.表示同级目录
from.import module_A1#.表示同级目录
3.6 sys.path和模块搜索途径
当我们导入某个模块文件时， Python 解释器去哪里找这个文件呢？只有找到这个文件才能读取、装载运行该模块文件。它一般按照如下路径寻找模块文件（按照顺序寻找，找到即停不继续往下寻找）。

1. 内置模块
2. 当前目录
3. 程序的主目录
4. pythonpath 目录（如果已经设置了 pythonpath 环境变量）
5. 标准链接库目录
6. 第三方库目录（site-packages 目录）
7. .pth 文件的内容（如果存在的话）
8. sys.path.append()临时添加的目
   当任何一个 python 程序启动时，就将上面这些搜索路径(除内置模块以外的路径)进行收集，放到 sys 模块的 path 属性中（sys.path）
   · 使用 sys.path 查看和临时修改搜索路径
   在项目的b目录下建立测试模块：

import sys
sys.path.append("d:/")
print(sys.path)

执行结果：

pythonpath 环境变量的设置
windows 系统中通过如下操作添加和设置pythonpath 环境变量



· .path文件的写法
我们可以在 site-packages 目录下添加.pth 文件。怎么新建pth文件？

并在文件中增加内容：

【注】

1. 需确保 g:\a,g:\b,g:\c 对应的目录真实存在。
2. 在 windows 系统中建立.pth 文件，由于没有文件名不能直接建立。需要输入“.pth.”才能正常建立.pth 文件

4. 模块发布和安装

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

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

3. 构建一个发布文件。通过终端，cd 到模块文件夹 c 下面，
就是找到这个文件终端，在文件终端后面键入命令：
python setup.py sdis

4.2 本地安装模块
将发布安装到你的本地计算机上。仍在 cmd 命令行模式下操作，进 setup.py 所在目录，键入命令：
python setup.py install
安装成功后，我们进入 python 目录/Lib/site-packages 目录（第三方模块都安装的这
里,python 解释器执行时也会搜索这个路径）发现有这个包名，说明安装成果

安装成功后，直接使用 import 导入即可。
import baizhanMath2.demo