Python 3.12 泛型：如何在类方法中获取即将实例化的类型？

2024-08-05 20:50:40

Python 3.12 推出的新泛型语法让开发者欢欣鼓舞，更强大的类型提示能力为代码的健壮性和可维护性提供了有力保障。然而，新语法的应用并非一帆风顺，开发者在实际使用过程中难免会遇到一些看似简单却难以解决的难题。一个典型的例子就是在类的类方法中，如何获取即将被实例化的具体类型？

本文将聚焦这个问题，带你深入剖析问题本质，并利用 inspect 模块提供一种行之有效的解决方案，助力你在 Python 3.12 的代码中优雅地驾驭泛型。

问题场景还原

假设我们定义了一个泛型类 MyClass，该类包含一个类变量 kind，用于存储泛型参数 T 的具体类型。我们希望在 MyClass 的类方法 make_class 中，能够打印即将被实例化的 T 的类型，并将该类型绑定到 kind 变量上。

from typing import Generic, TypeVar

T = TypeVar('T')

class MyClass(Generic[T]):
    kind: type[T]

    @classmethod
    def make_class(cls) -> "MyClass[T]":
        # 如何在此处获取 T 的具体类型？
        print(f"I am type {?}!")  
        return cls()

>>> MyClass[int].make_class() 
# 预期输出: "I am type <class 'int'>!"

拨开迷雾，寻找解决方案

Python 内置的 inspect 模块为我们提供了一条清晰的解题思路。inspect 模块提供了一系列强大的函数，可以帮助我们洞察代码运行时的上下文信息，从而找到解决问题的关键。

让我们一起看看如何利用 inspect 模块化解难题：

from typing import Generic, TypeVar
import inspect

T = TypeVar('T')

class MyClass(Generic[T]):
    kind: type[T]

    @classmethod
    def make_class(cls) -> "MyClass[T]":
        # 获取当前栈帧
        current_frame = inspect.currentframe()
        # 获取调用 make_class 的函数
        caller_frame = current_frame.f_back
        # 获取调用 make_class 的函数的参数和值
        args = inspect.getargvalues(caller_frame)
        # 获取 cls 的第一个参数，即泛型参数 T 的具体类型
        class_type = args.locals[args.args[0]].__args__[0]

        print(f"I am type {class_type}!")
        instance = cls()
        instance.kind = class_type
        return instance

>>> MyClass[int].make_class() 
# 输出: "I am type <class 'int'>!"
>>> MyClass[int].make_class().kind is int
# 输出: True

代码解读

引入 inspect 模块 : 我们需要使用 inspect.currentframe() 和 inspect.getargvalues() 函数获取调用栈信息，为后续操作做好准备。
获取调用栈信息 : 在 make_class 方法中，我们首先利用 inspect.currentframe() 获取当前的栈帧，然后通过 current_frame.f_back 获取调用 make_class 的函数的栈帧，从而定位到关键信息所在的位置。
解析参数 : inspect.getargvalues(caller_frame) 函数帮助我们获取调用函数的参数和值。由于 make_class 是一个类方法，它的第一个参数是 cls，而 cls 的第一个参数正是我们心心念念的泛型参数 T 的具体类型。
提取类型 : 我们使用 args.locals[args.args[0]] 获取 cls 的值，再利用 __args__[0] 提取出泛型参数 T 的具体类型，大功告成！
实例化并赋值 : 万事俱备，只欠东风。我们根据获取到的类型实例化 MyClass，并将类型赋值给实例的 kind 属性，从而完整地实现了预期功能。