Typehint使用importlib动态导入模块



给出如下内容:

import importlib
module_path = "mod"
mod = importlib.import_module(module_path, package=None)
print(mod.Foo.Bar.x)

其中mod.py为:

class Foo:
class Bar:
x = 1

mypy file.py --strict引发以下错误:

file.py:7: error: Module has no attribute "Foo"  [attr-defined]

我想知道一个人应该如何去类型提示这,或者如果这是一些通常会被忽略的# type: ignore[attr-defined](假设代码是必要的,唯一的选项是类型提示或忽略类型提示)?


为什么我在这种情况下使用importlib

使用importlib的方式是有一些路径:

x.y.<changes>.z

其中<changes>是动态的,但其他是固定的。我相信该模块将包含正在调用的属性,但由于<changes>,importlib用于导入。

可以概括为:

我不知道我将导入哪个模块,但我知道它将有一个类Foo在它

正如@MisterMiyagi在评论中暗示的那样,我认为这里的解决方案是使用结构子类型,而不是名义子类型。标称子类型是使用直接类继承来定义类型关系的地方。例如,collections.Counterdict的子类型,因为它直接继承了dict。然而,结构子类型是我们根据类的某些属性或它所显示的某些行为来定义类型的地方。inttyping.SupportsFloat的子类型,不是因为它直接继承了SupportsFloat,而是因为SupportsFloat被定义为某个接口,而int满足该接口。

在类型提示时,可以使用typing.Protocol定义结构类型。在这种情况下,你可以像这样满足MyPy:

import importlib
from typing import cast, Protocol
class BarProto(Protocol):
x: int

class FooProto(Protocol):
Bar: type[BarProto]

class ModProto(Protocol):
Foo: type[FooProto]
module_path = "mod"
mod = cast(ModProto, importlib.import_module(module_path, package=None))
print(mod.Foo.Bar.x)
reveal_type(mod)
reveal_type(mod.Foo)
reveal_type(mod.Foo.Bar)
reveal_type(mod.Foo.Bar.x)

我们在这里定义了几个接口:

  • BarProto:为了满足这个接口,类型必须有一个类型为int的属性x
  • FooProto:为了满足这个接口,一个类型必须有一个属性Bar,这是一个类的实例满足BarProto协议。
  • ModProto:为了满足这个接口,一个类型必须有一个属性Foo,这是一个类的实例满足FooProto协议。

然后,在导入模块时,使用typing.cast向类型检查器断言要导入的模块满足ModProto协议。

通过MyPy运行它,它告诉我们它推断出以下类型:

main.py:18: note: Revealed type is "__main__.ModProto"  
main.py:19: note: Revealed type is "Type[__main__.FooProto]"
main.py:20: note: Revealed type is "Type[__main__.BarProto]"
main.py:21: note: Revealed type is "builtins.int"

阅读更多关于python结构子类型的信息。

相关内容

  • 没有找到相关文章

最新更新