Beanie项目中Callable类型参数在json_schema_extra中的处理问题分析

在MongoDB文档对象映射工具Beanie中，开发者发现了一个与Pydantic模型字段配置相关的重要兼容性问题。这个问题涉及到当使用Callable类型作为json_schema_extra参数时，系统会抛出AttributeError异常。

问题背景

Beanie是基于Pydantic构建的MongoDB ODM工具，它允许开发者使用Python类来定义MongoDB文档结构。Pydantic提供了json_schema_extra参数，用于向JSON模式添加额外的信息。根据Pydantic官方文档，这个参数不仅接受字典类型，还可以接受一个可调用对象(Callable)。

问题现象

当开发者尝试按照Pydantic推荐的方式，将一个函数传递给Field的json_schema_extra参数时，例如：

def pop_default(s):
    s.pop('default')

class Model(Document):
    a: int = Field(default=1, json_schema_extra=pop_default)

Beanie会在初始化过程中抛出AttributeError异常，提示"'function'对象没有'get'属性"。这表明Beanie内部假设json_schema_extra总是一个字典，而实际上Pydantic允许它是可调用对象。

技术分析

问题的根源在于Beanie内部处理字段隐藏逻辑时，直接调用了json_schema_extra.get()方法。在Pydantic的实现中，json_schema_extra可以有以下两种形式：

1. 字典类型：直接包含额外的JSON模式信息
2. 可调用对象：接收一个模式字典作为参数，可以动态修改模式

Beanie的get_extra_field_info函数没有考虑第二种情况，导致当传入Callable时出现属性访问错误。

解决方案

正确的处理方式应该是在访问json_schema_extra前检查其类型。如果是Callable，应该先调用它获取结果；如果是字典，则直接使用。这种处理方式完全符合Pydantic的设计意图。

影响范围

这个问题影响了所有需要在Beanie模型中使用Callable类型json_schema_extra的场景，特别是那些需要动态生成或修改JSON模式的复杂用例。

最佳实践

在使用Beanie时，如果需要使用Callable作为json_schema_extra，开发者可以暂时采用以下变通方案：

def schema_extra(schema):
    # 修改schema的逻辑
    return {"hidden": True}  # 返回一个字典

class Model(Document):
    field: str = Field(..., json_schema_extra=lambda: schema_extra)

这种包装方式可以确保json_schema_extra始终返回一个字典，避免触发Beanie中的类型假设错误。

总结

这个问题揭示了Beanie与Pydantic在json_schema_extra处理上的细微差异。虽然Beanie基于Pydantic构建，但在某些边界情况下仍然需要保持行为的一致性。对于框架开发者来说，这提醒我们在处理用户提供的可扩展点时，需要考虑所有合法的输入类型，而不仅仅是常见情况。