Python中assert的用法
技术背景
在Python编程中，为了保证程序的正确性和健壮性，我们需要对程序的状态和数据进行检查。assert语句就是Python提供的一种用于调试和自我检查的机制。它允许开发者在代码中声明某些条件是“不可能”发生的，如果这些条件不成立，说明程序中存在bug，会立即触发错误，帮助开发者快速定位问题。
实现步骤
基本语法
assert语句有两种基本形式：
- 简单形式：assert <expression>
- 扩展形式：assert <expression1>, <expression2>
简单示例
# 简单形式
assert True # 条件为真，不会触发错误
# assert False # 条件为假，会触发AssertionError
# 扩展形式，添加错误信息
assert 2 + 2 == 5, "Houston we've got a problem" # 条件为假，触发AssertionError并输出错误信息实际应用场景
输入验证
class PositiveInt(int):
def __new__(cls, value):
if value <= 0:
raise ValueError(f"{value} is not positive")
assert value > 0, "value must be positive"
return super(PositiveInt, cls).__new__(cls, value)检查函数返回值
def calculate_discount(price, discount):
discounted_price = price - (discount * price)
assert 0 <= discounted_price <= price
return discounted_price核心代码
以下是assert语句的等价代码解释：
# 简单形式等价代码
if __debug__:
if not <expression>:
raise AssertionError
# 扩展形式等价代码
if __debug__:
if not <expression1>:
raise AssertionError(<expression2>)最佳实践
- 作为调试工具：assert主要用于调试阶段，帮助开发者快速发现和定位程序中的bug。例如，在函数的开头检查输入参数是否符合预期，在函数的结尾检查返回值是否满足条件。
- 作为文档：assert语句可以作为代码的文档，向其他开发者传达代码的预期状态和假设。例如，在一个函数中，如果看到assert len(lst) > 0，其他开发者可以知道这个函数要求输入的列表不能为空。
- 避免用于用户输入验证：由于assert语句可以在优化模式下被忽略（使用python -O script.py），因此不应该用于验证用户输入。对于用户输入的验证，应该使用if语句和raise异常来处理。
常见问题
括号使用问题
在Python中，assert是一个语句，而不是函数。因此，不要使用括号将条件和错误信息括起来，否则可能会导致意外的结果。
# 错误示例
assert(2 + 2 == 5, "Houston we've got a problem") # 这里的条件会被视为一个元组，永远为真
# 正确示例
assert 2 + 2 == 5, "Houston we've got a problem"优化模式下的问题
当使用python -O或python -OO运行Python脚本时，assert语句会被忽略，因为此时__debug__为False。因此，如果在代码中依赖assert来进行重要的检查，可能会导致程序在优化模式下出现潜在的问题。所以，重要的验证逻辑应该使用if语句和raise异常来实现。