如何约束 Union 以使输入和输出类型匹配？

Question

我有一个 testcase.py：

import pathlib
import typing as tp


# Not under my control

PathType = tp.Union[str, pathlib.Path]
def foreign(filename: PathType) -> PathType:
    return filename


# Under my control

T = tp.TypeVar('T', str, pathlib.Path)

def my_func(filename: T) -> T:
    return foreign(filename)


if __name__ == '__main__':
    path1: str = '/abc/efg/string.py'
    san_path1: str = my_func(path1)
    print(san_path1, type(san_path1))

    path2: pathlib.Path = pathlib.Path('/abc/efg/pathlib.py')
    san_path2: pathlib.Path = my_func(path2)
    print(san_path2, type(san_path2))

此文件中有两个部分。 在“不受我控制”部分中，我正在模拟不受我控制的模块的功能，但此功能的定义如下所示。

在“在我的控制下”部分，我试图强制执行，如果我用 str 调用 my_func 来取回 str，或者如果我用 pathlib.Path 调用 my_func 来取回 pathlib.Path，但要防止出现以下情况我将用 str 调用该函数并取回 pythlib.Path ，反之亦然。

代码运行良好。如果我运行它，输出是：

$ python testcase.py 
/abc/efg/string.py <class 'str'>
/abc/efg/pathlib.py <class 'pathlib.PosixPath'>

但是 mypy 抱怨：

$ mypy testcase.py 
testcase.py:17: error: Incompatible return value type (got "Union[str, Path]", expected "str")
testcase.py:17: error: Incompatible return value type (got "Union[str, Path]", expected "Path")
Found 2 errors in 1 file (checked 1 source file)

第 17 行是return foreign(filename)。 如何满足mypy？

Answer 1

foreign 不保证它会为str 输入返回一个str，对于Path 也是如此。它只保证类型中的内容（除非文档另有说明）：无论输入如何，它都会返回任一类型。由于它不在您的控制范围内，因此作者可以更改实现，例如它总是返回一个Path，从而破坏你的代码。

如果您不能确定 foreign 的工作原理，您可以根据需要进行转换

def my_func(filename: T) -> T:
    res = foreign(filename)
    
    return str(res) if isinstance(filename, str) else pathlib.Path(res)

或者，如果您有检查 foreign 的测试返回与给定相同的类型，您可以断言 my_func 中的类型

def my_func(filename: T) -> T:
    res = foreign(filename)

    if isinstance(filename, str):
        assert instance(res, str)
        return res
    else:
        assert instance(res, pathlib.Path)
        return res

甚至更好的失败退出

def my_func(filename: T) -> T:
    res = foreign(filename)

    if isinstance(filename, str) and isinstance(res, str):
        return res
    elif isinstance(filename, pathlib.Path) and isinstance(res, pathlib.Path):
        return res
        
    sys.exit("Fatal error")  # we exit if our code's broken

或者，如果您不希望这些检查的运行时成本，并且您乐于依靠运行时测试来验证 foreign，只需 # type: ignore return 中的 return 语句@ 语句。