python核心技术与实战(十五):合理利用assert 15. 合理利用assert15.1 什么是assertassert expression1assert expression1expression215.2 assert的用法例1例2例315.3 assert的错误示例例1例215.1 什么是assertassert语句是一个debug的好工具主要用于测试一个条件是否满足满足什么也不做相当于执行了语句pass不满足抛出AssertionError并返回具体的错误信息可选具体的语法为assert_stmt :: assert expression [, expression]assert expression1一个简单形式的assert语句可写为assert 1 2它相当于以下的两行代码if __debug__: __debug__为一个常数它的取值取决于python程序执行时是否附带了-O这个选项 如Python test.py -O则__debug__的值为Fasle那么程序中的所有assert语句都会失效 if not expression: raise AssertionError注不能对常数__debug__赋值它在python解释器开始运行时就已确定中途无法改变assert expression1expression2稍微复杂一点的assert语句 assert expression1,expression2可写为如下语句assert 1 2, assertion is wrong # 注意不加括号它相当于如下语句if __debug__: if not expression1: raise AssertionError(expression2)总的说来asser语句起到的作用就是检查程序的内部是否符合要求。如可用asser来避免非法输入。如果程序没有bug则assert永远不会抛出异常若出现了bug则asser会抛出异常你也能马上找出问题所在。15.2 assert的用法例1用assert确保apply_distcount()函数在输入原价格和折扣后得出的价格的合理性即0 ≤ result ≤ pre_price代码可写为def apply_discount(price, discount): update_price price * (1 - discount) assert 0 update_price price, updata_price should be not greater than price or not less than 0 return update_price若输入不符合条件则会报以下错误AssertionErrorupdata_price should be not greater than price or not less than 0例2若要计算商品的平均销售价格那么就需要销售额和销售商品数量可写为以下代码def calculate_average_price(total_sales, num_sales): assert num_sales 0, number of sales should be greater than 0 return total_sales / num_sales加入assert语句规定销售数量必须大于0这样就可以防止后台计算未销售的商品。例3当对函数的输入有所要求时可用assert语句作为函数的第一行来assert输入是否符合要求。以下的代码中要求函数的输入必须时列表类型def func(input): assert isinstance(input, list), input must be type of list # 下面的操作都是基于前提input 必须是 list if len(input) 1: ... elif len(input) 2: ... else: ...若输入除了列表类型之外也可以是其他类型而且对不同的输入类型都有不同的处理方式则可使用if…else…结构def func(input): if isinstance(input, list): ... else: ...15.3 assert的错误示例要注意的是assert的检查是可以被关闭的如在执行python程序时加入-O这个选项时就会让assert失效。例1删除课程需要满足两个条件删除者有管理权限该课程存在def delete_course(user, course_id): assert user_is_admin(user), user must be admin assert course_exist(course_id), course id must exist delete(course_id)若assert失效则任何人都可以删除课程且不管课程是否存在都会强制执行删除操作这显然会给程序带来巨大的安全漏洞。正确的写应该是采用条件语句进行相应的检查并合理抛出异常def delete_course(user, course_id): if not user_is_admin(user): raise Exception(user must be admin) if not course_exist(course_id): raise Exception(coursde id must exist) delete(course_id)例2若要打开一个文件进行数据读取、处理等操作则下面的写法也是不正确的def read_and_process(path): assert file_exist(path), file must exist with open(path) as f: ...assert在这里的使用表明强行指定了文件必须存在注意assert的使用表明确定了该情况一定存在或一定不存在但大多数时候这种假设并不成立。另外打开文件的操作也有可能触发其他异常。所以正确的做法是进行异常处理用try…except…解决def read_and_process(path): try: with open(path) as f: ... except Exception as e: ...总的来说assert并不适用于run-time error的检查如打开文件但文件不存在下载东西但中途断网等等这些情况应该用try…except处理更合适。