单独文件中的FastAPI/PYDANIC循环引用 [英] FastAPI / Pydantic circular references in separate files

问题描述

我希望在FastAPI中使用类似以下内容的架构：

from __future__ import annotations
from typing import List
from pydantic import BaseModel


class Project(BaseModel):
    members: List[User]


class User(BaseModel):
    projects: List[Project]


Project.update_forward_refs()

但为了保持我的项目结构整洁，我会选择OFC。我喜欢在不同的文件中定义它们。如何在不创建循环引用的情况下执行此操作？

使用FastAPI中模式生成上面的代码可以很好地工作，我只是不知道如何将其分离到单独的文件中。在后面的步骤中，我将不使用属性，而是使用@property在这些对象的子类中定义这些对象的getter。但是对于OpenAPI文档的生成，我想我需要将其组合在一起。

推荐答案

循环依赖可以在以下三种情况下运行：

• 模块顶部：import package.module
• 模块底部：from package.module import attribute
• 顶层函数：两者都起作用

在您的情况下，模块底部的第二个案例将有所帮助。 因为您使用need to useupdate_forward_refs函数来解析简单延迟的注释，如下所示：

# project.py
from typing import List
from pydantic import BaseModel


class Project(BaseModel):
    members: "List[User]"


from user import User
Project.update_forward_refs()

# user.py
from typing import List
from pydantic import BaseModel


class User(BaseModel):
    projects: "List[Project]"


from project import Project
User.update_forward_refs()

尽管如此，我强烈建议您不要故意引入循环依赖项

这篇关于单独文件中的FastAPI/PYDANIC循环引用的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！