Python编程从入门到实战-轻松过二级 （思政版）(第2版) 课件 Ch10 模块和模块化程序设计

第二版本章要点：模块化程序设计的概念模块的设计和实现包名称空间与名称查找顺序应用举例：基于模块的库存管理系统第10章模块和模块化程序设计10.1模块化程序设计的概念如果程序中包含多个可以复用的函数或类，则通常把相关的函数和类分组包含在单独的模块（module）中。这些提供计算功能的模块称之为模块（或函数模块），导入并使用这些模块的程序，则称之为客户端程序把计算任务分离成不同模块的程序设计方法，称之为模块化编程（modularprogramming）。使用模块，可以将计算任务分解为大小合理的子任务，并实现代码的重用功能模块的API（1）API用于描述模块中提供的函数的功能和调用方法客户端使用模块提供的函数时，无须了解其实现细节模块和客户端之间遵循的契约称之为API（ApplicationProgrammingInterface，应用程序编程接口）10.2模块的设计和实现模块的API（2）模块化程序设计的基本原则是先设计API（即模块提供的函数或类的功能描述），然后实现API（即编写程序，实现模块函数或类），最后在客户端中导入并使用这些函数或类通过内置函数help()，可以查看Python模块的API【例10.1】通过内置函数help()查看math模块的API>>>importmath>>>help(math)【例10.2】通过Python在线帮助查看math模块的API（1）运行Python内置集成开发环境IDLE（2）打开PythonDocs。执行IDLE菜单命令Help|PythonDocs，打开Python帮助文档（3）定位到math模块，查看其API模块的实现“实现”是指实现用于重用的函数或类的代码，模块的实现就是若干实现函数或类的代码的集合，保存在一个后缀为.py的文件中模块的实现必须遵循API规约，可以采用不同算法实现API，这为模块的改进和版本升级提供了无缝对接，只需要使用遵循API的新的实现，所有客户端程序无须修改即可以正常运行模块的客户端客户端遵循API提供的调用接口，导入和调用模块中实现的函数功能API允许任何客户端直接使用模块，而无需检测模块中定义的代码，例如可以直接使用模块math和random模块的客户端模块的客户端【例10.3】模块的客户端示例模块的客户端在[0,

]区间，均匀输出函数y=sin(x)+sin(5x)所对应的(n+1)个函数值。其中，n由命令行第一个参数所确定importmathimportsysn=int(sys.argv[1])foriinrange(n+1):x=math.pi*i/ny=math.sin(x)+math.sin(5*x)print(x,y)模块化程序设计的优越性可以编写大规模的系统程序控制程序的复杂度实现代码重用增强可维护性模块设计的一般原则模块的客户端（1）先设计API，再实现模块（2）控制模块的规模，只为客户端提供需要的函数。实现包含大量函数的模块会导致模块的复杂性。例如，Python的math模块中就不包含正割函数、余割函数和余切函数，因为这些函数很容易通过函数math.sin()、math.cos()和math.tan()的计算而得（3）在模块中编写测试代码，并消除全局代码（4）使用私有函数实现不被外部客户端调用的模块函数（5）通过文档提供模块帮助信息API设计模块的客户端API定义客户端和实现之间的契约。API是一个明确的规范，规定“实现”的具体功能是什么API通常由两部分组成：可用函数的签名的精确规范，以及描述函数作用的非正式自然语言描述。API一般使用表格的形式，描述模块中的变量、函数和类当编写一个新模块时，建议先设计API，然后实现模块【例10.4】设计实现算术四则运算的模块（my_math1.py）的API创建模块模块的客户端Python模块对应于包含Python代码的源文件（其扩展名为.py），在文件中可以定义变量、函数和类在模块中，除了可以定义变量、函数和类之外，还可以包含一般的语句，称之为主块（全局语句）。当运行该模块，或导入该模块时，主块语句将依次执行模块的客户端【例10.5】创建模块my_math1.pyPI=3.14#定义常量defadd(x,y):#定义函数

returnx+y#加defsub(x,y):#定义函数

returnx-y#减defmul(x,y):#定义函数

returnx*y#乘defdiv(x,y):#定义函数

returnx/y#除在模块中定义了算术四则运算模块的私有函数模块的客户端实现模块时，有时候需要在模块中定义仅在模块中使用的辅助函数。辅助函数不提供给客户端直接调用，故称之为私有函数按惯例，Python程序员使用下划线开始的函数名作为私有函数。私有函数客户端不应该直接调用，故API中不包括私有函数Python语言没有强制不允许调用私有函数的机制，程序员应该避免直接调用私有函数模块的客户端【例10.6】创建模块normal.py，实现正态分布的概率密度函数PDFimportmathdef_phi(x):returnmath.exp(-x*x/2.0)/math.sqrt(2*math.pi)defpdf(x,mu=0.0,sigma=1.0):return_phi(float((x-mu)/sigma))/sigma#测试代码if__name__=='__main__':#如果独立运行时，则运行测试代码

foriinrange(0,101):print(i,pdf(i,mu=78,sigma=10))模块的测试代码模块的客户端每个模块都有一个名称，通过特殊变量__name__可以获取模块的名称特别地，当一个模块被用户单独运行时，其__name__的值为'__main__'。故可以把模块源代码文件的测试代码写在相应的测试判断中，以保证只有单独运行时，才会运行测试代码模块的客户端【例10.7】创建模块my_math2.pyPI=3.14#定义常量defadd(x,y):#定义函数

returnx+y#加defsub(x,y):#定义函数

returnx-y#减defmul(x,y):#定义函数

returnx*y#乘defdiv(x,y):#定义函数

returnx/y#除#测试代码defmain():print('123+456=',add(123,456))#加

print('123-456=',sub(123,456))#减

print('123*456=',mul(123,456))#乘

print('123/456=',div(123,456))#除if__name__=='__main__':#如果独立运行时，则运行测试代码

main()测试代码只有独立运行时才执行编写模块文档字符串模块的客户端在函数的第一个逻辑行的字符串称为函数的文档字符串。函数的文档字符串用于提供有关函数的帮助信息文档字符串一般遵循下列惯例：文档字符串是一个多行字符串；首行以大写字母开始，句号结尾；第二行是空行；从第三行开始是详细的描述可以使用三种方法抽取函数的文档字符串帮助信息：①使用内置函数：help(函数名)；②使用函数的特殊属性：函数名.__doc__；③第三方自动化工具也可以抽取文档字符串信息，以形成帮助文档模块的客户端【例10.8】查看文档字符串示例帮助信息>>>help(abs)Helponbuilt-infunctionabsinmodulebuiltins:abs(x,/)Returntheabsolutevalueoftheargument.>>>print(abs.__doc__)#输出：Returntheabsolutevalueoftheargument.模块的客户端【例10.9】文档字符串示例"""doc模块说明文档"""#模块注释defd2b(i):#定义函数d2b()"""函数d2b()的说明文档"""print(bin(i))classDoc:#定义类Doc"""类Doc的说明文档"""defsayHello(self):#定义类Doc的方法sayHello()"""方法sayHello()的说明文档"""print('hi')按字节编译的.pyc文件模块的客户端.pyc文件是经过编译后的字节码，这样下次导入时，如果模块源代码.py文件没有修改（通过比较两者的时间戳），则直接导入.pyc文件，从而提高程序效率按字节编译的.pyc文件是在导入模块时，python解释器自动完成，无需程序员手动编译10.3包（1）功能相似的模块使用包组成层次组织结构【例10.10】包示例包（2）创建包在指定目录中创建对应包名的目录在该目录下创建一个特殊文件：__init__.py文件最后在该目录下创建模块文件【例10.11】创建包示例。在C:\pythonpa\ch10\目录中，创建如下目录结构：包（3）包的导入和使用import[包名1.[包名2.…]].模块名#导入包中模块[包名1.[包名2.…]].模块名.函数名#使用全限定名称调用模块中的成员from[包名1.[包名2.…]].模块名import成员名#导入模块中的具体成员from包名import*【例10.12】包的导入和使用>>>fromxml.domimportminidom>>>doc=minidom.Document()10.4名称空间与名称查找顺序在Python程序中，每一个名称（变量名、函数名或类型名）都有一个作用范围。在其作用范围之内，可以直接引用该名称；在其作用范围之外，该名称不存在，引用该名称将导致一个错误NameError。则这个作用范围称为名称空间，也称为命名空间当代码中使用名称x时，Python解释器把x解释为对象名（对象、函数、变量等），并按如下名称空间顺序查找以x命名的对象：（1）局部名称空间。当前函数或类的方法中定义的局部变量（2）全局名称空间。当前的模块（.py文件）中定义的变量、函数或类（3）内置名称空间。对每个模块都是全局的。作为最后的尝试，Python将假设x是内置函数或变量【例10.13】名称查找示例>>>math.e#报错。NameError:name'math'isnotdefined>>>importmath>>>math.e#输出：2.71828182845904510.5应用举例：基于模块的库存管理系统库存管理系统API设计本节实现一个简单的基于模块的库存管理系统。系统采用JSON文件来保存数据。产品信息设计为字典，键为sku_id（产品ID），值为sku_name（产品名称），使用products.json实现其持续化。货架位置信息也设计为字典，键为loc_id（货架ID），值为loc_name（货架名称），使用location.json实现其持续化。商品库存信息设计为列表[sku_id,loc_id]的列表，使用items.json实现其持续化库存管理系统设计为三个模块文件，即data.py、ui.py和main.py库存管理系统ui.py负责用户界面交互，其API设计如表10-3所示库存管理系统data.py模块的API库存管理系统的功能设计（1）库存信息管理系统主要包括如下功能。（1）产品信息报表调用ui.report_products()，显示产品信息列表。（2）增加产品信息调用mpt_for_new_sku_id()，提示用户输入新的产品ID，调用mpt_for_sku_name()，提示用户输入产品名称。调用data.add_product(sku_id,sku_name)增加新的产品。如果用户输入为空，则返回None，即什么也不做。（3）货架位置报表调用ui.report_location()，显示货架位置信息列表。（4）增加货架位置调用mpt_for_new_loc_id()，提示用户输入新的货架位置ID，调用mpt_for_loc_name()，提示用户输入货架名称。调用data.add_location(sku_id,sku_name)增加新的货架。如果用户输入为空，则返回None，即什么也不做库存管理系统的功能设计（2）（5）商品库存信息报表调用ui.report_items()，显示库存信息列表。（6）商品入库管理调用mpt_for_old_sku_id()，提示用户输入产品ID，调用mpt_for_old_loc_id()，提示用户输入货架ID。调用data.add_item(sku_id,loc_id)，实现商品入库。如果用户输入为空，则返回None，即什么也不做。（7）商品出库管理调用mpt_for_old_sku_id()，提示用户输入产品ID，调用mpt_for_old_loc_id()，提示用户输入货架ID。调用data.remove_item(sku_id,loc_id)，实现商品出库。如果库存不存在，则报错。如果用户输入为空，则返回None，即什么也不做主模块main.py的实现（1）主模块导入data和ui模块。在main.py中，定义main()函数，首先调用data.init()，从磁盘JSON格式文件中读取数据。然后在无限循环中，调用mpt_for_action()显示功能菜单，接受用户输入，并根据用户的功能选择，实现各模块相应功能"""库存管理系统：基于JSON"""importdataimportuidefmain():data.init()whileTrue:action=mpt_for_action()ifaction=='QUIT':breakelifaction=='REPORT_PRODUCTS':ui.report_products()elifaction=='ADD_PRODUCT':sku_id=mpt_for_new_sku_id()ifsku_id!=None:sku_name=mpt_for_sku_name()ifsku_name!=None:data.add_product(sku_id,sku_name)主模块main.py的实现（2）elifaction=='REPORT_LOCATIONS':ui.report_locations()elifaction=='ADD_LOCATION':loc_id=mpt_for_new_loc_id()ifloc_id!=None:loc_name=mpt_for_loc_name()ifloc_name!=None:data.add_location(loc_id,loc_name)elifaction=='REPORT_ITEMS':ui.report_items()elifaction=='ADD_ITEM':sku_id=mpt_for_old_sku_id()ifsku_id!=None:loc_id=mpt_for_old_loc_id()ifloc_id!=None:data.add_item(sku_id,loc_id)elifaction=='REMOVE_ITEM':sku_id=mpt_for_old_sku_id()ifsku_id!=None:loc_id=mpt_for_old_loc_id()ifloc_id!=None:ifnotdata.remove_item(sku_id,loc_id):print('该库存不存在')#######################################################################if__name__=="__main__":main()用户界面交互模块ui.py的实现（1）【例10.15】库存管理系统用户界面交互模块ui.pyimportdatadefprompt_for_action():"""提示功能菜单。返回用户输入选择"""whileTrue:print('---------------库存信息管理系统-------------')print('|1:产品信息报表|')print('|2:增加产品信息|')print('|3:货架位置报表|')print('|4:增加货架位置|')print('|5:商品库存信息报表|')print('|6:商品入库管理|')print('|7:商品出库管理|')print('|0:退出|')print('-------------------------------------------')choice=input('请选择功能菜单(0-7):')ifchoice=='0':return'QUIT'elifchoice=='1':return'REPORT_PRODUCTS'elifchoice=='2':return'ADD_PRODUCT'elifchoice=='3':return'REPORT_LOCATIONS'elifchoice=='4':return'ADD_LOCATION'elifchoice=='5':return'REPORT_ITEMS'elifchoice=='6':return'ADD_ITEM'elifchoice=='7':return'REMOVE_ITEM'defreport_products():"""产品信息报表"""for(k,v)indata.get_products().items():print('{0:8}{1}'.format(k,v))defprompt_for_old_sku_id():"""提示用户输入有效的产品sku_id并返回有效产品ID，或者返回None"""whileTrue:sku_id=input("请输入产品ID:")ifsku_id=="":returnNoneelifsku_idnotindata.get_products():print("该产品不存在,请重新输入")用户界面交互模块ui.py的实现（2）else:returnsku_iddefprompt_for_new_sku_id():"""提示用户输入新的产品sku_id并返回新产品ID，或者返回None"""whileTrue:sku_id=input("请输入新的产品ID:")ifsku_id=="":returnNoneelifsku_idindata.get_products():print("该产品已经存在,请重新输入")else:returnsku_iddefreport_locations():"""货架位置报表"""for(k,v)indata.get_locations().items():print('{0:8}{1}'.format(k,v))defprompt_for_old_loc_id():"""提示用户输入有效的货架位置loc_id并返回有效货架位置ID，或者返回None"""用户界面交互模块ui.py的实现（3）whileTrue:sku_id=input("请输入产品ID:")ifsku_id=="":returnNoneelifsku_idnotindata.get_products():print("该产品不存在,请重新输入")else:returnsku_iddefprompt_for_new_sku_id():"""提示用户输入新的产品sku_id并返回新产品ID，或者返回None"""whileTrue:sku_id=input("请输入新的产品ID:")ifsku_id=="":returnNoneelifsku_idindata.get_products():print("该产品已经存在,请重新输入")else:returnsku_id用户界面交互模块ui.py的实现（4）defreport_locations():"""货架位置报表"""for(k,v)indata.get_locations().items():print('{0:8}{1}'.format(k,v))defprompt_for_old_loc_id():"""提示用户输入有效的货架位置loc_id并返回有效货架位置ID，或者返回None"""whileTrue:loc_id=input("请输入货架位置ID:")ifloc_id=="":returnNoneelifloc_idnotindata.get_locations():print("该货架位置不存在,请重新输入")else:returnloc_iddefprompt_for_new_loc_id():"""提示用户输入新的货架位置loc_id并返回，或者返回None"""用户界面交互模块ui.py的实现（5）whileTrue:loc_id=input("请输新的货架位置ID:")ifloc_id=="":returnNoneelifloc_idindata.get_locations():print('该货架位置已经存在,请重新输入')else:returnloc_iddefprompt_for_sku_name():"""提示用户输入产品名称sku_name并返回产品名称，或者返回None"""whileTrue:sku_name=input("请输入产品名称:")ifsku_name=="":returnNoneelse:returnsku_namedefprompt_for_loc_name():"""提示用户输入货架位置名称loc_name并返回货架位置名称，或者返回None"""用户界面交互模块ui.py的实现（6）whileTrue:loc_name=input("请输入货架位置名称:")ifloc_name=="":returnNoneelse:returnloc_namedefreport_items():"""库存信息报表"""for(k,v)indata.get_items():sku_name=data.get_products()[k]loc_name=data.get_locations()[v]print('{0:8}{1}：{2:8}{3}'.format(k,sku_name,v,loc_name))用户界面交互模块ui.py的实现（7）importosimportjson#全局变量_products={}#保存产品信息的字典：sku_id:sku_name_locations={}#保存货架位置的字典：loc_id:loc_name_items=[]#保存商品库存的列表，元素为元组(sku_id,loc_id)definit():"""从磁盘JSON格式文件中读取数据"""global_products,_locations,_itemsifos.path.exists("products.json"):f=open("products.json","r",encoding='utf-8')_products=json.loads(f.read())f.close()数据处理模块data.py的实现（1）通过Python标准库模块json中的loads()函数和dumps()函数，可以实现从JSON文件读取数据和转储数据到JSON文件的功能。【例10.16】库存管理系统数据处理模块data.pyifos.path.exists("locations.json"):f=open("locations.json","r",encoding='utf-8')_locations=json.loads(f.read())f.close()ifos.path.exists("items.json"):f=open("items.json","r",encoding='utf-8')_items=json.loads(f.read())f.close()def_save_products():"""把产品信息数据_products以JSON格式保存到磁盘文件"""global_productsf=open("products.json","w",encoding='utf-8')f.write(json.dumps(_products,ensure_ascii=False))f.close()def_save_locations():"""把货架位置数据_locations以JSON格式保存到磁盘文件"""global_locationsf=open("locations.json","w",encoding='utf-8')f.write(json