跳到内容

缺少返回类型-未文档化的公共函数 (ANN201)

源自 flake8-annotations 代码检查工具。

有时提供修复。

作用

检查公共函数和方法是否具有返回类型注解。

为什么这不好?

类型注解是记录函数返回类型的好方法。 当与类型检查器一起使用时,它们还可以帮助捕获错误,通过确保任何返回值的类型以及调用者期望的类型都符合预期。

示例

def add(a, b):
    return a + b

建议改为

def add(a: int, b: int) -> int:
    return a + b

Availability(可用性)

由于此规则依赖于第三方 typing_extensions 模块以支持某些 Python 版本,如果已通过 lint.typing-extensions linter 选项禁用 typing_extensions 导入,则不会发出诊断信息,也不会提供修复。

Options (选项)