如何在 return 类型取决于参数的输入类型的情况下对函数进行类型提示?
How can I type-hint a function where the return type depends on the input type of an argument?
假设我有一个函数可以将 Python 数据类型转换为 Postgres 数据类型,如下所示:
def map_type(input):
if isinstance(input, int):
return MyEnum(input)
elif isinstance(input, str):
return MyCustomClass(str)
我可以将其键入提示为:
def map_type(input: Union[int, str]) -> Union[MyEnum, MyCustomClass]: ...
但是像下面这样的代码将无法进行类型检查,即使它是正确的:
myvar = map_type('foobar')
print(myvar.property_of_my_custom_class)
完整示例(工作代码,但类型提示错误):
from typing import Union
from enum import Enum
class MyEnum(Enum):
VALUE_1 = 1
VALUE_2 = 2
class MyCustomClass:
def __init__(self, value: str) -> None:
self.value = value
@property
def myproperty(self) -> str:
return 2 * self.value
def map_type(value: Union[int, str]) -> Union[MyEnum, MyCustomClass]:
if isinstance(value, int):
return MyEnum(value)
elif isinstance(value, str):
return MyCustomClass(value)
raise TypeError('Invalid input type')
myvar1 = map_type(1)
print(myvar1.value, myvar1.name)
myvar2 = map_type('foobar')
print(myvar2.myproperty)
我知道我可以将映射拆分为两个函数,但目标是拥有一个通用类型映射函数。
我也在考虑使用 classes 和多态性,但是我将如何对最顶层的 class 方法进行类型提示?因为它们的输出类型将取决于具体的实例类型。
这正是 function overloads 的用途。
简而言之,您执行以下操作:
from typing import overload
# ...snip...
@overload
def map_type(value: int) -> MyEnum: ...
@overload
def map_type(value: str) -> MyCustomClass: ...
def map_type(value: Union[int, str]) -> Union[MyEnum, MyCustomClass]:
if isinstance(value, int):
return MyEnum(value)
elif isinstance(value, str):
return MyCustomClass(value)
raise TypeError('Invalid input type')
现在,当您执行 map_type(3)
时,mypy 将理解 return 类型为 MyEnum
。
并且在 运行 时,实际 运行 的唯一功能是最后一个 - 前两个被完全覆盖和忽略。
假设我有一个函数可以将 Python 数据类型转换为 Postgres 数据类型,如下所示:
def map_type(input):
if isinstance(input, int):
return MyEnum(input)
elif isinstance(input, str):
return MyCustomClass(str)
我可以将其键入提示为:
def map_type(input: Union[int, str]) -> Union[MyEnum, MyCustomClass]: ...
但是像下面这样的代码将无法进行类型检查,即使它是正确的:
myvar = map_type('foobar')
print(myvar.property_of_my_custom_class)
完整示例(工作代码,但类型提示错误):
from typing import Union
from enum import Enum
class MyEnum(Enum):
VALUE_1 = 1
VALUE_2 = 2
class MyCustomClass:
def __init__(self, value: str) -> None:
self.value = value
@property
def myproperty(self) -> str:
return 2 * self.value
def map_type(value: Union[int, str]) -> Union[MyEnum, MyCustomClass]:
if isinstance(value, int):
return MyEnum(value)
elif isinstance(value, str):
return MyCustomClass(value)
raise TypeError('Invalid input type')
myvar1 = map_type(1)
print(myvar1.value, myvar1.name)
myvar2 = map_type('foobar')
print(myvar2.myproperty)
我知道我可以将映射拆分为两个函数,但目标是拥有一个通用类型映射函数。
我也在考虑使用 classes 和多态性,但是我将如何对最顶层的 class 方法进行类型提示?因为它们的输出类型将取决于具体的实例类型。
这正是 function overloads 的用途。
简而言之,您执行以下操作:
from typing import overload
# ...snip...
@overload
def map_type(value: int) -> MyEnum: ...
@overload
def map_type(value: str) -> MyCustomClass: ...
def map_type(value: Union[int, str]) -> Union[MyEnum, MyCustomClass]:
if isinstance(value, int):
return MyEnum(value)
elif isinstance(value, str):
return MyCustomClass(value)
raise TypeError('Invalid input type')
现在,当您执行 map_type(3)
时,mypy 将理解 return 类型为 MyEnum
。
并且在 运行 时,实际 运行 的唯一功能是最后一个 - 前两个被完全覆盖和忽略。