为Flake8编写插件

自从 Flake8 2.0版 Flake8 该工具允许扩展和自定义插件。在 Flake8 3.0,我们正在扩展定制和扩展的能力 and 我们正试图彻底记录下来。本节中的一些文档可能会引用第三方文档,以减少重复,并向您(开发人员)指出这些部分的权威文档。

入门

开始写一个 Flake8 plugin 您首先需要:

  • 一个插件的想法

  • PyPI上可用的包名

  • 已安装一个或多个版本的Python

  • 文本编辑器或某种IDE

  • 什么想法 kind 要生成的插件的数目:

    • 格式化程序

    • 检查

一旦你收集了这些东西,你就可以开始了。

所有插件 Flake8 必须通过 entry points . 在本节中,我们将介绍:

  • 如何注册你的插件 Flake8 能找到吗

  • 如何制作 Flake8 向check插件提供信息(通过命令行标志、函数/类参数等)

  • 如何制作格式化程序插件

  • 如何编写你的check插件以便它能与 Flake8 2.x和3.x