Python 如果init被重载，如何输入提示一个基于init的函数的返回类型

发布于02月29日

我有一个类，在它的init中接受int或float，但都必须是int或float，所以我使用typing.overload来实现这一点，我希望能够根据给定的值输入hint函数的返回值.

class Vector3:
    @overload
    def __init__(self, x: int, y: int, z: int) -> None:
        ...
    @overload
    def __init__(self, x: float, y: float, z: float) -> None:
        ...

    def __init__(self, x, y, z) -> None:
        self._x = x
        self._y = y
        self._z = z

    # This function
    def __key(self) -> tuple[int | float, int | float, int | float]:
        return (self._x, self._y, self._z)

另外，我应该如何输入提示x、y和z的值？我计划使用@property来混淆_x、_y、_z值，我也不知道如何输入hint它们.

@property
def x(self) -> int | float:
    return self._x

推荐答案

千万不要让__init__辆超载.改为使用受约束的类型变量使Vector3成为泛型.

from typing import Generic, TypeVar

T = TypeVar('T', int, float)

class Vector3(Generic[T]):
    def __init__(self, x: T, y: T, z: T) -> None:
        self._x: T = x
        self._y: T = y
        self._z: T = z

    def __key(self) -> tuple[T, T, T]:
        return (self._x, self._y, self._z)

    @property
    def x(self) -> T:
        return self._x

    # etc

然后

reveal_type(Vector3(1, 2, 3))  # Vector3[int]
reveal_type(Vector3(1., 2., 3.)) # Vector3[float]
reveal_type(Vector3(1, 2, 3.)) # Vector3[float], via promotion of int values to floats
reveal_type(Vector3('1', '2', '3'))  # type error, T cannot be bound to str

请注意，在此上下文中，int被视为float的子类型.