pydantic：对具有别名的字段使用 property.getter 装饰器

Question

一直向下滚动 tl;dr，我提供了我认为很重要但与所问问题没有直接关系的上下文

一些上下文

我正在为 webapp 制作 API，一些值是根据pydantic 中其他值的值计算的BaseModel。这些用于用户验证、数据序列化和数据库 (NoSQL) 文档定义。

具体来说，我几乎所有资源都继承自一个OwnedResource类，该类定义了不相关的其他属性，如创建/上次更新日期：

• object_key-- 使用长度为 6的nanoid和自定义字母表的对象键
• owner_key -- 该键引用拥有该对象的用户 -- 长度为 10 的 nanoid。
• _key ——这是我遇到一些问题的地方，我会解释原因。

所以arangodb——我正在使用的数据库——强加了_key作为资源被识别的属性的名称。

由于在我的 web 应用程序中，所有资源只能由创建它们的用户访问，因此可以仅使用对象的键（例如/subject/{object_key}）在 URL 中标识它们。但是，由于_key必须是唯一的，我打算使用 构造此字段的值f"{owner_key}/{object_key}"，以将每个用户的对象存储在数据库中，并可能在未来允许跨用户资源共享。

目标是拥有最短的每个用户唯一标识符，因为用于实际访问和操作存储在数据库中的文档owner_key的完整部分_key始终相同：当前登录用户的_key.

我的尝试

我当时的想法是将该_key字段定义为类中的@property-decorated 函数。但是，Pydantic 似乎没有将它们注册为模型字段。

此外，该属性必须实际命名key并使用别名（with Field(... alias="_key"），因为pydantic 将下划线前缀的字段视为内部字段并且不会公开它们。

这是 的定义OwnedResource：

class OwnedResource(BaseModel):
    """
    Base model for resources owned by users
    """

    object_key: ObjectBareKey = nanoid.generate(ID_CHARSET, OBJECT_KEY_LEN)
    owner_key: UserKey
    updated_at: Optional[datetime] = None
    created_at: datetime = datetime.now()

    @property
    def key(self) -> ObjectKey:
        return objectkey(self.owner_key)

    class Config:
        fields = {"key": "_key"} # [1]

[1] 由于不能使用 Field(..., alias="...")，我使用了 Config 子类的这个属性（参见pydantic 的文档）

但是，这不起作用，如以下示例所示：

@router.post("/subjects/")
def create_a_subject(subject: InSubject):
    print(subject.dict(by_alias=True))

与InSubject适当的限定特性Subject，并Subject作为一个空类来自继承InSubject和OwnedResource：

class InSubject(BaseModel):
    name: str
    color: Color
    weight: Union[PositiveFloat, Literal[0]] = 1.0
    goal: Primantissa # This is just a float constrained in a [0, 1] range
    room: str

class Subject(InSubject, OwnedResource):
    pass

当我执行 a 时POST /subjects/，控制台中会打印以下内容：

{'name': 'string', 'color': Color('cyan', rgb=(0, 255, 255)), 'weight': 0, 'goal': 0.0, 'room': 'string'}

如你所见，_key或key无处可见。

请询问详细信息和说明，我试图使这尽可能容易理解，但我不确定这是否足够清楚。

tl;博士

一个没有上下文的更通用的例子，没有深刻的上下文：

使用以下课程：

from pydantic import BaseModel

class SomeClass(BaseModel):
    
    spam: str

    @property
    def eggs(self) -> str:
        return self.spam + " bacon"

    class Config:
        fields = {"eggs": "_eggs"}

我希望以下内容为真：

a = SomeClass(spam="I like")
d = a.dict(by_alias=True)
d.get("_eggs") == "I like bacon"

Answer 1

Pydantic 不支持序列化属性，在 GitHub 上请求此功能存在问题。

根据ludwig-weiss 的评论，他建议子类化 BaseModel 并覆盖该dict方法以包含属性。

class PropertyBaseModel(BaseModel):
    """
    Workaround for serializing properties with pydantic until
    https://github.com/samuelcolvin/pydantic/issues/935
    is solved
    """
    @classmethod
    def get_properties(cls):
        return [prop for prop in dir(cls) if isinstance(getattr(cls, prop), property) and prop not in ("__values__", "fields")]

    def dict(
        self,
        *,
        include: Union['AbstractSetIntStr', 'MappingIntStrAny'] = None,
        exclude: Union['AbstractSetIntStr', 'MappingIntStrAny'] = None,
        by_alias: bool = False,
        skip_defaults: bool = None,
        exclude_unset: bool = False,
        exclude_defaults: bool = False,
        exclude_none: bool = False,
    ) -> 'DictStrAny':
        attribs = super().dict(
            include=include,
            exclude=exclude,
            by_alias=by_alias,
            skip_defaults=skip_defaults,
            exclude_unset=exclude_unset,
            exclude_defaults=exclude_defaults,
            exclude_none=exclude_none
        )
        props = self.get_properties()
        # Include and exclude properties
        if include:
            props = [prop for prop in props if prop in include]
        if exclude:
            props = [prop for prop in props if prop not in exclude]

        # Update the attribute dict with the properties
        if props:
            attribs.update({prop: getattr(self, prop) for prop in props})

        return attribs