Pylint使用教程

最新推荐文章于 2024-10-18 15:49:18 发布
最新推荐文章于 2024-10-18 15:49:18 发布
阅读量762 收藏 1
点赞数 2
分类专栏： python编程入门 文章标签： python 测试工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wangrui0306/article/details/134222389
版权

  一、导言

                                                                                   ..;fxxx?.
                                                                                .^1xf;.  .fn.
                                                                               .jx:.      .r.
                                                                             .fj '       .?n.
                                                                            'f) .     ..trf`.
                         .'.'                                              >x.      !xn} .
                        :r';"                                             }j     .`x)'
             .       ..rx ..j.                                          .)x..   .fx`.
          .rux.    . fn.  ..n`                                          .x` .  .jf
          .n.tj..  .f{.    .x.                                        .'x^    'ff.
          /j. nurc1-..     ./f/ .                                      :r.    :r.
          fl.zcJJJJY        ...!j1                                    .j!    .x..
          fczJJJJJJU           . in~.                                 .x..  .\j
        . xXJJYCJUJC              .fx.                               .>j   .'n.
        .jYJJCli!?!i..             .jr.                              .xj  ..rj.
       ./XJJJJi!!!!i!               .jf'                             .n'   .x'
       'cJJJJLi!!!!i.                'n^.                            .x.   jt.
       tzJJU!!!!!i!.                  'tjf(.   '.^)jrrrrx|; .       'x'. .;n.
      'nYJJQii`iii                      .`|..nnzzzJCJUUJJU[rnux/ ..lr".  ln .
      .nJJL.     l.                     .j<zcJJJJUJJJJJJC!!!!iilnv\    .\n..
       nn`      ,vr.                  ../tYJJJJJJJJJililli!!!!!!i>jf...nj .
      .n.      .jn.                   ..}.YCJJUCJCJ!!!!!!!!!!!!!!!!I'zx .
       xl.       ..                  .'t...i!!!tJJ!!!!!!!!!!!!!!!!!!..fj..
      .x\.'      `)(+. . .            f   .i!!!i .!!!!!!!!!!i:.i!!!!  . x^.
      .j .j        ;<; ..           .t" .  .. .' ..`i'!;"'.^'  .'l;...   x~.
     .j...t.       '    ..       .../                                   ..x'.
      /f..-        .`t..         .).      日期: 20231025                  ,r.
      .xj             .-       '..                                        'x
       . xj..                                                              j.
          'txxj~ ^.                                                     ...?xrrr`'
             .'.`ff/..            二狗大爷出品  MEOW!              ..   .!!!!!,.`jt.
                 .^|f'.                                         .UJJJJc!!!!!!i. .fr..
                 .t' x:.                                       .UJJJJJ!i!!!!!!I  . xr.
              .'f[.  .j\.....                                   JJJJJJJ!X>!!!i.    .^fx..
             .,r      .:j!/.          '..                   .../\YJJJJJJJCv!l'....     f.
           . j).       .<r           ./t^              . .!rvxf. ixzcXXYUYzcr^>xncx}'.?j.
          .)r.        .vt'         .~n-..... ."~\jjxnxxxxfI'      .. .  .  .    .'. I?;.
         .xI.     .')nX,.        ',xj...'l_]_<".....
       `j/ .   ..<rxrr..       ..nr.
     .\j..   ..jrl\n..       .>xj.'
   \jf.    .jnj..j\'.     ../xf'.
   t'. '.]xn. `rx        .xn-.
   .{^+tj.. .rx'     ..tnx...
          /f'..    '{xj
          "jl.  .~jj..
           ..)))"..

Pylint是一个Python源代码静态分析工具，用于检查Python代码的质量、风格和错误。它可以帮助开发者识别潜在的问题并提供代码改进建议。本文是Pylint的工具说明，包括工具说明、安装方法、使用示例和注意事项。

  Pylint是一个开源工具，它执行静态代码分析，检查Python代码的一致性、规范性和错误。它使用不同的插件和规则来评估代码，并生成相应的分数和建议，以改善代码质量。

  三、安装和配置

  有四种安装方式

  3.1 作为命令行工具

  使用pip安装Pylint（确保你已经安装了Python）：

pip install pylint

  使用conda或apt 

sudo apt-get install pylint
conda install pylint

  3.2 编辑器或IDE集成（见专栏文章后续更新）

  3.3 预提交集成工具

  配置文件 .pre-commit-config.yaml

- repo: local  
  hooks:    
  - id: pylint      
    name: pylint      
    entry: pylint      
    language: system      
    types: [python]      
    args:  ["-rn", # Only display messages         
            "-sn", # Don't display the score         
            "--rcfile=pylintrc", # Link to your config file        
            "--load-plugins=pylint.extensions.docparams", # Load an extension      
          ]

  3.4 多版本解释器集成

  即可使用不同版本的解释器来相互检查，例如python3.8和pylint来检查python3.5版本的代码

  四、主要功能和用法

  4.1 开始

  help 参数来查看可用参数的概念:

pylint --help

Commands:
    --help-msg=<msg-id>
    --generate-toml-config
Messages 
control:
    --disable=<msg-ids>
Reports:
    --reports=<y or n>
    --output-format=<format>

  Long-help 参数查看更多细节

pylint --long-help

Output:
   Using the default text output, the message format is :
  MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
  There are 5 kind of message types :
  * (C) convention, for programming standard violation
  * (R) refactor, for bad code smell
  * (W) warning, for python specific problems
  * (E) error, for probable bugs in the code
  * (F) fatal, if an error occurred which prevented pylint from doing
  further processing.

  4.2 用法

  用法：在终端或命令提示符中运行 Pylint，将 your_python_file.py 替换为你要检查的 Python 文件的路径

pylint your_python_file.py

  同时，上述路径可以使用以下所有目标进行替换

  1. path：relative path to the file

  2. abspath：absolute path to the file

  3. line：line number

  4. column：column number

  5. end_line：line number of the end of the node

  6. end_column：column number of the end of the node

  7. module：module name

  8. obj：object within the module (if any)

  9. msg：text of the message

  10. msg_id：the message code (eg. I0011)

  11. symbol：symbolic name of the message (eg. locally-disabled)

  12. C：one letter indication of the message category

  13. category：fullname of the message category

  4.3 退出代码；程式终止码

exit code

meaning

0

no error

1

fatal message issued

2

error message issued

4

warning message issued

8

refactor message issued

16

convention message issued

32

usage error

  4.4 报错检索

  https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html

  五、实践案例和代码示例

  假设使用pylint检查的脚本文件代码名为 simpleecesar.py，代码内容如下:

#!/usr/bin/env python3
import string
shift = 3
choice = input("would you like to encode or decode?")
word = input("Please enter text")
letters = string.ascii_letters + string.punctuation + string.digits
encoded = ""
if choice == "encode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) + shift
            encoded = encoded + letters[x]
if choice == "decode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) - shift
            encoded = encoded + letters[x]
print(encoded)

终端返回如下：

tutor Desktop$ pylint simplecaesar.py
************* Module simplecaesarsimplecaesar.py:1:0: C0114: Missing module docstring (missing-module-docstring)
simplecaesar.py:5:0: C0103: Constant name "shift" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:8:0: C0103: Constant name "letters" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:9:0: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:13:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:15:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:16:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:20:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:22:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:23:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)-----------------------------------Your code has been rated at 4.74/10

  其中

"simplecaesar.py:1:0: C0114: Missing module docstring (missing-module-docstring)"

  表示，被检查的脚本缺少docstring内容，即脚本说明内容，补充更新该代码后如下

#!/usr/bin/env python3

"""This script prompts a user to enter a message to encode or decodeusing a classic Caesar shift substitution (3 letter shift)"""

import string
shift = 3
choice = input("would you like to encode or decode?")
word = input("Please enter text")
letters = string.ascii_letters + string.punctuation + string.digits
encoded = ""

if choice == "encode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) + shift
            encoded = encoded + letters[x]
if choice == "decode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) - shift
            encoded = encoded + letters[x]

print(encoded)

再次运行pylint simplecaesar.py后

tutor Desktop$ pylint simplecaesar.py
************* Module simplecaesar
simplecaesar.py:8:0: C0103: Constant name "shift" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:11:0: C0103: Constant name "letters" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:12:0: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:16:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:18:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:19:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:23:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)simplecaesar.py:25:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:26:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)------------------------------------------------------------------Your code has been rated at 5.26/10 (previous run: 4.74/10, +0.53)

  漂亮！Pylint 告诉我们，自上次运行以来，我们的代码评级有了多大的提高，现在只剩下无效名称消息了。

  对于实例变量、函数、类等等的命名，有相当明确的约定。约定的重点是使用大写和小写，以及在名称中分隔多个单词的字符。这很适合通过正则表达式进行检查，因此应该匹配(([ A-Z _ ][ A-Z1-9 _ ] ) | (_ 。( _)) $.

  在这种情况下，Pylint 告诉我们，这些变量似乎是常量，应该都是大写。这是一个从一开始就与 Pylint 共存的内部约定。您也可以创建自己的内部命名约定，但为了本教程的目的，我们希望坚持 PEP 8标准。在这种情况下，我们声明的变量应该遵循所有小写字母的约定。适当的规则类似于: “应该匹配[ a-z _ ][ a-z0-9 _ ]{2,30} $”。注意正则表达式中的小写字母(A-Z 与 A-Z)。

  六、注意事项

  • Pylint 的检查结果包括了对代码风格、规范性和潜在问题的检查，但不一定意味着所有输出都需要立即处理。有些问题可能并不重要，你可以根据项目需求和团队规则来决定哪些问题需要处理。

  • 你可以使用 Pylint 配置文件来自定义检查规则和忽略特定的检查。这有助于将 Pylint 集成到项目中，并确保符合团队的代码规范。

  • Pylint 提供了广泛的命令行选项和配置选项，你可以使用 pylint --generate-rcfile 生成一个示例配置文件，然后进行自定义设置。

  • 可以在集成开发环境（IDE）中安装 Pylint 插件，以便在编写代码时实时检查问题。

 

  七、结论

  Pylint 是一个有用的工具，可以帮助你提高 Python 代码的质量和一致性，但在使用时需要根据项目需求和团队规则来决定如何处理检查结果。

  参考文档

  https://pylint.pycqa.org/en/latest/tutorial.html

pylint在pycharm的使用及pylint的配置
weixin_30314631的博客
08-12 3044
pylint作为python代码风格检查工具，接近 PEP8风格，在使用此方法的过程中，发现不仅能让代码更加规范，优雅，更能 发现 隐藏的bug。 pylint在Pycharm中的2种安装方式； 第一种效果展示（优点：通过点击错误点，自动定位到文件位置，省时）： 安装步骤在：https://github.com/leinardi/pylint-pycharm中; 我的...
Pylint安装包
12-02
Pylint安装包(包含logilab-astng、logilab-common和pylint-0.25.0)
python中pylint使用方法(pylint代码检查)
09-20
Pylint 提供了简单的方式来分析 Python 代码，其高可配置性很容易使一个部门的人员使用统一的代码风格。 本文将通过理论介绍和示例分析阐述如何 Pylint 来规范 Python 代码
Pylint 使用教程
gitblog_01186的博客
08-07 542
Pylint 使用教程 pylintIt's not just a linter that annoys you!项目地址:https://gitcode.com/gh_mirrors/py/pylint 项目介绍 Pylint 是一个静态代码分析工具，用于检查 Python 代码中的错误、执行编码标准、查找代码异味，并提供代码重构的建议。Pylint 支持 Python 3.8 及以上版本，并...
代码分析工具python_Python代码分析工具Pylint使用教程
weixin_39523280的博客
12-17 627
什么是PylintPylint是一个Python代码分析工具，它分析Python代码中的错误，查找不符合代码风格标准(Pylint默认使用的代码风格是PEP8)和有潜在问题的代码。目前Pylint的最新版本是1.8.2。Pylint 是一个 Python 工具，除了平常代码分析工具的作用之外，它提供了更多的功能：如检查一行代码的长度，变量名是否符合命名标准，一个声明过的接口是否被真正实现等等。Py...
Python代码扫描：提升Python代码质量的神器-pylint详解与使用指南
SteveRocket's-Blog
09-14 2783
Python作为一种简单易学且功能强大的编程语言，吸引了越来越多的我们。然而，由于Python的灵活性和宽松的语法规则，代码质量的控制成为一个挑战。为了解决这个问题，我将介绍一个受欢迎的工具-pylint，它可以帮助我们提升Python代码的质量。
配置Sublime Text 3以使用pylint插件教程
在使用Sublime Text 3配置Python开发环境时，确保代码质量的一个关键步骤是正确配置Pylint插件。Pylint是一个广泛使用的Python代码静态分析工具，它可以检查Python代码中的错误，帮助开发者强制执行代码风格，发现...
工具pylint
05-17
pylint 的功能简介：pylint 是一个 Python 代码分析工具，分析 Python 代码中的错误，查找不符合代码风格标准（默认使用 PEP8）和有潜在问题的代码。pylint 提供了更多的功能，如检查一行代码的长度，变量名是否符合...
使用pycharm和pylint检查python代码规范操作
09-16
- **安装步骤**：访问[官方GitHub仓库](https://github.com/leinardi/pylint-pycharm)获取详细安装教程。 - **使用方法**：单个文件检查时，先点击文件内容，然后点击绿色开始箭头即可启动Pylint检查；也可以检查...
Python游戏开发教程：PyGame引擎与pylint编码规范
通过使用pylint，开发者可以确保代码遵循特定的编码规范，比如PEP 8（Python Enhancement Proposal 8）。 7. 开发环境的配置 在开始实际的游戏开发之前，还需要配置一个合适的开发环境。这可能包括选择合适的文本...
python中pylint使用方法（pylint代码检查）
Hello World!
08-17 1万+
在Eclipse IDE 下， 打开 Window->Preferences... 对话框，从右侧的树形列表中选择“ PyDev”->“Interpreter Python”， 点击New按钮，从Python的安装路径下选择Python.exe，然后会弹出一个对话框让你勾选System PYTHONPATH，我是都选了，应该无所谓。最后点Ok，退出。 一、进行Django项目的开发配置
pylint的安装
Bob Liu的程序人生
02-05 1万+
本文介绍了在Ubuntu 9和Python 2.6开发环境下，如何安装pylint工具；并简单介绍pylint与Eclipse+PyDev开发环境的集成。
Python pylint的安装和使用
热门推荐
DarrenXf的专栏
10-08 2万+
什么是pylint？ Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准和有潜在问题的代码。 Pylint 是一个 Python 工具，除了平常代码分析工具的作用之外，它提供了更多的功能：如检查一行代码的长度，变量名是否符合命名标准，一个声明过的接口是否被真正实现等等。 Pylint 的一个很大的好处是它的高可配置性，高可定制性，并且可以很...
pylint使用
qq_39842253的博客
04-28 439
pylint使用 在pycharm安装pylint pip install pylint pylint -r [name] -r <y_or_n>, --reports=<y_or_n> 默认是 y, 表示 Pylint 的输出中除了包含源代码分析部分，也包含报告部分。
Python代码的静态分析工具-Pylint
最新发布
captain
10-18 719
此外，Pylint还能够识别一些常见的安全问题，并将它们归类为CWE（Common Weakness Enumeration），提醒开发者潜在的安全隐患。Pylint利用多种静态代码分析技术检查Python源代码中的问题，旨在指出代码中的错误、警告以及不符合编码规范的地方，从而提高代码质量和维护性。它能够检测出代码中的语法错误、类型错误、逻辑错误，还能够识别不符合代码风格规范的地方以及潜在的编程问题。根据Pylint生成的报告，查看代码中的错误、警告和风格问题，并逐一进行修复。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值