在Python中正确的使用断言-assert

阅读本文大概需要 3 分钟。

最近这两天流感频发，小伙伴们可要注意预防感冒，多锻炼身体。当一个人生病时就会觉得健康是一种莫大的幸福，主要是我中招了，感冒好了之后，我决定继续坚持锻炼身体。今天继续分享Python 的小碎碎 assert。

assert 的中文含义就是断言，assert something 意思就是我断定 something 是对的，如果不对，此处抛出异常，程序终止运行。这里的对或者错，在 Python 中就是 True 或 False。语句

assert 1 == 2

就相当于

if __debug__:
    if not 1 == 2: raise AssertionError

这里的 __debug__ 是一个常数，如果 Python 程序在执行时加了参数 -o ，比如 python test.py -o ，那么 __debug__ 的值就为 False，于是所有的 assert 语句都将失效。反之就会生效。

不过需要注意的是，直接对 __debug__ 赋值是非法的，因为它在解释器开始运行时就已经确定了，中途无法再进行修改。另外要注意的是，assert 后的表达式中不能使用括号，如下面的代码，会报语法错误的警告，但不会抛出异常，后面那行代码是正确的写法。

>>> assert(1==2,'this should fail')
<stdin>:1: SyntaxWarning: assertion is always true, perhaps remove parentheses?
>>> assert 1==2,'this should fail'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AssertionError: this should fail
>>>

到这里你大概已经知道了，assert 可以用来做参数的检查，防止出现 bug，当出现问题时可以根据消息快速定位至问题处，提高 debug 效率。比如下面就是一种非常常见的用法：

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 语句来判断，不也是可以的么，当然可以，只是他们两者的使用场景不太一样。在重要的环节，比如判断用户是否是管理员，那么必须使用 if，因为 assert 是可以通过 -o 参数来关闭的。在一些非重要的环节，比如写代码的初期，程序还不够健壮，使用 assert 来断言，写代码的行数更少，也更优雅。其实，有没有 assert ，都不应该影响程序的正常运行，assert 的作用是可以让我们后期维护代码更加方便。

合理的使用 assert 可以增加代码的健壮度，同时也方便开发人员定位问题。当程序中出现的各种情况都是预料之中的时候，应该使用 if 来处理，当程序中要限定一些条件时，可以方便的使用 assert 简化处理。需要注意的是无论有没有 assert，都不应该影响程序的正常运行，assert 的作用是可以让我们后期维护代码更加方便，另外对于程序在运行时抛出的异常，看情况要进行捕获与否。

（完）