【Python进阶】assert 使用 | assert触发条件，使用实践示例

1 基本介绍

assert 是 Python 中的一个关键字，用于在代码中进行断言检查。它的作用是在条件为 False 的情况下触发 AssertionError 异常，用于帮助开发者在程序中捕获和处理错误。

assert 的语法如下：

assert expression, message

其中 expression 是要进行断言检查的条件，message 是可选的错误消息，当断言失败时会显示该消息。如果 expression 的结果为 False，则会引发 AssertionError 异常。

下面是一个简单的示例：

x = 10
assert x == 5, "x should be 5"

在这个例子中，由于 x 的值不等于 5，所以断言会失败，触发 AssertionError 异常，并显示消息 "x should be 5"。

在开发过程中，assert 可以帮助开发者快速发现程序中的问题，并进行调试和修复。然而，在生产环境中，通常会关闭断言检查，以避免因为断言失败而导致程序终止。可以通过在启动 Python 解释器时使用 -O 选项来关闭断言检查，例如：

python -O your_script.py

这样，在运行时会忽略所有 assert 语句。

2 其他实践示例

在实际工程中，assert 通常用于检查输入参数、函数返回值、以及程序中的一些不变量。下面是一些常见的例子：

2.1 检查函数参数

def divide(x, y):
    assert y != 0, "Cannot divide by zero"
    return x / y

result = divide(10, 0)

2.2 检查输入数据是否合规

def get_item_from_list(lst, index):
    assert 0 <= index < len(lst), f"Index out of range: {index}"
    return lst[index]

result = get_item_from_list([1, 2, 3], 5)

2.3 检查操作是否合规

class Stack:
    def __init__(self):
        self.items = []

    def push(self, item):
        self.items.append(item)

    def pop(self):
        assert not self.is_empty(), "Stack is empty"
        return self.items.pop()

    def is_empty(self):
        return len(self.items) == 0

s = Stack()
s.pop()

这些例子展示了 assert 在实际工程中的应用，它可以帮助开发者在程序中快速发现问题，并提供有用的错误信息。