Flake8:您的样式指南执行工具

快速启动

安装

安装 Flake8 ,打开交互式shell并运行:

python<version> -m pip install flake8

如果你想要 Flake8 要安装默认的Python安装,可以使用:

python -m pip install flake8

注解

Flake8 安装到您需要的 对的 Python版本非常重要。如果你希望 Flake8 正确解析Python3.5中的新语言特性,需要将 Flake8 安装在 3.5 版本上以理解 这些特征。在许多方面,Flake8与运行它的Python版本绑定在一起。

使用Flake8

开始使用 Flake8 ,打开交互式shell并运行:

flake8 path/to/code/to/check.py
# or
flake8 path/to/code/

注解

如果您已安装 Flake8 在特定版本的Python(或多个版本)上,最好改为运行 python<version> -m flake8 .

如果只想查看特定警告或错误的实例,则可以 选择 这样的错误:

flake8 --select E123,W503 path/to/code/

或者,如果你想 忽视 只有一个特定的警告或错误:

flake8 --ignore E24,W504 path/to/code/

有关如何使用和配置的详细信息,请阅读我们的用户指南 Flake8 .

用户指南

的所有用户 Flake8 应该阅读文档的这一部分。这提供了有关的示例和文档 Flake8 的选项分类以及如何在命令行或配置文件中指定它们。

插件开发者指南

如果你正在维护一个插件 Flake8 或者创建一个新的,您应该阅读文档的这一部分。它解释了如何编写插件并将它们分发给其他人。

参与者指南

如果你在读书 Flake8 的源代码,为了好玩或寻求贡献,您应该阅读文档的这一部分。这是只记录内部接口的混合 Flake8 以及为Flake8的设计记录推理。