找回密码
立即注册
搜索
发回帖 发新帖

6751

积分

0

好友

838

主题
发表于 昨天 11:17 | 查看: 17| 回复: 0

在编写 Python 程序时,我们常常要判断程序状态是否符合预期。排序后的结果应当有序,数据转换前后的记录数量应当一致,某个计算结果应当符合预期。这些条件一旦不成立,往往意味着代码存在错误。

assert 语句可以把这类预期写进程序,运行到相应位置时自动检查。它主要服务于调试和测试,帮助我们尽早发现问题,但不能替代必须执行的输入验证和业务检查。

一、什么是断言?

1.1 将预期写成检查条件

断言(Assertion)是对程序在某个位置应当满足的条件所做的声明。

例如,写好一个求和函数后,可以用断言检查它的结果:

def add(a, b):
    return a + b

result = add(2, 3)
assert result == 5

这段代码的含义是:按照预期,result 应当等于 5。

条件成立时,程序继续执行。条件不成立时,assert 会引发 AssertionError,提示实际状态与预期不符。

1.2 断言不会修正错误

assert 只负责检查,不会修改数据,也不会自动修复程序。

例如:

result = 4
assert result == 5

这条断言不会把 result 改成 5,只会报告断言失败。

所以,断言的作用是暴露问题。之后仍需根据报错位置、变量值和执行过程去分析原因。

二、基本语法

2.1 只检查条件

assert 的基本形式为:

assert 条件表达式

例如:

total = 10
assert total >= 0

条件为真时,assert 不输出任何内容,程序继续执行:

total = 10
assert total >= 0

print("继续执行")

输出:

继续执行

条件为假时,则引发 AssertionError:

total = -1
assert total >= 0

print("继续执行")

如果这个异常未被捕获,当前脚本会因异常而终止,最后一条 print 不会执行。

2.2 添加错误说明

为了便于定位问题,可以在条件后面加上错误说明:

assert 条件表达式, 错误说明

例如:

total = -1
assert total >= 0, "计算得到的总数不应为负数"

异常信息的最后一行为:

AssertionError: 计算得到的总数不应为负数

错误说明最好指出预期状态,并给出有助于排查的信息:

total = -1
assert total >= 0, f"总数应当非负,实际得到 {total}"

异常信息的最后一行为:

AssertionError: 总数应当非负,实际得到 -1

错误说明通常是字符串,也可以是其他对象。只有条件为假时,错误说明表达式才会被求值。

2.3 条件按真值判断

assert 使用 Python 的真值判断规则,条件表达式不必直接得到 True 或 False。

例如:

items = [10, 20, 30]
assert items, "处理结果不应为空"

这里检查的是列表是否非空。

不过,条件应与实际意图一致。如果想检查某个结果不是 None,应该这样写:

assert result is not None, "处理结果不应为 None"

不宜直接写成:

assert result

原因是 0、空字符串和空列表等对象也会被判断为假,而它们在某些任务中可能是合法结果。

三、常见使用场景

3.1 检查中间处理结果

程序由多个步骤组成时,可以在关键步骤之后检查结果是否符合预期。

例如,某个转换步骤只负责把整数转换为字符串,不应改变记录数量:

numbers = [10, 20, 30]
texts = [str(number) for number in numbers]

assert len(texts) == len(numbers), "转换前后的记录数量不一致"

以后若修改了转换逻辑,意外漏掉部分记录,这条断言就有机会及时暴露问题。

断言应检查与任务有关的约束,而不是简单重复刚刚执行过的代码。

3.2 检查内部状态的一致性

假设程序把一批数据分成训练部分和测试部分。按照设计,两部分的记录总数应等于原始记录数:

records = list(range(10))

train_records = records[:8]
test_records = records[8:]

assert (
    len(train_records) + len(test_records) == len(records)
), "划分后的记录总数与原始记录数不一致"

这条断言表达了一项内部约束,调整划分逻辑后,如果数量出现异常,可以马上发现。

不过,数量一致并不意味着划分一定正确。比如,它无法单独证明两部分没有重复记录。断言能检查什么,取决于所写条件能表达什么。

3.3 编写简单测试

assert 也可以检查函数在已知输入下是否得到预期结果:

def absolute_value(number):
    if number < 0:
        return -number
    return number

assert absolute_value(5) == 5
assert absolute_value(-5) == 5
assert absolute_value(0) == 0

print("测试通过")

输出:

测试通过

这些测试分别覆盖了正数、负数和零。相比只检查一个普通输入,覆盖不同分支和边界情况的测试用例更容易发现实现中的问题。

但测试通过只说明当前用例没有发现错误,并不能证明函数对所有输入都正确。

四、assert 与 if 判断的区别

4.1 assert 表达内部预期

assert 适合表达这样的判断:

“按照程序设计,运行到这里时,这个条件应当成立。如果不成立,就需要检查代码。”

例如,内部转换流程不应改变记录数量,就可以用断言检查这一约束。

它主要用于发现程序中的错误,而不是处理正常业务流程中可能出现的各种情况。

4.2 必须执行的检查使用 if 和 raise

用户输入、文件内容和网络数据等外部信息可能不符合要求。这属于程序需要正常处理的情况,不能只依赖 assert。

例如,计算平均值时,如果允许调用者传入任意数值列表,就应明确处理空列表:

def average(numbers):
    if not numbers:
        raise ValueError("数值列表不能为空")

    return sum(numbers) / len(numbers)

这里的检查是函数正常行为的一部分,无论是否开启优化模式,都应执行。

不宜写成:

def average(numbers):
    assert numbers, "数值列表不能为空"
    return sum(numbers) / len(numbers)

原因在于 assert 可以被禁用。禁用后,空列表会绕过检查,最终在除法处引发其他异常。

同样,权限验证、支付金额检查和关键数据完整性检查等必须执行的逻辑,也不应只使用 assert。

五、优化模式对 assert 的影响

5.1 assert 可以被移除

在通常使用的 CPython 中,用命令行选项 -O 启动优化模式时,assert 语句会被移除,条件表达式和错误说明表达式都不会执行。-OO 同样会移除断言,并进一步移除文档字符串。

例如,把下面的代码保存为 demo.py:

assert False, "断言失败"
print("程序继续执行")

普通运行:

python demo.py

程序会引发 AssertionError。

使用优化模式运行:

python -O demo.py

输出:

程序继续执行

因此,程序的必要功能不能依赖断言是否执行。

5.2 与 __debug__ 的关系

理解 assert 时,可以借助内置常量 __debug__。

通常情况下,__debug__ 为 True。使用 -O 或 -OO 启动时,它为 False。它的值在解释器启动时确定,不能通过普通赋值修改。

在内置名称未被重新绑定的前提下:

assert condition, message

可以在语义上理解为:

if __debug__:
    if not condition:
        raise AssertionError(message)

这也说明,assert 并不完全等同于始终执行的 if 判断。

六、常见误用与注意事项

6.1 不要把 assert 当作函数

assert 是语句,不是函数。添加错误说明时,直接用逗号分隔:

assert total >= 0, "总数不应为负数"

不要写成:

assert (total >= 0, "总数不应为负数")

后一种写法构造了一个包含两个元素的元组。非空元组的真值为真,因此即使 total 是负数,断言也不会按预期失败。

如果只是给条件加括号,则没有问题:

assert (total >= 0), "总数不应为负数"

6.2 不要在断言中执行必要操作

断言条件中不应包含程序必须执行的操作,例如保存文件、删除数据或修改关键状态。

下面的写法不合适:

pending = [10, 20, 30]
assert pending.pop() == 30

普通运行时,它会从列表中移除最后一个元素。禁用断言后,移除操作也不会发生。这样一来,程序状态会随启动方式而改变。

应当把操作与检查分开:

pending = [10, 20, 30]

item = pending.pop()
assert item == 30, f"预期取得 30,实际取得 {item}"

无论断言是否启用,取出元素的操作都会执行。

6.3 条件求值也可能引发其他异常

assert 不会把所有错误都转换成 AssertionError。

例如:

numbers = []
assert numbers[0] == 10

在判断条件之前,访问 numbers[0] 就会引发 IndexError,所以这里得不到 AssertionError。

编写断言时,要确保检查条件本身合理。必要时可以利用短路求值:

numbers = []
assert numbers and numbers[0] == 10, "列表应非空且首项为 10"

列表为空时,and 后面的表达式不会执行,从而避免访问不存在的元素。

6.4 浮点数结果不宜一律直接判等

浮点数计算可能存在表示误差,下面的断言通常会失败:

assert 0.1 + 0.2 == 0.3

如果要判断计算结果是否足够接近,可以使用 math.isclose:

import math

assert math.isclose(
    0.1 + 0.2,
    0.3,
    rel_tol=1e-9,
    abs_tol=1e-12
), "计算结果与预期值不够接近"

其中,rel_tol 表示相对容差,abs_tol 表示绝对容差。容差应根据数据尺度和任务要求确定,不能把同一组数值用于所有计算场景。

小结

assert 用于检查程序内部预期,条件不成立时引发 AssertionError。它适合调试和测试,但在优化模式下可能被移除。必须执行的验证应使用 if 和 raise,必要的操作也应放在断言之外。

如果想系统梳理更多 Python 开发与测试的实践经验,也可以到云栈社区看看相关的讨论和资源。




上一篇:微软全球服务宕机近24小时:Outlook与Teams已恢复
下一篇:千万级日志管道设计:Filebeat、Redis 与 Logstash 的背压、容量和恢复
您需要登录后才可以回帖 登录 | 立即注册

关闭

站长推荐上一条 /1 下一条

手机版|小黑屋|网站地图|云栈社区 ( 苏ICP备2022046150号-2 )

GMT+8, 2026-11-20 05:02 , Processed in 0.107326 second(s), 41 queries , Gzip On.

Powered by Discuz! X3.5

© 2025-2026 云栈社区.

快速回复 返回顶部 返回列表