Python学习笔记__8.4章 文档测试

a2005147

　　# 这是学习廖雪峰老师python教程的学习笔记
　　1、概览
　　在文档中编写规范的注释代码。则Python内置的“文档测试”（doctest）模块可以直接提取注释中的代码并执行测试。
　　1.1、以abs()函数为例：
　　#abs.py
　　def abs(n):
　　''' # 两个为一对，换行输入
　　Function to get absolute value of number.  # 简单的介绍
　　Example:
　　>>> abs(1)   # 测试
　　1
　　>>> abs(-1)
　　1
　　>>> abs(0)
　　0
　　'''  #
　　return n if n >= 0 else (-n)  # 函数体
　　$ python abs.py  # 命令行执行程序，无返回值，则代码无误
　　1.2、doctest来测试上次编写的Dict类
　　# mydict2.py
　　class Dict(dict):
　　'''
　　Simple dict but also support access as x.y style.
　　>>> d1 = Dict()
　　>>> d1['x'] = 100
　　>>> d1.x
　　100
　　>>> d1.y = 200
　　>>> d1['y']
　　200
　　>>> d2 = Dict(a=1, b=2, c='3')
　　>>> d2.c
　　'3'
　　>>> d2['empty']
　　Traceback (most recent call last):
　　...  # 这三个.表示一大段输出
　　KeyError: 'empty'
　　>>> d2.empty
　　Traceback (most recent call last):
　　...
　　AttributeError: 'Dict' object has no attribute 'empty'
　　'''
　　def __init__(self, **kw):
　　super(Dict, self).__init__(**kw)
　　def __getattr__(self, key):
　　try:
　　return self[key]
　　except KeyError:
　　raise AttributeError(r"'Dict' object has no attribute '%s'" % key)
　　def __setattr__(self, key, value):
　　self[key] = value
　　if __name__=='__main__':
　　import doctest
　　doctest.testmod()
　　总结：
　　doctest非常有用，不但可以用来测试，还可以直接作为示例代码。通过某些文档生成工具，就可以自动把包含doctest的注释提取出来。用户看文档的时候，同时也看到了doctest。