Python，模型<>模型，如何避免循环导入

Question

假设我有一个 pydantic（它可以是任何一种）模型，它知道如何将自己转换为 orm（它可以是任何一种）模型。为此，我构建了 mod_a.py:

from pydantic import BaseModel

from mod2mod.mod_b import DBUser

class User(BaseModel):

    name: str
    surname: str

    def to_orm(self) -> DBUser:
        return DBUser(
            full_name = f"{self.surname},{self.name}"
        )

我也希望我的 orm 模型能够将自己转换为 pydantic 模型，所以我的 mod_b.py 是：

from sqlalchemy.orm import declarative_base
from sqlalchemy import Column, Integer, String
from mod_a import User

Base = declarative_base()

class DBUser(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    full_name = Column(String)

    def to_pydantic(self) -> User:
        surname, name = self.full_name.split(',')
        User(
            name=name,
            surname=surname
        )

想法是能够像 mod2mod.py 中那样随意从一个模型转到另一个模型：

import pydantic
from mod_a import User
from mod_b import DBUser


user = User(name='John', surname='Doe')
orm_user = user.to_orm()

pydantic_user = orm_user.to_pydantic()

print(user)
print(pydantic_user)

显然这行不通，因为：

ImportError: cannot import name 'User' from partially initialized module 'mod_a' (most likely due to a circular import) (/mod2mod/mod_a.py)

如何解决这类问题？我是否需要另一个实体，它现在将如何在模型之间进行转换并将当前模型方法放在那里，或者是否有其他一些设计模式？

Answer 1

您必须执行本地 import 和我们 TYPE_CHECKING 才能执行类型提示。

from typing import TYPE_CHECKING
from pydantic import BaseModel

if TYPE_CHECKING:
    from mod2mod.mod_b import DBUser
    

class User(BaseModel):

    name: str
    surname: str

    def to_orm(self) -> "DBUser":
        from mod2mod.mod_b import DBUser

        return DBUser(
            full_name = f"{self.surname},{self.name}"
        )

DBUser也这样做。

Answer 2

您可以使用 import ... 样式代替 from ... import ...。并将 return 类型提示用引号括起来（我在下面这样做）或使用延迟注释评估 PEP-563（顺便说一下，它是 Python 3.10 的默认值）

# mod_a.py
from pydantic import BaseModel
import mod_b


class User(BaseModel):
    name: str
    surname: str

    def to_orm(self) -> 'mod_b.DBUser':
        return mod_b.DBUser()

# mod_b.py
import mod_a

class DBUser:
    def to_pydantic(self) -> 'mod_a.User':
        return mod_a.User(
            name="",
            surname=""
        )

Python，模型<>模型，如何避免循环导入

Python, model <> model, how to avoid circular import

python

oop

design-patterns

sqlalchemy

pydantic