PyOTP项目中的默认参数陷阱：为什么不应使用可变对象作为默认参数

在Python编程中，函数默认参数是一个常见的特性，但如果不慎使用可变对象作为默认参数，可能会引发难以察觉的bug。PyOTP项目中的random_base32和random_hex函数就曾存在这样的潜在风险。

问题本质

这两个函数原本的实现方式是将字符列表作为默认参数：

def random_base32(length=32, chars=list("ABCDEFGHIJKLMNOPQRSTUVWXYZ234567")):
    # 函数实现

这种写法的问题在于，Python的默认参数是在函数定义时（模块加载时）就完成初始化的，而不是每次调用函数时重新创建。这意味着所有对该函数的调用都会共享同一个列表对象。

潜在风险示例

虽然PyOTP中的实现目前是安全的（因为函数内部没有修改这个列表），但这种模式存在严重隐患。考虑以下危险示例：

def dangerous_func(items=[]):
    items.append(1)
    return items

print(dangerous_func())  # 输出[1]
print(dangerous_func())  # 输出[1,1]
print(dangerous_func())  # 输出[1,1,1]

每次调用都会修改同一个列表对象，导致函数行为不可预测。

解决方案

对于PyOTP项目，有两种改进方案：

1. 直接使用不可变对象：既然这些字符序列只是用来随机选择，可以直接使用字符串：

def random_base32(length=32, chars="ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"):
    # 函数实现

2. 使用None作为默认值：如果需要保持列表类型，可以采用更安全的模式：

def random_base32(length=32, chars=None):
    if chars is None:
        chars = list("ABCDEFGHIJKLMNOPQRSTUVWXYZ234567")
    # 函数实现

最佳实践

在Python开发中，关于默认参数的最佳实践是：

• 优先使用不可变对象（如None、数字、字符串、元组）作为默认参数
• 如果需要可变对象，应该在函数体内初始化
• 在类型注解中明确参数类型（如Sequence[str]）
• 保持函数签名简洁明了

PyOTP项目最终采用了第一种方案，直接使用字符串作为默认参数，既保证了安全性，又保持了代码的简洁性。

这个案例提醒我们，在Python开发中要特别注意默认参数的特性，避免因共享可变状态而导致的bug。对于安全相关的库如PyOTP，这样的细节尤为重要。