如何在 Python 中正确指定变量的类型以防止 PyCharm 中未解析的引用？

Question

我有一个函数：

def foo(path):
    """ 
    :param path: Path to a folder
    :type path: pathlib.Path
    """
    new_path = path / 'tmp'
    return new_path

它获取一个pathlib.Path 对象并在此路径的末尾添加'tmp'。但是 PyCharm 在new_path = path / 'tmp' 中的path 下显示了一个“未解决的引用”。

很明显，如果此类变量的类型是内置的，则不会发生这种情况。请注意，如果我导入from pathlib import Path 并将def foo(path) 更改为def foo(path: Path)，则可以解决此问题。但我想知道是否有任何方法可以在没有不必要的进口的情况下做到这一点。我阅读了有关 Python 类型的文章，但找不到解决方案。

Answer 1

在下面的示例中，PyCharm 确实发出警告 Unresolved reference 'Path'，因为在注释中，类型提示 argument_path 的类型 Path 尚未从 pathlib 导入。对参数和变量都发出警告。

def foo(argument_path: Path):
    """
    :param path: Path to a folder
    :type path: Path
    """
    new_path: Path = argument_path / 'tmp'
    return new_path

解决这个问题的明显方法是在模块顶部使用from pathlib import Path。

from pathlib import Path

def foo(argument_path: Path):
    new_path: Path = argument_path / 'tmp'

但我想知道是否有任何方法可以避免不必要的导入。

有两种方法可以在没有导入的情况下执行此操作，或者使用注解 pathlib.Path 中的完全限定名称

def foo(argument_path: pathlib.Path):
    new_path: pathlib.Path = argument_path / 'tmp'

或者不使用类型注解，直接在文档字符串中指定类型。

如果您在文档字符串中声明了无法解析的类型，PyCharm 的静态类型检查器不会发出警告。相反，当您尝试使用该功能时，PyCharm 会发出警告。在下面的示例中，签名或变量声明中没有使用类型提示，类型仅在文档字符串中指定。

def foo3(argument_path):
    """
    :param argument_path: Path to a folder
    :type argument_path: pathlib.Path
    """
    new_path = path / 'tmp'
    return new_path

# PyCharm will issue this warning:
foo3("a_string")  # Expected type 'Path', got 'str' instead

最后你在文档字符串中使用reStructuredText语法，这个选项应该在项目设置中指定：Settings>Tools>Python Integrated ToolsPython Integrated ToolsDocString Format