PyCharm 中的描述性 flake8 错误

Question

PyCharm 目前没有对 flake8 的内置支持。但是， flake8 可以配置为作为外部工具运行。

有时，特别是对于 Python 新手，并非每个 flake8 警告都是可以理解的，需要额外说明。

我们最近偶然发现了 Flake8Rules 项目，该项目试图通过支持示例详细描述每一个警告。

有没有办法结合 PyCharm， flake8 和 Flake8Rules 一起显示静态代码分析警告以及额外的描述或指向 Flake8Rules ?catalog-?catalog-?

原文由 alecxe 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

这绝对是可能的。

一种方法是使用 --format 命令行选项 调整 flake8 输出，以指定指向 Flake8Rules :009– catalog 的 http(s) 链接

--format='%(path)s:%(row)d,%(col)d:%(code)s:%(text)s:https://lintlyci.github.io/Flake8Rules/rules/%(code)s.html'

那么问题是控制台或 PyCharm 输出窗口无法正确呈现链接。

幸运的是，我们可以使用插件 - 终端的 “Awesome Console” 和输出窗口的 “Console Link” 来做到这一点。

---

分步说明

1. 确保在当前 Python 环境中安装了 flake8
2. 安装“Awesome Console”插件：

• 转到 PyCharm Preferences -> Plugins -> Browser Repositories...
• 找到“Awesome Console”并安装（需要重启 PyCharm）：

1. 将“flake8”配置为 外部工具：

• 转到 PyCharm Preferences -> Tools -> External Tools -> "+"
• 配置路径 flake8 以及 $FilePath$ 要处理的所需目录/路径的占位符：

---

演示

现在，假设我们创建了这个 test.py 文件，但有一些违规行为：

 def f(a = 10):
  return a*10

如果我们右键单击 test.py 文件，选择 External Tools -> flake8 ，这是我们将要获得的输出（注意每个警告的可点击链接）：

现在，无论何时有疑问，我们都可以点击链接获取有关警告的更多详细信息。

这只是一种方法，很高兴听到是否有更简单或更好的方法来组合这些工具和项目。

原文由 alecxe 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

今天我也面临这个问题，尽管@alecxe 回答对一个项目设置有好处

如果你想全局设置 flake8 ，你可以按照下面的过程

1. 确保 flake8 安装在你的项目中
2. 确保在 pycharm 中设置了 virtualenv 路径
3. 将 flake8 配置为外部工具 goto file> settings> (Tools) > External Tools > ‘+’

配置路径

Program - flake8可执行文件的路径 \(PyInterpreterDirectory\) 是当前项目的Python解释器所在的目录

参数 - 指定应检查哪些文件和文件夹 \(FilePath\)

工作目录 - 项目根目录 \(ContentRoot\)

原文由 Somil 发布，翻译遵循 CC BY-SA 4.0 许可协议