Python 动态类型提示
Python dynamic type hinting
我希望能够提供一个带有类型元组的函数,然后用于反序列化来自事务的 returned 数据。如果交易成功,该函数将 return 这些类型的实例。
例如:
T = TypeVar('T')
class Base:
@classmethod
def deserialize(cls: Type[T], bts: bytes) -> T:
return cls(**json.loads(bts))
@classmethod
def transaction(cls, *types):
items = self.db.transact([t.generate_load_operation() for t in types])
items = [t.deserialize(item) for item in items]
# how do I type-hint transaction, so that it would imply that
# it will always return a tuple (or a list) of instances of classes
# contained in variable types?
return items
class A(Base):
pass
class B(Base):
pass
a_inst, b_inst = Base.transaction(A, B)
我应该如何对事务进行注释,以便类型检查器可以从中正确推断 return 值的类型?
没有通用的方法来做到这一点:就静态类型检查而言,*types
等可变参数不会保留顺序。 Variadic generics cover this behaviour but are only proposals so far.
可以对可变参数使用单个注解,这会降级为通用基类型,也可以使用多个注解来枚举最常见的情况。
将可变参数注释为类型变量(可能通过 Base
绑定)。这会将 所有 类型推断为相同的、最常见的基本类型。
class Base:
@classmethod
def transaction(cls, *types: Type[T]) -> List[T]: ...
class A(Base): ...
class B(Base): ...
reveal_type(Base.transaction(A, A)) # builtins.list[mt.A*]
reveal_type(Base.transaction(A, B)) # builtins.list[mt.Base*]
这在使用类似类型(例如 A
或 A
的子类)并且只期望一般特征(例如 A
)时就足够了。这在使用混合类型(例如 A
和 B
)时是不够的,因为它会退化为公共基类型(例如 Base
)。
为合理数量的参数提供 multiple @overload
签名,并为大量参数使用可变参数包罗万象。这将为指定的情况推断出正确的类型,否则使用最常见的基本类型。
class Base:
# explicitly enumerated types
@overload
@classmethod
def transaction(cls, t1: Type[T1], /) -> Tuple[T1]: ...
@overload
@classmethod
def transaction(cls, t1: Type[T1], t2: Type[T2], /) -> Tuple[T1, T2]: ...
# catch all number of types
@overload
@classmethod
def transaction(cls, *ts: Type[T]) -> Tuple[T, ...]: ...
# implementation
@classmethod
def transaction(cls, *types: Type[T]) -> Tuple[T, ...]: ...
class A(Base): ...
class B(Base): ...
reveal_type(Base.transaction(A)) # Revealed type is 'Tuple[mt.A*]'
reveal_type(Base.transaction(A, A)) # Revealed type is 'Tuple[mt.A*, mt.A*]'
reveal_type(Base.transaction(A, B)) # Revealed type is 'Tuple[mt.A*, mt.B*]'
reveal_type(Base.transaction(A, B, A)) # Revealed type is 'builtins.tuple[mt.Base*]'
这里的限制只是一个人认为相关的案例数量。
我希望能够提供一个带有类型元组的函数,然后用于反序列化来自事务的 returned 数据。如果交易成功,该函数将 return 这些类型的实例。 例如:
T = TypeVar('T')
class Base:
@classmethod
def deserialize(cls: Type[T], bts: bytes) -> T:
return cls(**json.loads(bts))
@classmethod
def transaction(cls, *types):
items = self.db.transact([t.generate_load_operation() for t in types])
items = [t.deserialize(item) for item in items]
# how do I type-hint transaction, so that it would imply that
# it will always return a tuple (or a list) of instances of classes
# contained in variable types?
return items
class A(Base):
pass
class B(Base):
pass
a_inst, b_inst = Base.transaction(A, B)
我应该如何对事务进行注释,以便类型检查器可以从中正确推断 return 值的类型?
没有通用的方法来做到这一点:就静态类型检查而言,*types
等可变参数不会保留顺序。 Variadic generics cover this behaviour but are only proposals so far.
可以对可变参数使用单个注解,这会降级为通用基类型,也可以使用多个注解来枚举最常见的情况。
将可变参数注释为类型变量(可能通过 Base
绑定)。这会将 所有 类型推断为相同的、最常见的基本类型。
class Base:
@classmethod
def transaction(cls, *types: Type[T]) -> List[T]: ...
class A(Base): ...
class B(Base): ...
reveal_type(Base.transaction(A, A)) # builtins.list[mt.A*]
reveal_type(Base.transaction(A, B)) # builtins.list[mt.Base*]
这在使用类似类型(例如 A
或 A
的子类)并且只期望一般特征(例如 A
)时就足够了。这在使用混合类型(例如 A
和 B
)时是不够的,因为它会退化为公共基类型(例如 Base
)。
为合理数量的参数提供 multiple @overload
签名,并为大量参数使用可变参数包罗万象。这将为指定的情况推断出正确的类型,否则使用最常见的基本类型。
class Base:
# explicitly enumerated types
@overload
@classmethod
def transaction(cls, t1: Type[T1], /) -> Tuple[T1]: ...
@overload
@classmethod
def transaction(cls, t1: Type[T1], t2: Type[T2], /) -> Tuple[T1, T2]: ...
# catch all number of types
@overload
@classmethod
def transaction(cls, *ts: Type[T]) -> Tuple[T, ...]: ...
# implementation
@classmethod
def transaction(cls, *types: Type[T]) -> Tuple[T, ...]: ...
class A(Base): ...
class B(Base): ...
reveal_type(Base.transaction(A)) # Revealed type is 'Tuple[mt.A*]'
reveal_type(Base.transaction(A, A)) # Revealed type is 'Tuple[mt.A*, mt.A*]'
reveal_type(Base.transaction(A, B)) # Revealed type is 'Tuple[mt.A*, mt.B*]'
reveal_type(Base.transaction(A, B, A)) # Revealed type is 'builtins.tuple[mt.Base*]'
这里的限制只是一个人认为相关的案例数量。