Pydantic create_model_from_typeddict 不适合 mypy？

Question

我在 mypy 的项目中使用从 typeddicts 生成的 pydantic 模型，但是在使用其中一个模型作为返回类型时出现invalid type错误。

直接使用 BaseModel 时不会发生这种情况。

from pydantic import create_model_from_typeddict
from typing import TypedDict


class TD_Foo(TypedDict):
    bar: int


M_Foo = create_model_from_typeddict(TD_Foo)

# error: Variable "pls.M_Foo" is not valid as a type  [valid-type]
def make_foo() -> M_Foo:
    return M_Foo(bar=42)


print(make_foo())

我的代码有问题还是我应该提出问题？ 另外，如果有人知道我是否应该在 mypy 或 pydantic 的回购中提出它？

Answer 1

查看源代码，似乎create_model_from_typeddict在后台调用了常规的旧create_model并将所有**kwargs传递给它。

function create_model默认总是返回类型Type[BaseModel] 。 这也是create_model_from_typeddict的返回类型的注释方式。 因此，在您的情况下，相应地注释make_foo肯定是正确的：

from pydantic import BaseModel, create_model_from_typeddict
from typing import TypedDict


class TD_Foo(TypedDict):
    bar: int


M_Foo = create_model_from_typeddict(TD_Foo)


def make_foo() -> BaseModel:
    return M_Foo(bar=42)

mypy没有问题。

---

现在我正在查看这个问题，我遇到的问题是create_model_from_typeddict没有反映create_model的重载注释，因此以下导致类型错误：

from pydantic import BaseModel, create_model_from_typeddict                                                     from typing import TypedDict


class TD_Foo(TypedDict):
    bar: int


class FooModel(BaseModel):
    pass


M_Foo = create_model_from_typeddict(
    TD_Foo,
    __base__=FooModel,
)


def make_foo() -> FooModel:
    return M_Foo(bar=42)

Mypy 正确地选择了以下内容：

20: error: Incompatible return value type (got "BaseModel", expected "FooModel")  [return-value]

实际上返回的类型确实是FooModel因为M_Foo实际上是Type[FooModel] 。 在我看来，这是由于create_model_from_typeddict被错误（或不完整）注释。 如果传递了基础 class，则应相应地推断返回类型，就像使用create_model一样。

一旦我确认这是有保证的，我想我会为此创建一个拉取请求。

---

无论如何，我希望这会有所帮助。

附言

如果您仍然想知道，为什么不能只使用M_Foo作为注释，那是因为 class 是在运行时动态创建的。 这只是 static 类型检查和动态类型之间的旧困境。 一般来说，类型检查器将无法处理此类类型。