如何合理利用assert?

相信你平时在写代码时,肯定或多或少看到过 assert 的存在。我也曾在日常的代码开发中,被一些同事要求增加 assert 语句,让代码更加健壮。

不过,尽管如此,我发现在很多情况下,assert 还是很容易被忽略,人们似乎对这么一个“不起眼”的东西并不关心。但事实上,这个看似“不起眼”的东西,如果能用好,对我们的程序大有裨益。

说了这么多,那么究竟什么是 assert,我们又该如何合理地使用 assert 呢?今天这节课,我就带你一起来学习它的用法。

什么是 assert?

Python 的 assert 语句,可以说是一个 debug 的好工具,主要用于测试一个条件是否满足。如果测试的条件满足,则什么也不做,相当于执行了 pass 语句;如果测试条件不满足,便会抛出异常 AssertionError,并返回具体的错误信息(optional)。

它的具体语法是下面这样的:

assert_stmt ::=  "assert" expression ["," expression]

我们先来看一个简单形式的assert expression,比如下面这个例子:

assert 1 == 2

它就相当于下面这两行代码:

if __debug__:
    if not expression: raise AssertionError

再来看assert expression1, expression2的形式,比如下面这个例子:

assert 1 == 2,  'assertion is wrong'

它就相当于下面这两行代码:

if __debug__:
    if not expression1: raise AssertionError(expression2)

这里的__debug__是一个常数。

如果 Python 程序执行时附带了-O这个选项,比如Python test.py -O,那么程序中所有的 assert 语句都会失效,常数__debug__便为 False;反之__debug__则为 True。

不过,需要注意的是,直接对常数__debug__赋值是非法的,因为它的值在解释器开始运行时就已经决定了,中途无法改变。

此外,一定记住,不要在使用 assert 时加入括号,比如下面这个例子:

assert(1 == 2, 'This should fail')
# 输出
<ipython-input-8-2c057bd7fe24>:1: SyntaxWarning: assertion is always true, perhaps remove parentheses?
  assert(1 == 2, 'This should fail')

如果你按照这样来写,无论表达式对与错(比如这里的 1 == 2 显然是错误的),assert 检查永远不会 fail,程序只会给你 SyntaxWarning。

正确的写法,应该是下面这种不带括号的写法:

assert 1 == 2, 'This should fail'
# 输出
AssertionError: This should fail

总的来说,assert 在程序中的作用,是对代码做一些 internal 的 self-check。使用 assert,就表示你很确定。这个条件一定会发生或者一定不会发生。

举个例子,比如你有一个函数,其中一个参数是人的性别,因为性别只有男女之分(这里只指生理性别),你便可以使用 assert,以防止程序的非法输入。如果你的程序没有 bug,那么 assert 永远不会抛出异常;而它一旦抛出了异常,你就知道程序存在问题了,并且可以根据错误信息,很容易定位出错误的源头。

assert 的用法

讲完了 assert 的基本语法与概念,我们接下来通过一些实际应用的例子,来看看 assert 在 Python 中的用法,并弄清楚 assert 的使用场景。

第一个例子,假设你现在使用的北京图灵学院App正在做专栏促销活动,准备对一些专栏进行打折,所以后台需要写一个 apply_discount() 函数,要求输入为原来的价格和折扣,输出是折后的价格。那么,我们可以大致写成下面这样:

def apply_discount(price, discount):
    updated_price = price * (1 - discount)
    assert 0 <= updated_price <= price, 'price should be greater or equal to 0 and less or equal to original price'
    return updated_price

可以看到,在计算新价格的后面,我们还写了一个 assert 语句,用来检查折后价格,这个值必须大于等于 0、小于等于原来的价格,否则就抛出异常。

我们可以试着输入几组数,来验证一下这个功能:

apply_discount(100, 0.2)
80.0

apply_discount(100, 2)
AssertionError: price should be greater or equal to 0 and less or equal to original price

显然,当 discount 是 0.2 时,输出 80,没有问题。

但是当 discount 为 2 时,程序便抛出下面这个异常:

AssertionError:price should be greater or equal to 0 and less or equal to original price

这样一来,如果开发人员修改相关的代码,或者是加入新的功能,导致 discount 数值的异常时,我们运行测试时就可以很容易发现问题。正如我开头所说,assert 的加入,可以有效预防 bug 的发生,提高程序的健壮性。

再来看一个例子,最常见的除法操作,这在任何领域的计算中都经常会遇到。同样还是以北京图灵学院App为例,假如北京图灵学院App后台想知道每个专栏的平均销售价格,那么就需要给定销售总额和销售数目,这样平均销售价格便很容易计算出来:

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,这样就可以防止后台计算那些还未开卖的专栏的价格。

除了这两个例子,在实际工作中,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:
        ... 

这里函数 func() 里的所有操作,都是基于输入必须是 list 这个前提。是不是很熟悉的需求呢?那我们就很有必要在开头加一句 assert 的检查,防止程序出错。

当然,我们也要根据具体情况具体分析。比如上面这个例子,之所以能加 assert,是因为我们很确定输入必须是 list,不能是其他数据类型。

如果你的程序中,允许 input 是其他数据类型,并且对不同的数据类型都有不同的处理方式,那你就应该写成 if else 的条件语句了:

def func(input):
    if isinstance(input, list):
        ...
    else:
        ...

assert 错误示例

前面我们讲了这么多 assert 的使用场景,可能给你一种错觉,也可能会让你有些迷茫:很多地方都可以使用 assert, 那么,很多 if 条件语句是不是都可以换成 assert 呢?这么想可就不准确了,接下来,我们就一起来看几个典型的错误用法,避免一些想当然的用法。

还是以北京图灵学院App为例,我们假设下面这样的场景:后台有时候需要删除一些上线时间较长的专栏,于是,相关的开发人员便设计出了下面这个专栏删除函数。

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)

北京图灵学院App规定,必须是 admin 才能删除专栏,并且这个专栏课程必须存在。有的同学一看,很熟悉的需求啊,所以在前面加了相应的 assert 检查。那么我想让你思考一下,这样写到底对不对呢?

答案显然是否定的。你可能觉得,从代码功能角度来说,这没错啊。但是在实际工程中,基本上没人会这么写。为什么呢?

要注意,前面我说过,assert 的检查是可以被关闭的,比如在运行 Python 程序时,加入-O这个选项就会让 assert 失效。因此,一旦 assert 的检查被关闭,user_is_admin() 和 course_exist() 这两个函数便不会被执行。这就会导致:

  • 任何用户都有权限删除专栏课程;
  • 并且,不管这个课程是否存在,他们都可以强行执行删除操作。

这显然会给程序带来巨大的安全漏洞。所以,正确的做法,是使用条件语句进行相应的检查,并合理抛出异常:

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)  

再来看一个例子,如果你想打开一个文件,进行数据读取、处理等一系列操作,那么下面这样的写法,显然也是不正确的:

def read_and_process(path):
    assert file_exist(path), 'file must exist'
    with open(path) as f:
      ...

因为 assert 的使用,表明你强行指定了文件必须存在,但事实上在很多情况下,这个假设并不成立。另外,打开文件操作,也有可能触发其他的异常。所以,正确的做法是进行异常处理,用 try 和 except 来解决:

def read_and_process(path):
    try:
        with open(path) as f:
            ...
    except Exception as e:
            ...  

总的来说,assert 并不适用 run-time error 的检查。比如你试图打开一个文件,但文件不存在;再或者是你试图从网上下载一个东西,但中途断网了了等等,这些情况下,还是应该参照我们前面所讲的错误与异常的内容,进行正确处理。

总结

今天这节课,我们一起学习了 assert 的用法。assert 通常用来对代码进行必要的 self check,表明你很确定这种情况一定发生,或者一定不会发生。需要注意的是,使用 assert 时,一定不要加上括号,否则无论表达式对与错,assert 检查永远不会 fail。另外,程序中的 assert 语句,可以通过-O等选项被全局 disable。

通过这节课的几个使用场景,你能看到,assert 的合理使用,可以增加代码的健壮度,同时也方便了程序出错时开发人员的定位排查。

不过,我们也不能滥用 assert。很多情况下,程序中出现的不同情况都是意料之中的,需要我们用不同的方案去处理,这时候用条件语句进行判断更为合适。而对于程序中的一些 run-time error,请记得使用异常处理。