Python断言使用完全指南：注意事项与最佳实践

什么是Python断言？

Python中的assert语句用于在代码中设置检查点，验证程序执行时某些条件必须为真。如果条件为假，将引发AssertionError异常。

基本语法

assert condition, "Optional error message"

示例：

def calculate_average(numbers):
    assert len(numbers) > 0, "Number list cannot be empty"
    return sum(numbers) / len(numbers)

# 调用函数
print(calculate_average([1, 2, 3]))  # 正常执行
print(calculate_average([]))        # 触发AssertionError: Number list cannot be empty

使用断言的注意事项

1. 不要用于数据验证

断言不应该用于验证用户输入或外部数据，因为可以通过-O标志禁用断言。

错误做法：

# 不要这样使用断言验证用户输入
user_input = input("Enter a number: ")
assert user_input.isdigit(), "Input must be a number"  # 错误！

正确做法：

# 使用条件语句处理用户输入
user_input = input("Enter a number: ")
if not user_input.isdigit():
    raise ValueError("Input must be a number")

2. 避免引起副作用

断言语句中不应包含会影响程序状态的代码，因为禁用断言后这些代码将不会执行。

错误做法：

# 不要这样使用断言（有副作用）
def update_counter():
    global counter
    counter += 1
    return counter

# 在断言中调用有副作用的函数
assert update_counter() < 10, "Counter exceeded limit"  # 错误！

3. 提供有意义的错误信息

总是包含描述性的错误信息，帮助开发者快速定位问题。

推荐做法：

# 提供有用的错误信息
def divide(a, b):
    assert b != 0, f"Cannot divide {a} by zero"
    return a / b

4. 理解断言与异常的区别

断言(assert)	异常(Exception)
用于调试和开发阶段	用于生产环境错误处理
可通过-O标志全局禁用	始终执行
捕获程序逻辑错误	处理预期可能发生的错误

断言的最佳实践

✅ 适用场景

验证函数参数的前提条件
检查中间状态的不变性
测试后置条件（函数返回值）
调试复杂算法中的假设
验证测试用例中的预期行为

❌ 避免场景

用户输入验证
文件/网络操作错误处理
生产环境错误处理
替代异常处理
包含副作用的操作

良好实践示例

def process_data(data):
    # 前提条件检查
    assert isinstance(data, list), "Data must be a list"
    assert all(isinstance(x, (int, float)) for x in data), "All elements must be numbers"
    
    # 处理逻辑
    result = [x * 2 for x in data]
    
    # 后置条件检查
    assert len(result) == len(data), "Result length mismatch"
    assert all(isinstance(x, (int, float)) for x in result), "Result contains non-numeric values"
    
    return result