如何使用PyCharm运行Pylint

Question

我想在我的整个项目目录中将pylint配置为外部工具,用于我正在处理的python项目.我试图将存储库用作带有__init__.py和不带的模块,并且它无论如何都不起作用.

我在设置pylint以使用PyCharm时遇到困难.我知道我应该将它作为外部工具运行,但设置让我感到困惑.

他们的文档的权威来源被打破了,所以我也无法检查它.

Answer 1

您可以pylint按照以下步骤设置与PyCharm一起使用:

1. 安装pylint:

   $ pip install pylint
   

2. 找到您的pylint安装文件夹:

   $ which pylint         # MacOS/Linux
   /usr/local/bin/pylint  # this is just a possible output check yours
   

   $ where pylint         # Windows
   %LocalAppData%\Programs\Python\Python36-32\Scripts\pylint.exe  # possible location
   

3. 打开PyCharm设置窗口File -> Settings,然后导航到Tools -> External Tools侧栏.(或搜索" 外部工具 ")

   

4. 通过单击+号并相应填写字段来设置外部工具.在Program使用运行时获得的路径which pylint,对于其他值,您可以使用相同的图像.

   

5. pylint从Tools -> External Tools -> pylint:运行:

   

6. 在PyCharm终端中查看输出

   

有关更多详细信息,请参阅使用PyCharm进行Pylinting.

更新:

如果要用于pylint检查整个项目或特定文件或目录,可以右键单击项目根目录,文件或目录,然后External Tools -> pylint如下所示.

Answer 2

因为我没有找到可用的现成设置,所以这些是我在macOS上的PyCharm CE 2018.1中使用的设置:

1 - pip install pylint在您的项目virtualenv或全球

2 - 添加新的外部工具并配置:

Program: pylint
Arguments: "--msg-template='{abspath}:{line:5d},{column:2d}: {msg} ({symbol})'" --output-format=colorized "$FilePath$"
Working directory: $ProjectFileDir$
Output filters: $FILE_PATH$:\s*$LINE$\,\s*$COLUMN$:

注意msg-template所需的双引号,以及输出过滤器的转义字符.输出过滤器允许单击文件路径并在IDE源编辑器中打开该位置.

只有缺少的功能是输出过滤器将lint描述直接绘制到源视图中,就像使用内置linter一样.虽然此时没有这样的功能.

Answer 3

编辑:我现在使用并推荐当我第一次写这个答案时不存在的Pycharm插件.

一位同事在GitHub上向我指出了pylint-pycharm.它是pylint的包装器,输出格式为PyCharm.这是我如何设置它:

git clone https://github.com/perses76/pylint-pycharm.git
cd pylint-pycharm
python setup.py build

这创造了 build/scripts-2.7/pylint-pycharm

然后,在PyCharm中,使用以下设置创建一个新的外部工具:

Program: path to your installation of pylint-pycharm  
Arguments: --virtualenv=$PyInterpreterDirectory$/.. $FileName$
Working directory: $FileDir$ 
Output filters: $FILE_PATH$\:$LINE$\:$COLUMN$\:.*

现在从工具 - >外部工具 - > PyLintPyCharm运行它.每行输出将超链接到源代码中的相关位置.

Answer 4

您可以尝试以下Pylint PyCharm插件：

在PyCharm / IDEA中使用Pylint提供对Python文件的实时和按需扫描。

安装后，实时检查将自动进行。对于按需，您可以选择几个选项，从仅检查当前打开的文件到扫描整个项目：

（仅出于透明度考虑，我是开发人员）

Answer 5

关于以前答案的说明.我正在寻找一种让PyCharm知道输出语法的方法,这样我就可以直接跳转到文件位置了.无需使用其他工具即可使用.

可以使用msg-templatepylintrc文件或CLI选项中的选项将Pylint 配置为以特定格式输出消息--msg-template.

我把它设置为: msg-template='{abspath}:{line}:{column}: {msg_id} {msg}'

在"外部工具"设置中,Output filters:可以设置为 $FILE_PATH$:$LINE$:$COLUMN$: .* PyCharm显示直接跳转到报告位置的链接.这可以结合output-format=colorized使我得到这个: 尽管已配置了PyCharm,但它无法识别该列.但拥有文件和行对我来说已经足够了.