python核心技术与实战（十五）：合理利用assert

15.1 什么是assert

assert语句是一个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 expression1，expression2

稍微复杂一点的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

若输入不符合条件，则会报以下错误：

AssertionError：updata_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处理更合适。