在Python中，用类型提示注释路径的正确方式是什么？

Question

如何用Python3为这个简单的实用程序函数添加注释？它应该接受pathlib.Path对象以及任何其他常见传递路径的方式。

def read_json(path: <TYPE HINT>):
    with open(path, 'rb') as f:
        data = json.load(f)
    return data

在我看来，这个主题似乎还在不断变化中，我找不到一个收集这些信息的好地方。我对如何在Python 3.6、3.7和3.8中处理这个问题很感兴趣。

- Zacharias030

Answer 1

我假设典型的路径对象可以是Path或str，因此你可以使用Union。此外，更包容性的os.PathLike优先于pathlib.Path。 Python 3.10或更新版本：

import os

def read_json(path: str | os.PathLike):
    ...

Python 3.5 - 3.9：

import os
import typing

def read_json(path: typing.Union[str, os.PathLike]):
    ...

- Christian Sauer

---

标准函数的类型注释是否有任何地方显示？我找不到，但是“复制open的注释”可能是一个好答案。 - Martin Bonner supports Monica

open 使用 file: _OpenFile 作为注释，该注释是联合类型 Union[AnyPath, int]。 - Diogo

我使用这个 PathLike = TypeVar("PathLike", str, pathlib.Path, None)。 - maf88

不必重复造轮子（@maf88），os模块有os.PathLike，它是pathlib.Path的超类，可以直接使用。我认为答案应该编辑为Union[str, os.PathLike]。 - YotamW Constantini

@YotamWConstantini 是的，但 Pathlike 在2019年不存在。 - Christian Sauer