1. 模块化(module)程序设计理念
1.1 模块和包概念的进化史
“量变引起质变”是哲学中一个重要的理论。量变为什么会引起质变呢?本质上理解,随着数量的增加,管理方式会发生本质的变化;旧的管理方式完全不适合,必须采用新的管理方式。
程序越来越复杂,语句多了,怎么管理?很自然的,我们会将实现同一个功能的语句封装到函数中,统一管理和调用,于是函数诞生了。程序更加复杂,函数和变量多了,怎么管理?同样的思路,“物以类聚”,我们将同一类型对象的“数据和行为”,也就是“变量和函数”,放到一起统一管理和调用,于是“类和对象”诞生了。程序继续复杂,函数和类更加多了,怎么办?好,我们将实现类似功能的函数和类统统放到一个模块中,于是“模块”诞生了。程序还要复杂,模块多了,怎么办? 于是,我们将实现类似功能的模块放到一起,于是“包”就诞生了。大家可以清晰的看到这发展的流程,核心的哲学思想就是“量变引起质变”、“物以类聚”。同样的思路,在企业管理、人的管理中思路完全一致。大家可以举一反三。
- Python 程序由模块组成。一个模块对应python 源文件,一般后缀名是:.py。
- 模块由语句组成。运行Python 程序时,按照模块中语句的顺序依次执行。
- 语句是Python 程序的构造单元,用于创建对象、变量赋值、调用函数、控制语句等。
1.2 标准库模块(standard library)
与函数类似,模块也分为标准库模块和用户自定义模块。Python 标准库提供了操作系统功能、网络通信、文本处理、文件处理、数学运算等基本的功能。比如:random(随机数)、math(数学运算)、time(时间处理)、file(文件处理)、os(和操作系统交互)、sys(和解释器交互)等。另外,Python 还提供了海量的第三方模块,使用方式和标准库类似。功能覆盖了我们能想象到的所有领域,比如:科学计算、WEB 开发、大数据、人工智能、图形系统等。
1.3 为什么需要模块化编程
模块(module)对应于Python 源代码文件(.py 文件)。模块中可以定义变量、函数、类、普通语句。这样,我们可以将一个Python 程序分解成多个模块,便于后期的重复应用。
模块化编程(Modular Programming)将一个任务分解成多个模块。每个模块就像一个积木一样,便于后期的反复使用、反复搭建。
模块化编程有如下几个重要优势:
- 便于将一个任务分解成多个模块,实现团队协同开发,完成大规模程序
- 实现代码复用。一个模块实现后,可以被反复调用。
- 可维护性增强。
1.4 模块化编程的流程
模块化编程的一般流程:
- 设计API,进行功能描述。
- 编码实现API 中描述的功能。
- 在模块中编写测试代码,并消除全局代码。
- 使用私有函数实现不被外部客户端调用的模块函数。
1.5 模块的API 和功能描述要点
API(Application Programming Interface 应用程序编程接口)是用于描述模块中提供的函数和类的功能描述和使用方式描述。
模块化编程中,首先设计的就是模块的API(即要实现的功能描述),然后开始编码实现API 中描述的功能。最后,在其他模块中导入本模块进行调用。
我们可以通过help(模块名)查看模块的API。一般使用时先导入模块然后通过help函数查看。
【示例】导入math 模块,并通过help()查看math 模块的API:
import math
help(math)
也可以在python 的api 文档中查询。首先进入python 的安装目录下的docs 子目录:
双击打开chm 文档,即可通过索引输入“math”查询到对应的API 内容:
【示例】设计计算薪水模块的API
"""
用于计算公司员工的薪资
"""
company = "sxt"
def yearSalary(monthSalary):
"""根据传入的月薪的值,计算出年薪:mothsalary*12"""
return monthSalary*12
def daySalary(monthSalary):
"""根据传入的月薪值,计算出1天的薪资。一个月按照22.5天计算(国家规定的工作日)"""
return monthSalary/22.5
如上模块只有功能描述和规范,需要编码人员按照要求实现编码。
我们可以通过__doc__可以获得模块的文档字符串的内容。
test.py 的源代码:
import Salary
print(Salary.__doc__)
print(Salary.daySalary.__doc__)
运行结果:
用于计算公司员工的薪资
根据传入的月薪值,计算出1天的薪资。一个月按照22.5天计算(国家规定的工作日)
1.6 模块的创建和测试代码
每个模块都有一个名称,通过特殊变量__name__可以获取模块的名称。在正常情况下,模块名字对应源文件名。仅有一个例外,就是当一个模块被作为程序入口时(主程序、交互式提示符下),它的__name__
的值为“__main__
”。我们可以根据这个特点,将模块源代码文件中的测试代码进行独立的处理。例如:
import math
math.__name__ #输出'math'
【示例】通过__name==“__main__”
独立处理模块的测试代码
"""
用于计算公司员工的薪资
"""
company = "sxt"
def yearSalary(monthSalary):
"""根据传入的月薪的值,计算出年薪:mothsalary*12"""
return monthSalary*12
def daySalary(monthSalary):
"""根据传入的月薪值,计算出1天的薪资。一个月按照22.5天计算(国家规定的工作日)"""
return monthSalary/22.5
if __name__ == "__main__":
print(yearSalary(5000))
运行结果
60000
1.7 模块文档字符串和API 设计
我们可以在模块的第一行增加一个文档字符串,用于描述模块的相关功能。然后,通过
__doc__可以获得文档字符串的内容。
【示例】模块文档字符串示例以及导入后如何读取文档字符串
test.py 的源代码:
import Salary
print(Salary.__doc__)
print(Salary.daySalary.__doc__)
运行结果:
用于计算公司员工的薪资
根据传入的月薪值,计算出1天的薪资。一个月按照22.5天计算(国家规定的工作日)
2. 模块的导入
模块化设计的好处之一就是“代码复用性高”。写好的模块可以被反复调用,重复使用。
模块的导入就是“在本模块中使用其他模块”。
2.1 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.成员名来访问模块中的成员
执行结果是:
3195423902992
<class 'module'>
3.141592653589793
由上,我们可以看到math 模块被加载后,实际会生成一个module 类的对象,该对象被
math 变量引用。我们可以通过math 变量引用模块中所有的内容。
我们通过import 导入多个模块,本质上也是生成多个module 类的对象而已。有时候,我们也需要给模块起个别名,本质上,这个别名仅仅是新创建一个变量引用加载的模块对象而已。
import math as m
#import math
#m = math
print(m.sqrt(4)) #开方运算
2.2 from…import 导入
Python 中可以使用from…import 导入模块中的成员。基本语法格式如下:
from 模块名 import 成员1,成员2,…
如果希望导入一个模块中的所有成员,则可以采用如下方式:
from 模块名 import *
【注】尽量避免“from 模块名import *
”这种写法。*
它表示导入模块中所有的不是以下划线(_)开头的名字都导入到当前位置。但你不知道你导入什么名字,很有可能会覆盖掉你之前已经定义的名字。而且可读性极其的差。一般生产环境中尽量避免使用,学习时没有关系。
【示例】使用from…import 导入模块指定的成员
from math import pi,sin
print(sin(pi/2)) #输出1.0
2.3 import 语句和from…import 语句的区别
import 导入的是模块。from…import 导入的是模块中的一个函数/一个类。
如果进行类比的话,import 导入的是“文件”,我们要使用该“文件”下的内容,必须前面加“文件名称”。from…import 导入的是文件下的“内容”,我们直接使用这些“内容”即可,前面再也不需要加“文件名称”了。
我们自定义一个模块calculator.py:
"""一个实现四则运算的计算器"""
def add(a,b):
return a+b
def minus(a,b):
return a-b
class MyNum():
def print123(self):
print(123)
我们在另一个模块test.py 测试:
import calculator
a = calculator.add(30,40)
# add(100,200) #不加模块名无法识别
print(a)
from calculator import *
a = add(100,200) #无需模块名,可以直接引用里面的函数/类
print(a)
b = MyNum()
b.print123()
2.4 __import__()
动态导入
import 语句本质上就是调用内置函数__import__()
,我们可以通过它实现动态导入。给
__import__()
动态传递不同的的参数值,就能导入不同的模块。
【示例】使用__import__()动态导入指定的模块
s = "math"
m = __import__(s) #导入后生成的模块对象的引用给变量m
m.pi
3.141592653589793
m.sin(3)
0.1411200080598672
注意:一般不建议我们自行使用__import__()导入,其行为在python2 和python3 中有差异,会导致意外错误。如果需要动态导入可以使用importlib 模块。
s = "math"
import importlib
a = importlib.import_module(s)
a.pi
3.141592653589793
2.5 模块的加载问题
当导入一个模块时, 模块中的代码都会被执行。不过,如果再次导入这个模块,则不会再次执行。
Python 的设计者为什么这么设计?因为,导入模块更多的时候需要的是定义模块中的变量、函数、对象等。这些并不需要反复定义和执行。“ 只导入一次import-only-once”就成了一种优化。
一个模块无论导入多少次,这个模块在整个解释器进程内有且仅有一个实例对象。
test02.py 的源代码:
print("test02 模块被加载了...")
test03.py 的源代码:
import test02 #会执行test02 模块中的语句
import test02 #不会再执行test02 模块中的语句,只导入一次
运行结果:
test02 模块被加载了...
重新加载
有时候我们确实需要重新加载一个模块,这时候可以使用:importlib.reload()方法:
import test02
import test02
print("####")
import importlib
importlib.reload(test02)
运行结果
test02 模块被加载了...
####
test02 模块被加载了...
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。方式如下:
- import a.aa.module_AA
在使用时,必须加完整名称来引用,比如:a.aa.module_AA.fun_AA() - from a.aa import module_AA
在使用时,直接可以使用模块名。比如:module_AA.fun_AA() - from a.aa.module_AA import fun_AA 直接导入函数
在使用时,直接可以使用函数名。比如:fun_AA()
【操作】
module_B1.py
import state02.a.aa.module_AA
state02.a.aa.module_AA.fun_AA()
或者用第二种方式
from state02.a.aa.module_AA import fun_AA
fun_AA()
module_AA.py
print("AA")
def fun_AA():
print("in fun_AA")
运行结果
AA
in fun_AA
【注】
- from package import item 这种语法中,item 可以是包、模块,也可以是函数、
类、变量。 - import item1.item2 这种语法中,item 必须是包或模块,不能是其他。
导入包的本质其实是“导入了包的__init__.py”文件。也就是说,”import pack1”意味
着执行了包pack1 下面的__init__.py 文件。这样,可以在__init__.py 中批量导入我们需要
的模块,而不再需要一个个导入。
__init__.py
的三个核心作用:
- 作为包的标识,不能删除。
- 用来实现模糊导入
- 导入包实质是执行__init__.py 文件,可以在__init__.py 文件中做这个包的初始化、以及需要统一执行代码、批量导入。
【示例】测试包的__init__.py 文件本质用法
a 包下的__init__.py 文件内容:
import turtle
import math
print("导入a 包")
b 包下的module_B1.py 文件中导入a 包,代码如下:
import state02.a
import math
print(state02.a.math.pi)
print(id(math))
print(id(state02.a.math))
导入a包
3.141592653589793
1340625954752
1340625954752
【注】如上测试我们可以看出python 的设计者非常巧妙的通过__init__.py 文件将包转成了模块的操作。因此,可以说“包的本质还是模块”。
3.4 用*导入包
import *
这样的语句理论上是希望文件系统找出包中所有的子模块,然后导入它们。这可能会花长时间等。Python 解决方案是提供一个明确的包索引。
这个索引由__init__.py 定义__all__ 变量,该变量为一列表,如上例a 包下的__init__.py 中,可定义__all__ = ["module_A","module_A2"]
这意味着, from state02.a import *
会从对应的包中导入以上两个子模块;
【操作】
module_B1.py
from state02.a import *
module_A.fun_A()
module_A.py
def fun_A():
print("in fun_A")
运行结果
导入a包
in fun_A
【注】尽管提供import * 的方法,仍不建议在生产代码中使用这种写法。
3.5 包内引用
如果是子包内的引用,可以按相对位置引入子模块以aa 包下的module_AA 中导入a包下内容为例:
from .. import module_A #..表示上级目录.表示同级目录
from . import module_A2 #.表示同级目录
3.6 sys.path 和模块搜索路径
当我们导入某个模块文件时, Python 解释器去哪里找这个文件呢?只有找到这个文件才能读取、装载运行该模块文件。它一般按照如下路径寻找模块文件(按照顺序寻找,找到即停不继续往下寻找):
- 内置模块
- 当前目录
- 程序的主目录
- pythonpath 目录(如果已经设置了pythonpath 环境变量)
- 标准链接库目录
- 第三方库目录(site-packages 目录)
- .pth 文件的内容(如果存在的话)
- sys.path.append()临时添加的目录
当任何一个python 程序启动时,就将上面这些搜索路径(除内置模块以外的路径)进行收集,
放到sys 模块的path 属性中(sys.path)。
使用sys.path 查看和临时修改搜索路径
我们在项目的b 目录下建立测试模块:
import sys
sys.path.append("d:/")
print(sys.path)
执行结果:
['C:\\Users\\dell\\PycharmProjects\\mystudypy400\\state02\\b', 'C:\\Users\\dell\\PycharmProjects\\mystudypy400', 'C:\\Program Files\\JetBrains\\PyCharm 2020.1\\plugins\\python\\helpers\\pycharm_display', 'C:\\Program Files\\Python38\\python38.zip', 'C:\\Program Files\\Python38\\DLLs', 'C:\\Program Files\\Python38\\lib', 'C:\\Program Files\\Python38', 'C:\\Program Files\\Python38\\lib\\site-packages', 'c:\\DEll', 'C:\\Program Files\\JetBrains\\PyCharm 2020.1\\plugins\\python\\helpers\\pycharm_matplotlib_backend', 'c:/']
pythonpath 环境变量的设置
添加和设置 pythonpath 环境变量。
.pth 文件的写法
我们可以在site-packages 目录下添加.pth 文件。并在文件中增加内容:
#一行一个目录
c:\DEll
【注】
- 需确保g:\a,g:\b,g:\c 对应的目录真实存在。
- 在windows 系统中建立.pth 文件,由于没有文件名不能直接建立。需要输入:“.pth.”才能正常建立.pth 文件。
4. 模块发布和安装
4.1 模块的本地发布
当我们完成了某个模块开发后,可以将他对外发布,其他开发者也可以以“第三方扩展
库”的方式使用我们的模块。我们按照如下步骤即可实现模块的发布:
-
为模块文件创建如下结构的文件夹(一般,文件夹的名字和模块的名字一样):
-
在文件夹中创建一个名为『setup.py』的文件,内容如下:
from distutils.core import setup
setup(
name='baizhanMath2', # 对外我们模块的名字
version='1.0', # 版本号
description='这是第一个对外发布的模块,测试哦', #描述
author='gaoqi', # 作者
author_email='gaoqi110@163.com',
py_modules=['baizhanMath2.demo1','baizhanMath2.demo2'] # 要发布的模块
)
- 构建一个发布文件。通过终端,cd 到模块文件夹c 下面,再键入命令:
python setup.py sdist
执行完毕后,目录结构变为:
4.2 本地安装模块
将发布安装到你的本地计算机上。仍在cmd 命令行模式下操作,进setup.py 所在目
录,键入命令:
python setup.py install
安装成功后,我们进入python 目录/Lib/site-packages 目录(第三方模块都安装的这
里,python 解释器执行时也会搜索这个路径):
安装成功后,直接使用import 导入即可。
import baizhanSuperMath.demo1
baizhanSuperMath.demo1.add()
运行结果
add
4.3 上传模块到PyPI
将自己开发好的模块上传到PyPI 网站上,将成为公开的资源,可以让全球用户自由使
用。按照如下步骤做,很容易就实现上传模块操作。
注册PyPI 网站
注册PyPI 网站:http://pypi.python.org
【注意】会发送一封邮件到你的邮箱。请点击验证后继续下面的步骤。
创建用户信息文件.pypirc
方式1: 使用命令(适用Linux)
输入并执行后 python setup.py register ,然后输入用户名和密码,即可。
方式2:使用文件(适用windows,Linux)
在用户的家目录里创建一个文件名为.pypirc, 内容为:
[distutils]
index-servers=pypi
[pypi]
repository = https://upload.pypi.org/legacy/
username = 账户名
password = 你自己的密码
【注】
Linux 的家目录: ~/.pypirc
Windows 的家目录是: c:/user/用户名
在windows 下直接创建不包含文件名的文件会失败,因此创建时文件名为“.pypirc.”,前后都有两个点即可。
上传并远程发布
进入setup.py 文件所在目录,使用命令“python setup.py sdist upload
”,即可以将模块代码上传并发布:
报错
Upload failed (403): The user 'LouHerGetUp' isn't allowed to upload to project 'baizhanSuperMath'. See https://pypi.org/help/#project-name for more
information.
error: Upload failed (403): The user 'LouHerGetUp' isn't allowed to upload to project 'baizhanSuperMath'. See https://pypi.org/help/#project-name f
or more information.
处理办法,修改包名,上传成功
writing manifest file 'MANIFEST'
creating baizhanSuperMath123-1.0
creating baizhanSuperMath123-1.0\baizhanSuperMath123
making hard links in baizhanSuperMath123-1.0...
hard linking setup.py -> baizhanSuperMath123-1.0
hard linking baizhanSuperMath123\__init__.py -> baizhanSuperMath123-1.0\baizhanSuperMath123
hard linking baizhanSuperMath123\demo1.py -> baizhanSuperMath123-1.0\baizhanSuperMath123
hard linking baizhanSuperMath123\demo2.py -> baizhanSuperMath123-1.0\baizhanSuperMath123
Creating tar archive
removing 'baizhanSuperMath123-1.0' (and everything under it)
running upload
Submitting dist\baizhanSuperMath123-1.0.tar.gz to https://upload.pypi.org/legacy/
Server response (200): OK
管理你的模块
我们登录pypi 官网,可以看到:
如果你的模块已经上传成功,那么当你登录PyPI 网站后应该能在右侧导航栏看到管理
入口。
点击包名进去后你可以对你的模块进行管理,当然你也可以从这里删除这个模块。
4.4 让别人使用你的模块
模块发布完成后,其他人只需要使用pip 就可以安装你的模块文件。比如:
pip install package-name
如果你更新了模块,别人可以可以通过–update 参数来更新:
pip install package-name update
5. 库(Library)
Python 中库是借用其他编程语言的概念,没有特别具体的定义。模块和包侧重于代码
组织,有明确的定义。
一般情况,库强调的是功能性,而不是代码组织。我们通常将某个功能的“模块的集合”,
称为库。
5.1 标准库(Standard Library)
Python 拥有一个强大的标准库。Python 语言的核心只包含数字、字符串、列表、字典、
文件等常见类型和函数,而由Python 标准库提供了系统管理、网络通信、文本处理、数据
库接口、图形系统、XML 处理等额外的功能。
Python 标准库的主要功能有:
- 文本处理,包含文本格式化、正则表达式匹配、文本差异计算与合并、Unicode 支
持,二进制数据处理等功能 - 文件处理,包含文件操作、创建临时文件、文件压缩与归档、操作配置文件等功能
尚学堂·百战程序员www.itbaizhan.cn - 操作系统功能,包含线程与进程支持、IO 复用、日期与时间处理、调用系统函数、
日志(logging)等功能 - 网络通信,包含网络套接字,SSL 加密通信、异步网络通信等功能
- 网络协议,支持HTTP,FTP,SMTP,POP,IMAP,NNTP,XMLRPC 等多种网
络协议,并提供了编写网络服务器的框架 - W3C 格式支持,包含HTML,SGML,XML 的处理
- 其它功能,包括国际化支持、数学运算、HASH、Tkinter 等
目前学过的有:random、math、time、file、os、sys 等模块。可以通过random 模
块实现随机数处理、math 模块实现数学相关的运算、time 模块实现时间的处理、file 模块
实现对文件的操作、OS 模块实现和操作系统的交互、sys 模块实现和解释器的交互。
5.2 第三方扩展库的介绍
强大的标准库奠定了python 发展的基石,丰富和不断扩展的第三方库是python 壮大
的保证。我们可以进入PyPI 官网:
https://pypi.org
我们可以看到发布的第三方库达到了十多万种,众多的开发者为Python 贡献了自己的力
量。
5.3 PyPI 网站和PIP 模块管理工具
PyPI(Python Package Index)是python 官方的第三方库的仓库,所有人都可以下载第三
方库或上传自己开发的库到PyPI。PyPI 推荐使用pip 包管理器来下载第三方库。
pip 是一个现代的,通用的Python 包管理工具。提供了对Python 包的查找、下载、安
装、卸载的功能。pip 可正常工作在Windows、Mac OS、Unix/Linux 等操作系统上,但
是需要至少2.6+和3.2+的CPython 或PyPy 的支持。python 2.7.9 和3.4 以后的版本已
经内置累pip 程序,所以不需要安装。
5.4 安装第三方扩展库的2 种方式
第三方库有数十万种之多,以pillow 库为例讲解第三方扩展库的安装。pillow 是
Python 平台事实上的图像处理标准库,本节以安装pillow 为例,给大家介绍第三方库的两
种常用的安装方法。
第一种方式:命令行下远程安装
以安装第三方pillow 图像库为例,在命令行提示符下输入:pip install pillow
安装完成后,我们就可以开始使用。
安装完,输入pip show pillow, 进行确认:
第二种方式:Pycharm 中直接安装到项目中
在Pycharm 中,依次点击:file–>setting–>Project 本项目名–>Project Interpreter
点击“+”,然后输入要安装的第三方库“pillow”,再点击按钮“Install Package”,等待
安装即可,几秒种后,即提示安装成功:
这样,我们就可以在项目中直接使用第三方库pillow 了。