Python語言規范之Pylint的使用

1、Pylint是什么

pylint是一個Python源代碼中查找bug的工具，能找出錯誤，和代碼規范的運行。也就是你的代碼有Error錯誤的時候能找出來錯誤，沒有錯誤的時候，能根據Python代碼規范給你建議修改代碼，讓代碼變更美觀。

 

2、安裝pylint

 pip3 install pylint

 

3、查找pylint的安裝地址

$ which pylint
/Library/Frameworks/Python.framework/Versions/3.9/bin/pylint

 

4、Pycharm使用Pylint工具

 

1）Pycharm --> Preferences --> Tools --> External Tools --> + 

 

 

Program：pylint的地址，可以通過which pylint找到地址

Arguments：pylint運行的參數

 

2）使用

 

 

 

3）得到的結果

 

************* Module 704
leetcode/704.py:28:0: C0305: Trailing newlines (trailing-newlines)         #文尾有多余的行
leetcode/704.py:1:0: C0114: Missing module docstring (missing-module-docstring)  # 腳本首行沒有添加注釋
leetcode/704.py:4:11: W0621: Redefining name 'nums' from outer scope (line 23) (redefined-outer-name)  #變量名字與函數參數名字不能一樣
leetcode/704.py:4:28: W0621: Redefining name 'target' from outer scope (line 24) (redefined-outer-name) #變量名字與函數參數名字不能一樣
leetcode/704.py:4:0: C0116: Missing function or method docstring (missing-function-docstring)  #函數缺少注釋，注釋要放在函數的第一行而不是def的上面

 

5、pylint的5種信息類型

 

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.

 

* (C) 約定，用於違反編程標准

* (R) 重構，針對糟糕的代碼味道

* (W) 警告，針對 python 特定問題

* (E) 錯誤，用於代碼中可能的錯誤

* (F) 致命的，如果發生錯誤導致 pylint 無法進行進一步處理。

 

6、更多的pylint信息

 

1）可以通過命令行獲取

 

pylint --list-msgs

 

2）官網

http://pylint.pycqa.org/en/latest/#