【Python】Python中assert语句的用法

在 Python 中，assert 语句用于断言某个条件是真的。如果条件为 False，则会触发一个 AssertionError。这种机制常用于在开发阶段检查程序的状态，确保代码在某个特定点满足预期条件。通过这种方式，开发者可以在代码错误导致更大问题之前及时发现并修复错误。

基本语法

assert 语句的基本语法如下：

assert condition, message

• condition：一个需要评估的表达式，结果应该是布尔值 True 或 False。
• message：当条件不为 True 时，抛出的 AssertionError 将包含的错误消息。

示例用法

下面通过几个例子来展示 assert 语句的常见用途：

示例 1：检查变量值

假设你有一个函数，要求输入的参数必须是正数。你可以使用 assert 来确保这一点：

def sqrt(x):
    assert x >= 0, "x must be non-negative"
    return x ** 0.5

print(sqrt(4))  # 输出: 2.0
print(sqrt(-1))  # 抛出 AssertionError: x must be non-negative

示例 2：确保列表不为空

在进行操作前确保列表中至少有一个元素：

def get_first_item(items):
    assert len(items) > 0, "The list cannot be empty"
    return items[0]

print(get_first_item([1, 2, 3]))  # 输出: 1
print(get_first_item([]))  # 抛出 AssertionError: The list cannot be empty

示例 3：验证函数输出

检查函数返回的结果是否符合预期：

def get_percentage(value, total):
    assert total != 0, "total must not be zero"
    percentage = (value / total) * 100
    assert 0 <= percentage <= 100, "percentage must be between 0 and 100"
    return percentage

print(get_percentage(50, 100))  # 输出: 50.0
print(get_percentage(120, 100))  # 抛出 AssertionError: percentage must be between 0 and 100

注意事项

• 调试和生产：assert 通常用于调试阶段，以捕获代码中的错误。在生产环境中，由于性能考虑，有时 Python 程序可能会使用 -O（优化）标志来运行，这将导致所有 assert 语句被忽略。
• 不是常规流程控制工具：assert 不应用作常规的程序流程控制机制。它主要用于检测不应发生的情况，即用作调试辅助工具。

assert 语句是 Python 中一个强大的调试辅助工具，帮助开发者在早期发现逻辑错误，提高代码质量。