一文弄懂 Python assert 断言
在 Python 中，assert 是一种用于调试的语句，用于检查某个条件是否为 True。如果条件为 False，assert 会抛出 AssertionError 异常，并可选地输出错误信息。assert 通常用于在开发阶段验证程序的假设条件，确保代码的正确性。
1. assert 的基本语法
1.1 语法
assert condition, message
condition：需要检查的条件表达式。message：可选参数，当条件为False时输出的错误信息。
1.2 工作原理
- 如果
condition为True，程序继续执行。 - 如果
condition为False，抛出AssertionError异常，并输出message（如果提供了）。
2. assert 的使用示例
2.1 基本用法
x = 10
assert x > 5 # 条件为 True，程序继续执行
assert x < 5 # 条件为 False，抛出 AssertionError
2.2 带错误信息
x = 10
assert x < 5, "x 必须小于 5" # 条件为 False，抛出 AssertionError: x 必须小于 5
3. assert 的应用场景
3.1 参数验证
assert 可以用于验证函数的输入参数是否符合预期。
def divide(a, b):
assert b != 0, "除数不能为零"
return a / b
print(divide(10, 2)) # 输出: 5.0
print(divide(10, 0)) # 抛出 AssertionError: 除数不能为零
3.2 状态检查
assert 可以用于检查程序运行中的状态是否符合预期。
def process_data(data):
assert len(data) > 0, "数据不能为空"
# 处理数据
print("数据处理完成")
process_data([]) # 抛出 AssertionError: 数据不能为空
3.3 调试辅助
assert 可以用于调试代码，确保某些条件在特定时刻成立。
def calculate_discount(price, discount):
assert 0 <= discount <= 1, "折扣必须在 0 到 1 之间"
return price * (1 - discount)
print(calculate_discount(100, 0.2)) # 输出: 80.0
print(calculate_discount(100, 1.2)) # 抛出 AssertionError: 折扣必须在 0 到 1 之间
4. assert 的注意事项
4.1 不要用于数据验证
assert 主要用于调试和开发阶段，不应用于生产环境中的数据验证。因为 assert 语句在 Python 的优化模式（-O 选项）下会被忽略。
python -O script.py # 启用优化模式，assert 语句会被忽略
4.2 错误信息应清晰
assert 的错误信息应尽量清晰，便于快速定位问题。
assert x > 5, f"x 的值为 {x}，必须大于 5"
4.3 避免副作用
assert 的条件表达式不应包含副作用（如修改全局变量、调用函数等），以免在优化模式下出现问题。
# 不推荐
assert modify_global_variable(), "修改全局变量失败"
# 推荐
result = modify_global_variable()
assert result, "修改全局变量失败"
5. assert 与异常处理的区别
| 特性 | assert |
异常处理（try-except） |
|---|---|---|
| 用途 | 调试和开发阶段的条件检查 | 生产环境中的错误处理 |
| 运行模式 | 在优化模式下会被忽略 | 始终有效 |
| 错误信息 | 可选的错误信息 | 详细的异常信息和堆栈跟踪 |
| 适用场景 | 确保代码的正确性 | 处理运行时可能发生的错误 |
6. 总结
Python 的 assert 断言是一种强大的调试工具，用于在开发阶段验证程序的假设条件。通过掌握 assert 的使用方法，你可以在参数验证、状态检查、调试辅助等场景中高效地完成任务。