Python 函数设计中的防御式策略

2次阅读

该做函数参数校验,但应避免用 isinstance 硬拦,优先检查明显错误并早抛出清晰提示;可变默认参数须用 none 初始化;意外错误 raise,业务分支返回 none 或标记值;@lru_cache 仅用于输入稳定、可哈希且内存可控场景。

Python 函数设计中的防御式策略

函数参数类型校验该不该做?

该做,但别用 isinstance 硬拦——它在泛型union 和鸭子类型场景下容易误杀,也破坏可扩展性。真正要防的是“明显错”,比如传了 None 却要求非空字符串,或传了字典却预期是列表。

  • 优先用「早抛出 + 清晰提示」:检查关键约束(如 if not isinstance(x, str) or not x.strip()),直接 raise ValueError("name must be a non-empty String")
  • 避免对整个参数结构做深度校验(比如递归检查嵌套 dict 的每个 key),这会让函数难以测试和 mock
  • 如果项目已用 typing,配合 pydantictypeguard 做运行时校验更稳妥,但注意它们会带来启动开销

如何安全处理可变默认参数?

所有用 listdictset 作默认值的写法,本质都是共享同一个对象引用——下次调用时,它可能已被上次修改过。

  • 统一改用 None 作为默认值,再在函数体内初始化:def append_item(items=None): items = items or []
  • 注意 oritems=[] 时仍为真,所以更严谨写法是 items = [] if items is None else items
  • 如果函数需要保留历史状态(比如缓存),那就明确承认这是有意设计,并在 docstring 里写清「此参数为可变对象,调用者需自行管理生命周期」

错误处理该 raise 还是返回 None/False?

取决于错误性质:意外情况(如网络中断、文件被删)必须 raise;预期中的业务分支(如用户未找到)更适合返回 None 或专用标记值(如 dataclasses.MISSING)。

  • 不要把所有异常都吞掉再 return None——这会让调用方无法区分「没结果」和「出错了」
  • 避免用 return False 表示失败,尤其当函数本就应返回布尔值时,语义完全冲突
  • 如果多个错误路径共用同一异常类型(如都抛 ValueError),至少通过 message 区分,或者自定义子类(如 InvalidConfigError

要不要给函数加 @lru_cache

只在确认「输入稳定、输出不变、内存可控」时才加。盲目缓存反而引入隐蔽状态,让调试变难。

立即学习Python免费学习笔记(深入)”;

  • 检查输入是否含不可哈希类型(如 dictlist、自定义对象)——会直接报 TypeError: unhashable type
  • 缓存键基于参数值而非对象身份,所以两个内容相同但地址不同的 dataclass 实例会被视为不同键,除非你显式实现 __hash__
  • 缓存大小不设限(maxsize=None)时,若输入组合多且分散,可能吃光内存;建议先用 maxsize=128 观察命中率

防御式设计最常被忽略的点,其实是「假设调用方会读文档」。实际中,很多人只看函数名和参数名就开写。所以关键约束得写进 signature(比如用 Optional[str])、错误信息得带具体值(比如 f"expected int > 0, got {n}"),而不是依赖 docstring。

text=ZqhQzanResources