FastAPI FastAPI / Pydantic 单独文件中的循环引用问题

在本文中，我们将介绍在使用FastAPI和Pydantic时，在不同文件中出现循环引用的问题以及如何解决。

循环引用是指在两个或多个文件中互相引用对方的内容，从而导致无法解析的问题。在FastAPI和Pydantic的开发过程中，循环引用可能会出现在定义模型和路由处理函数之间的关系上。

阅读更多：FastAPI 教程

循环引用的问题

循环引用可能会导致导入错误，因为解释器无法确定如何解析这些互相引用的对象。在FastAPI和Pydantic中，通常会发生以下两种情况下的循环引用：

1. 定义模型时，模型中的字段类型与其他模型相互引用。
2. 路由处理函数中，函数的输入参数类型与模型相互引用。

对于以上情况，解释器无法在加载程序时正确解析模型和路由处理函数之间的依赖关系，这将导致运行时错误或无法启动应用程序。

为了更好地说明这个问题，让我们看一个具体的示例：

main.py

from fastapi import FastAPI
from .models import Item

app = FastAPI()

@app.get("/items/{item_id}")
async def get_item(item_id: int):
    item = Item(id=item_id)
    return item

models.py

from .main import app
from pydantic import BaseModel

class Item(BaseModel):
    id: int
    name: str = app.title

在上面的示例中，main.py中定义了一个FastAPI实例，然后在models.py中引用了该实例。这就导致了循环引用的问题，因为FastAPI实例又引用了定义在models.py中的模型。

解决方法

为了解决循环引用的问题，我们可以使用两种方法：

方法一：将模型类移动到main.py中

将模型类移动到main.py中，这样就可以避免在模型类中引用FastAPI实例。

main.py

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    id: int
    name: str = app.title

@app.get("/items/{item_id}")
async def get_item(item_id: int):
    item = Item(id=item_id)
    return item

方法二：使用字符串类型的字段

另一种解决方法是将模型中的字段类型更改为字符串类型，并在使用字段时再进行解析。

main.py

from fastapi import FastAPI
from .models import Item

app = FastAPI()

@app.get("/items/{item_id}")
async def get_item(item_id: int):
    item = Item(id=item_id)
    return item

models.py