Python 中如何优雅的使用 assert 断言

什么是 assert 断言

Assert statements are a convenient way to insert debugging assertions into a program

断言声明是用于程序调试的一个便捷方式。断言可以看做是一个 debug 工具，Python 的实现也符合这个设计哲学，在 Python 中 assert 语句的执行是依赖于__debug__这个内置变量的，其默认值为True。当__debug__为True时，assert 语句才会被执行。

对于一般的声明，assert expression 等价于

if __debug__:    if not expression: raise AssertionError

assert 可以同时声明两个 expression，例如 assert expression1, expression2 等价于

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

如果执行脚本文件时加上-O参数， __debug__则为False

举一个例子，假设我们有一个脚本 testAssert.py，内容为：

print(__debug__)assert 1 > 2

当使用python assert.py运行时，__debug__会输出 True，assert 1 > 2 语句会抛出 AssertionError 异常。

当使用python -O assert.py运行时，__debug__会输出 False，assert 1 > 2 语句由于没有执行不会报任何异常。

断言和异常的使用场景

先说结论：

检查先验条件使用断言，检查后验条件使用异常

举个例子来说明一下，在开发中我们经常会遇到读取本地文件的场景。我们定义一个 read_file 方法。

def read_file(path):    assert isinstance(file_path, str)    ...

read_file 函数要求在开始执行的时候满足一定条件：file_path 必须是 str 类型，这个条件就是先验条件，如果不满足，就不能调用这个函数，如果真的出现了不满足条件的情况，证明代码中出现了 bug，这时候我们就可以使用 assert 语句来对 file_path 的类型进行推断，提醒程序员修改代码，也可以使用 if...raise...语句来实现 assert，但是要繁琐很多。在很多优秀的 Python 项目中都会看到使用 assert 进行先验判断的情况，平时可以多多留意。

read_file 函数在被调用执行后，依然需要满足一定条件，比如 file_path 所指定的文件需要是存在的，并且当前用户有权限读取该文件，这些条件称为后验条件，对于后验条件的检查，我们需要使用异常来处理。

def read_file(file_path):    assert isinstance(file_path, str)    if not check_exist(file_path):        raise FileNotFoundError()    if not has_privilege(file_path):        raise PermissionError()

文件不存在和没有权限，这两种情况并不属于代码 bug，是代码逻辑的一部分，上层代码捕获异常后可能会执行其他逻辑，因此我们不能接受这部分代码在生产环境中被忽略，这属于后验条件。并且，相比于 assert 语句只能抛出 AssertionError，使用异常可以抛出更详细的错误，方便上层代码针对不同错误执行不同的逻辑。