pylint的配置和使用

最新推荐文章于 2024-10-18 15:49:18 发布

robot527

最新推荐文章于 2024-10-18 15:49:18 发布

阅读量1.7w

点赞数 1

分类专栏： python 文章标签： pylint python

本文链接：https://blog.youkuaiyun.com/u013687821/article/details/51127070

版权

python 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了pylint的配置和使用，包括安装、配置文件模板、消息格式定制、命名规则以及如何关闭告警消息。通过设置output-format为colorized和reports为no，可以实现彩色输出和简洁报告。此外，还展示了如何在代码中和配置文件中禁用特定警告。添加命令别名后，可以方便地检测代码质量。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pylint的安装很简单，就不再赘述了。

使用命令

pylint --generate-rcfile  > pylint.conf

生成一个配置文件模板，然后可以根据这个模板作个性化修改以适应具体项目的需求。

配置文件的模板参见pylint.conf 。

修改部分说明：

disable=I0011

禁止 locally-disabled 类型的消息输出。

output-format=colorized

配置输出着色。

reports=no

不显示完整的报告，只显示消息。

const-rgx=[a-z_][a-z0-9_]{2,30}$

配置模块级别的常量和变量的命名规则（以小写字母或下划线开头后续跟着小写字母或数字或下划线，2到30个字符）。

good-names=i,j,k,n,ex,Run,_

添加一个总是接受的命名 “n”。

最新版的pylint已经废弃 --include-ids=<y_or_n>, -i <y_or_n> 选项，可在配置文件里修改输出消息的格式：

msg-template='{msg_id}:{line:3d}, {column}: {msg} ({symbol})'

使用效果如下图：

在代码中关闭某个告警消息：

模块级别：

#! usr/bin/python
#pylint: disable=invalid-name

''' Docstring... '''

行级别：

def file_travesal(dirtectory='.', file_list=[]): # pylint: disable=W0102
    '''
    Get file list from the directory including files in its subdirectories.
    '''
    file_list += [join(dirtectory, f) for f in listdir(dirtectory)
                if isfile(join(dirtectory, f))]
    for item in listdir(dirtectory):
        if isdir(join(dirtectory, item)):
            file_travesal(join(dirtectory, item), file_list)

使用命令 pylint --help 或 man pylint 查看更详细的用法。

添加命令别名（配置文件在用户目录“~/”下）：

echo "alias pylt='pylint --rcfile=~/pylint.conf'" >> ~/.bashrc

再新开终端窗口可使用命令 pylt /path/to/example.py 检测代码。

参考：

Pylint User Manual