python - 正确键入可以返回提供的默认值的函数

Question

这个问题在这里已经有了答案:





Mypy: Annotate function where return type depends on the type of an argument

(1 个回答)


23 天前关闭。




我有以下结构的功能:

def get_something_from_data(data: Mapping[str, str], default: Optional[str] = None) -> Optional[str]:
    """Get something out of `data` if it is there, if not return the value of `default`. 
    If `default` is not provided, return None.
    """

所以这可以返回 Optional[str]如果 default被省略，否则将始终返回 str如果 default有一个 str值(value)。
现在我在类似于以下的代码中调用它:

has_value = get_something_from_data(data, "fallback")
return has_value.endswith("k")

即使在这种情况下 has_value将永远是 str , 正在运行 mypy在此代码上生成错误，因为它认为 has_value可能是 None并且不会有 endswith .
所以我尝试以不同的方式输入我的函数:

DT = TypeVar('DT', str, None)

def get_something_from_data(data: Mapping[str, str], default: DT = None) -> Union[str, DT]:
    pass

这有效，但是现在当我在代码上调用 mypy 时，例如:

has_value = get_something_from_data(data)
return has_value.endswith("k")  # might fail as has_value can be None

mypy 不会抛出错误，即使代码有潜在危险。
有没有办法正确键入此函数，以便 mypy 根据是否提供默认值生成错误？

Answer 1

使用 typing.overload您可以描述函数的参数和返回类型的多种组合

from typing import overload, Mapping, Optional


@overload
def get_something_from_data(data: Mapping[str, str], default: None = None) -> Optional[str]:
    ...


@overload
def get_something_from_data(data: Mapping[str, str], default: str) -> str:
    ...


def get_something_from_data(data, default=None):
    pass