PyCharm 中使用 Pylint 控制 python 代码质量

Eins

简介

本文主要介绍pylint的配置与使用,如何安装请参考pylint安装,详细信息可参考pylint官方网站的帮助文档Pylint User Manual。

获取帮助信息

pylint安装成功后,可以通过运行"pylint --help"来快速查看pylint的帮助信息;相关信息基本能够支撑起快速使用起来pylint的基本功能。

[plain]  view plain  copy
  1. bob@Ubuntu:~$ pylint --help  
  2. No config file found, using default configuration  
  3. Usage:  pylint [options] module_or_package  
  4.   
  5.   Check that a module satisfies a coding standard (and more !).  
  6.   
  7.     pylint --help  
  8.   
  9.   Display this help message and exit.  
  10.   
  11.     pylint --help-msg [,]  
  12.   
  13.   Display help messages about given message identifiers and exit.  
  14.   
  15.   
  16. Options:  
  17.   --version             show program's version number and exit  
  18.   -h, --help            show this help message and exit  
  19.   --long-help           more verbose help.  
  20.   
  21.   Master:  
  22.     --rcfile=     Specify a configuration file.  
  23.     -E, --errors-only   In error mode, checkers without error messages are  
  24.                         disabled and for others, only the ERROR messages are  
  25.                         displayed, and no reports are done by default  
  26.     --ignore=[,...]  
  27.                         Add files or directories to the blacklist. They should  
  28.                         be base names, not paths. [current: CVS]  
  29.   
  30.   Commands:  
  31.     --help-msg=  
  32.                         Display a help message for the given message id and  
  33.                         exit. The value may be a comma separated list of  
  34.                         message ids.  
  35.     --generate-rcfile   Generate a sample configuration file according to the  
  36.                         current configuration. You can put other options  
  37.                         before this one to get them in the generated  
  38.                         configuration.  
  39.   
  40.   Messages control:  
  41.     -e , --enable=  
  42.                         Enable the message, report, category or checker with  
  43.                         the given id(s). You can either give multiple  
  44.                         identifier separated by comma (,) or put this option  
  45.                         multiple time. See also the "--disable" option for  
  46.                         examples.  
  47.     -d , --disable=  
  48.                         Disable the message, report, category or checker with  
  49.                         the given id(s). You can either give multiple  
  50.                         identifiers separated by comma (,) or put this option  
  51.                         multiple times (only on the command line, not in the  
  52.                         configuration file where it should appear only  
  53.                         once).You can also use "--disable=all" to disable  
  54.                         everything first and then reenable specific checks.  
  55.                         For example, if you want to run only the similarities  
  56.                         checker, you can use "--disable=all  
  57.                         --enable=similarities". If you want to run only the  
  58.                         classes checker, but have no Warning level messages  
  59.                         displayed, use"--disable=all --enable=classes  
  60.                         --disable=W"  
  61.   
  62.   Reports:  
  63.     -f , --output-format=  
  64.                         Set the output format. Available formats are text,  
  65.                         parseable, colorized, msvs (visual studio) and html.  
  66.                         You can also give a reporter class, eg  
  67.                         mypackage.mymodule.MyReporterClass. [current: text]  
  68.     -r , --reports=  
  69.                         Tells whether to display a full report or only the  
  70.                         messages [current: yes]  
  71.     --msg-template=