用assert写出健壮代码：Python调试必备的断言实践技巧

jinchanchan

assert 是 Python 中的一个调试工具，用于检查某个条件是否为真。如果条件为真，程序继续执行；如果条件为假，assert 会抛出 AssertionError 异常，并可选地输出一条错误信息。

语法

1. assert condition, message

复制代码

condition：要检查的条件表达式。
message（可选）：当条件为假时，输出的错误信息。

经典例子
1. 检查变量值

1. def divide(a, b):
   
2.     assert b != 0, "除数不能为零"
   
3.     return a / b
   
4. 
   
5. print(divide(10, 2))  # 输出: 5.0
   
6. print(divide(10, 0))  # 抛出 AssertionError: 除数不能为零

复制代码

在这个例子中，assert 确保除数 b 不为零。如果 b 为零，程序会抛出 AssertionError 并输出错误信息。

2. 检查列表是否为空

1. def get_first_element(lst):
   
2.     assert len(lst) > 0, "列表不能为空"
   
3.     return lst[0]
   
4. 
   
5. print(get_first_element([1, 2, 3]))  # 输出: 1
   
6. print(get_first_element([]))         # 抛出 AssertionError: 列表不能为空
   

复制代码

这里 assert 确保列表 lst 不为空。如果为空，程序会抛出异常。

3. 检查函数参数类型

1. def add_numbers(a, b):
   
2.     assert isinstance(a, int), "a 必须是整数"
   
3.     assert isinstance(b, int), "b 必须是整数"
   
4.     return a + b
   
5. 
   
6. print(add_numbers(2, 3))  # 输出: 5
   
7. print(add_numbers(2, "3"))  # 抛出 AssertionError: b 必须是整数

复制代码

在这个例子中，assert 确保 a 和 b 都是整数。如果不是，程序会抛出异常。

4. 检查函数返回值

1. def is_positive(n):
   
2.     return n > 0
   
3. 
   
4. def process_positive_number(n):
   
5.     assert is_positive(n), "输入必须是正数"
   
6.     return n * 2
   
7. 
   
8. print(process_positive_number(5))  # 输出: 10
   
9. print(process_positive_number(-1))  # 抛出 AssertionError: 输入必须是正数

复制代码

这里 assert 确保输入 n 是正数。如果不是，程序会抛出异常。

注意事项
assert 主要用于调试和开发阶段，帮助开发者快速发现代码中的问题。
在生产环境中，assert 语句可能会被禁用（通过 -O 或 -OO 选项），因此不应依赖 assert 来处理关键的错误检查。

总结
assert 是一个简单而强大的工具，用于在代码中插入检查点，确保某些条件在运行时为真。它可以帮助你快速发现和修复代码中的错误。
————————————————

转载自：CSDN 自渡&自给

FishC

用assert写出健壮代码：Python调试必备技巧

---

• 核心语法
  
  1. assert 条件表达式, "失败时的提示信息"

  复制代码
  
  
• 运行机制
  条件为False时触发AssertionError，程序立即终止
  
• 适用场景
  开发阶段验证代码假设，不适用于生产环境错误处理
  

---

▌实用断言技巧

• 验证输入参数
  
  1. def calculate_area(radius):
     
  2.     assert radius > 0, "半径必须大于0"
     
  3.     return 3.14 * radius ** 2

  复制代码
  
  
• 检查中间状态
  
  1. def process_data(data):
     
  2.     result = complex_operation(data)
     
  3.     assert not pd.isnull(result), "计算结果出现空值"
     
  4.     return result

  复制代码
  
  
• 类型校验（Python3.10+）
  
  1. def connect(host: str, port: int):
     
  2.     assert isinstance(host, str), "host必须是字符串"
     
  3.     assert isinstance(port, int), "port必须是整数"

  复制代码
  
  
• 集合校验
  
  1. def get_median(numbers):
     
  2.     assert len(numbers) >= 3, "至少需要3个数据点"
     
  3.     return sorted(numbers)[len(numbers)//2]

  复制代码
  
  

---

▌最佳实践指南

• 错误信息要具体明确："age不能为负" 优于 "参数错误"
• 不要修改程序状态的断言（避免副作用）
• 结合类型提示使用，但不要替代类型提示
• 处理浮点数时使用容忍范围：
  
  1. assert abs(a - b) < 1e-9, "浮点计算精度不足"

  复制代码
  
  

---

▌重要注意事项

• 启动Python时加 -O 参数会跳过所有断言
• 生产环境建议用try/except替代断言
• 不要用于用户输入验证（可能被恶意绕过）
• 复杂条件建议拆分成多个简单断言
  

---

▌调试案例演示

1. def format_name(first, last):
   
2.     assert isinstance(first, str), "名字必须是字符串"
   
3.     assert isinstance(last, str), "姓氏必须是字符串"
   
4.     assert len(first) > 1 and len(last) > 1, "姓名至少2个字符"
   
5.     return f"{last.upper()}, {first.capitalize()}"
   
6.    
   
7. print(format_name("alice", "smith"))  # 正常执行
   
8. print(format_name(123, "doe"))        # 触发类型断言
   
9. print(format_name("A", "b"))          # 触发长度断言

复制代码

---

提示：断言是开发阶段的利器，但发布时应通过单元测试覆盖这些检查

以上回复来自 FishC AI 小助理，如未能正确解答您的问题，请继续追问。