如何为管理泛型类实例的工厂方法参数添加类型提示

需求背景 #

需要实现一个泛型Manager类，作为Base子类的工厂并拥有实例所有权。Base类的构造参数base_arg1和base_arg2由Manager内部自动传入，调用new_instance时只需传递子类的自定义构造参数，同时要保证类型检查正常工作：

• 调用new_instance时仅提示子类的自定义参数
• 强制子类构造函数必须包含Base的两个参数

示例问题代码 #

class Base:
    """Base class for all instances"""
    def __init__(self, base_arg1: int, base_arg2: float):
        pass


InstanceType = TypeVar('InstanceType', bounds=Base)  # 必须是Base的子类

class Manager(Generic[InstanceType]):
    """管理类，作为实例工厂创建并持有实例。但实例构造函数可能包含自定义参数，如何正确添加类型提示？"""
    def __init__(self, instance_class: Type[InstanceType]):
        self.factory = instance_class
        pass
   
    def new_instance(self, ??? ):  # 如何为InstanceType构造函数的额外参数（排除Base的base_args）添加类型提示？
        self.factory( ???, base_arg1=123, base_arg2=4.56 )
        pass

class Instance(Base):
    def __init__(self, extra_arg: bool, base_arg1: int, base_arg2: float): # 包含自定义参数extra_arg
        pass


instance_manager = Manager(Instance)  # 会被正确推断为Manager[Instance]

instance_manager.new_instance(extra_arg=True)  # 如何让这里的类型检查生效？

解决方案 #

利用Python 3.10+引入的ParamSpec和Concatenate，可以精准捕获子类的自定义参数，同时约束构造函数必须包含Base的参数。完整实现代码如下：

from typing import TypeVar, Generic, Type, ParamSpec, Concatenate, Callable

class Base:
    """Base class for all instances"""
    def __init__(self, base_arg1: int, base_arg2: float):
        pass

# 限定为Base的子类
InstanceType = TypeVar('InstanceType', bound=Base)
# 捕获子类构造函数的自定义参数
P = ParamSpec('P')

class Manager(Generic[InstanceType, P]):
    """管理类，作为实例工厂创建并持有实例"""
    def __init__(self, instance_class: Callable[Concatenate[P, int, float], InstanceType]):
        self.factory = instance_class
   
    def new_instance(self, *args: P.args, **kwargs: P.kwargs) -> InstanceType:
        # 内部自动传入Base的固定参数，调用者无需关心
        return self.factory(*args, base_arg1=123, base_arg2=4.56, **kwargs)

class Instance(Base):
    def __init__(self, extra_arg: bool, base_arg1: int, base_arg2: float):
        super().__init__(base_arg1, base_arg2)
        self.extra_arg = extra_arg

# 类型自动推断为Manager[Instance, (extra_arg: bool)]
instance_manager = Manager(Instance)
# 类型检查会提示需要传入extra_arg，参数错误时直接报错
instance_manager.new_instance(extra_arg=True)

# 测试多自定义参数的子类
class AnotherInstance(Base):
    def __init__(self, name: str, count: int, base_arg1: int, base_arg2: float):
        super().__init__(base_arg1, base_arg2)
        self.name = name
        self.count = count

another_manager = Manager(AnotherInstance)
# 正确提示需要name和count参数
another_manager.new_instance(name="test", count=5)

关键细节说明 #

1. 捕获并排除Base的参数 #

• ParamSpec('P')用于提取子类构造函数中除Base的两个参数之外的所有自定义参数
• Concatenate[P, int, float]明确表示子类构造函数的参数结构是「自定义参数P」+「int类型的base_arg1」+「float类型的base_arg2」，这样P就自动隔离了Base的固定参数，new_instance只需接收P的参数即可

2. 强制子类包含Base的构造参数 #

Callable[Concatenate[P, int, float], InstanceType]对传入的instance_class做了约束：它必须是一个可调用对象，且参数列表末尾必须是int和float类型的两个参数。如果子类构造函数缺少这两个参数，类型检查工具（如mypy）会直接抛出错误。

内容的提问来源于stack exchange，提问作者Andreas H.