在Hypothesis中禁止Optional字段生成None值的策略指南

背景介绍

Hypothesis是一个强大的Python属性测试库，它能够自动生成符合类型注解的测试数据。在实际应用中，我们经常会遇到Optional类型（即Union[T, None]）的字段，但有时我们希望这些字段始终生成非None值。

问题分析

当使用Hypothesis的from_type()方法生成测试数据时，对于Optional类型的字段，默认行为会随机生成None或指定类型的值。但在某些测试场景下，我们可能需要确保这些"可选"字段始终包含有效值。

解决方案

方法一：注册类型策略

通过register_type_strategy()可以全局修改None类型的生成策略：

from hypothesis import strategies as st
import hypothesis

# 使None类型无法生成有效示例
hypothesis.register_type_strategy(type(None), st.none().filter(lambda _: False))

这种方法会强制所有Optional字段只能生成非None值，适用于需要全局修改的场景。

方法二：修改类型注解

另一种思路是在测试前临时修改数据类的类型注解，将Optional类型改为非Optional类型：

from typing import get_type_hints, Union

# 获取原始类型提示
original_hints = get_type_hints(Foo)

# 创建新的类型提示，移除None
new_hints = {
    k: Union[tuple(arg for arg in t.__args__ if arg is not type(None))] 
    for k, t in original_hints.items()
}

# 临时修改类的__annotations__
Foo.__annotations__ = new_hints

方法三：自定义数据生成策略

对于复杂的数据结构，可以自底向上构建策略：

def non_optional_strategy(typ):
    if get_origin(typ) is Union:
        args = [a for a in get_args(typ) if a is not type(None)]
        return st.one_of([non_optional_strategy(a) for a in args])
    return st.from_type(typ)

# 使用自定义策略生成数据
st.builds(Foo, a=non_optional_strategy(int), b=non_optional_strategy(Union[int, str]))

注意事项

1. 全局修改None策略会影响所有测试用例，可能导致其他测试失败
2. 修改类型注解是临时性的，测试完成后应恢复原状
3. 对于深度嵌套的结构，建议从叶子节点开始构建策略
4. 在团队项目中，应确保所有成员了解这些修改的影响

最佳实践

对于大型项目，推荐使用方法三的自定义策略，因为它：

1. 不影响其他测试用例
2. 可以精确控制每个字段的生成逻辑
3. 便于维护和扩展
4. 不会修改原始类型定义

通过合理选择这些方法，可以在保持代码清晰的同时，满足特定的测试数据生成需求。