flake8-modern-annotations

flake8插件，用于验证符合现代实践的类型注释。

• 根据PEP 563推迟注释评估。
• 根据PEP 585的标准集合泛型。
• 根据PEP 604的联合类型作为X | Y。
• 当PEP 604联合类型可用时，可选类型。

激活

默认情况下，该插件根据用于flake8的Python版本或当它看到启用现代注释的future导入时激活，例如。

from __future__ import annotations

每个功能都有选项可以覆盖自动激活。

安装

标准的python包安装

pip install flake8-modern-annotations

类型别名

注意，在使用现代注释实践和类型别名时有一些限制。

• 前置引用

  • 必须使用字符串字面量。
  • 包含前置引用的联合必须使用 typing.Union。

• 标准集合泛型

  • 如果Python < 3.9，则不能在类型别名中使用，例如 X: TypeAlias = dict[str, str]

• 联合

  • | 联合不能在Python < 3.9的类型别名中使用。

默认设置下，此插件不会报告上述情况中的错误。

建议使用 TypeAlias 类型来帮助此插件在所有情况下正确检测它们。TypeAlias 从Python 3.10+的 typing 和先前的版本的 typing_extensions 中可用。

选项

modern-annotations-postponed : 控制延迟注释（PEP 563）的验证，选项：auto、always、never（默认：auto）

modern-annotations-deprecated : 控制已弃用类型（PEP 585）的验证，选项：auto、always、never（默认：auto）

modern-annotations-type-alias : 在类型别名中使用已弃用类型（适用于旧版Python < 3.9），选项：auto、always、never（默认：auto）

modern-annotations-union : 控制对 typing.Union（PEP 604）使用的检查，选项：auto、always、never（默认：auto）

modern-annotations-optional : 控制对 typing.Optional 使用的检查，选项：auto、always、never（默认：auto）

modern-annotations-include-name : 在消息中包含插件名称

modern-annotations-no-include-name : 在消息中不包含插件名称（默认设置）

所有选项都可以使用带有 -- 前缀的命令行指定，或者可以放置在您的 flake8 配置文件中。

auto 设置根据 flake8 运行的 Python 版本以及代码中是否存在 from __future__ import annotations（在 Python 3.7+ 中启用现代注释）而开启或关闭。

如果正在为预期在 3.7 或 3.8 上运行的 Python 3.9+ 代码开发，请使用 modern-annotations-type-alias=always 强制类型别名的旧行为并确保代码可以运行。

错误代码

示例

x: 'Foo'  <-- MDA001
def foo(x: 'Foo') -> None:  <-- MDA002
def foo(x: Foo) -> 'Bar':  <-- MDA003

from typing import Dict  <-- MDA102
x: Dict[str, str]  <-- MDA202

from typing import Dict
MyDict = Dict[str, int]  <-- no error on Python 3.7/3.8

from typing import Union  <-- MDA400
x: Union[int, float]  <-- MDA401

from typing import Optional  <-- MDA500
x: Optional[int]  <-- MDA501