[toc]
1.4 模块化编程的流程
模块化编程的一般流程:
1. 设计 API, 进行功能描述
2. 编码实现 API 中描述的功能
3. 在模块中编写测试代码, 并消除全局代码
4. 使用私有函数实现不被外部客户端调用的模块函数
1.5 模块的 API 和功能描述要点
API ( Application Programming Interface 应用程序编程接口 ) 是用于描述模块中提供的函数和类的功能描述和使用方式描述.
模块化编程中, 首先设计的就是模块的 API ( 即要实现的功能描述 ), 然后开始编码实现 API 中描述的功能. 最后, 在其他模块中导入本模块进行调用.
我们可以通过 help ( 模块名 ) 查看模块的 API. 一般使用时先导入模块, 憨厚通过 help 函数查看.
也可以在 Python 的 API 文档中查询. 首先进入 Python 的安装目录下的 docs 子目录:
如上模块只有功能描述和规范, 需要编码人员按照要求实现编码.
我们可以通过__doc__获得模块的文档字符串的内容.
执行结果:
1.6 模块的创建和测试代码
每个模块都有一个名称, 通过特殊变量__name__可以获取模块的名称. 正常情况下, 模块名字对应源文件名. 仅有一个例外, 就是当一个模块被作为程序入口时 ( 主程序, 交互式提示符下 ), 它的__name__的值为 "__main__". 我们可以根据这个特点, 将模块源代码文件中的测试代码进行独立的处理. 例如:
执行结果:
执行结果: 请自行尝试哦 !
