--- name: "pylint.python2.2" section: "1" platform: "linux" package: "python2.2-pylint" version: "0.6.4-1" release: "Debian 3.1 (Sarge)" platforms: ["linux"] url: "https://new.carta.tech/pylint.python2.2" --- # pylint.python2.2(1) python code static checker ## NAME **pylint** - python code static checker ## SYNOPSIS **pylint** \[ *OPTIONS* \] \[ *\* \] ## DESCRIPTION **pylint** is a Python source code analyzer which looks for programming errors, helps enforcing a coding standard and sniffs for some code smells (as defined in Martin Fowler's Refactoring book) Pylint can be seen as another PyChecker since nearly all tests you can do with PyChecker can also be done with Pylint. However, Pylint offers some more features, like checking length of lines of code, checking if variable names are well-formed according to your coding standard, or checking if declared interfaces are truly implemented, and much more. Additionally, it is possible to write plugins to add your own checks. ## OPTIONS - \--version show program's version number and exit - \--help, -h show this help message and exit ## MASTER lint Python modules using external checkers. This is the main checker controling the other ones and the reports \ generation. It is itself both a raw checker and an astng checker in order \ to: \ \* handle message activation / deactivation at the module level \ \* handle some basic but necessary stats'data (number of classes, methods...) This checker also defines the following reports: \ \* R0001: Total errors / warnings \ \* R0002: % errors / warnings by module \ \* R0003: Messages \ \* R0004: Global evaluation - \--rcfile=\ Specify a configuration file. - \--zope Initialize Zope products before starting. - \--disable-all Disable all possible checkers. This option should precede enable-\* options. - \--help-msg=\ Display a help message for the given message id and exit. This option may be a comma separated list. - \--list-msgs List and explain every available messages. - \--generate-rcfile Generate a sample configuration file according to the current configuration. You can put other options before this one to use them in the configuration. This option causes the program to exit - \--generate-man Generate a man page for pylint. This option causes the program to exit - \--profile Profiled execution. - \--ignore=\ Add \ to the black list. It should be a base name, not a path. You may set this option multiple times. - \--persistent=\ Pickle collected data for later comparisons. - \--cache-size=\ Set the cache size for astng objects. ## REPORTS Options related to messages / statistics reporting - \--reports=\ Tells wether to display a full report or only the messages - \--html=\ Use HTML as output format instead of text - \--parseable=\ Use a parseable text output format, so your favorite text editor will be able to jump to the line corresponding to a message. - \--color=\ Colorizes text output using ansi escape codes - \--files-output=\ Put messages in a separate file for each module / package specified on the command line instead of printing them on stdout. Reports (if any) will be written in a file name "pylint\_global.\[txt\|html\]". - \--evaluation=\ Python expression which should return a note less than 10 (10 is the highest note).You have access to the variables errors warning, statement which respectivly contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (R0004). - \--comment=\ Add a comment according to your evaluation note. This is used by the global evaluation report (R0004). - \--include-ids=\ Include message's id in output - \--enable-msg-cat=\ Enable all messages in the listed categories. - \--disable-msg-cat=\ Disable all messages in the listed categories. - \--enable-msg=\ Enable the message with the given id. - \--disable-msg=\ Disable the message with the given id. - \--enable-report=\ Enable the report with the given id. - \--disable-report=\ Disable the report with the given id. ## VARIABLES checks for \ \* unused variables / imports \ \* undefined variables \ \* redefinition of variable from builtins or from an outer scope \ \* use of variable before assigment - \--enable-variables=\ Enable / disable this checker - \--init-import=\ Tells wether we should check for unused import in \_\_init\_\_ files. - \--dummy-variables=\ List of variable names used for dummy variables (i.e. not used). ## DESIGN checks for sign of poor/misdesign: \ \* number of methods, attributes, local variables... \ \* size, complexity of functions, methods - \--enable-design=\ Enable / disable this checker - \--max-args=\ Maximum number of arguments for function / method - \--max-locals=\ Maximum number of locals for function / method body - \--max-returns=\ Maximum number of return / yield for function / method body - \--max-branchs=\ Maximum number of branch for function / method body - \--max-statements=\ Maximum number of statements in function / method body - \--max-parents=\ Maximum number of parents for a class (see R0901). - \--max-attributes=\ Maximum number of attributes for a class (see R0902). - \--min-public-methods=\ Minimum number of public methods for a class (see R0903). - \--max-public-methods=\ Maximum number of public methods for a class (see R0904). ## EXCEPTIONS checks for \ \* excepts without exception filter \ \* string exceptions - \--enable-exceptions=\ Enable / disable this checker ## METRICS does not check anything but gives some raw metrics : \ \* total number of lines \ \* total number of code lines \ \* total number of docstring lines \ \* total number of comments lines \ \* total number of empty lines This checker also defines the following reports: \ \* R0701: Raw metrics - \--enable-metrics=\ Enable / disable this checker ## SIMILARITIES checks for similarities and duplicated code. This computation may be\ memory / CPU intensive, so you should disable it if you experiments some\ problems. This checker also defines the following reports: \ \* R0801: Duplication - \--enable-similarities=\ Enable / disable this checker - \--min-similarity-lines=\ Minimum lines number of a similarity. - \--ignore-comments=\ Ignore comments when computing similarities. ## MISCELLANEOUS checks for: \ \* warning notes in the code like FIXME, XXX \ \* PEP 263: source code with non ascii character but no encoding declaration - \--enable-miscellaneous=\ Enable / disable this checker - \--notes=\ List of note tags to take in consideration, separated by a comma. Default to FIXME, XXX, TODO ## IMPORTS checks for \ \* external modules dependencies \ \* relative / wildcard imports \ \* cyclic imports \ \* uses of deprecated modules This checker also defines the following reports: \ \* R0401: External dependencies \ \* R0402: Modules dependencies graph - \--enable-imports=\ Enable / disable this checker - \--deprecated-modules=\ Deprecated modules which should not be used, separated by a comma - \--import-graph=\ Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled) - \--ext-import-graph=\ Create a graph of external dependencies in the given file (report R0402 must not be disabled) - \--int-import-graph=\ Create a graph of internal dependencies in the given file (report R0402 must not be disabled) ## FORMAT checks for : \ \* unauthorized constructions \ \* strict indentation \ \* line length \ \* use of \<\> instead of != - \--enable-format=\ Enable / disable this checker - \--max-line-length=\ Maximum number of characters on a single line. - \--max-module-lines=\ Maximum number of lines in a module - \--indent-string=\ String used as indentation unit. This is usually " " (4 spaces) or " " (1 tab). ## BASIC checks for : \ \* doc strings \ \* modules / classes / functions / methods / arguments / variables name \ \* number of arguments, local variables, branchs, returns and statements in functions, methods \ \* required module attributes \ \* dangerous default values as arguments \ \* redefinition of function / method / class \ \* uses of the global statement This checker also defines the following reports: \ \* R0101: Statistics by type - \--enable-basic=\ Enable / disable this checker - \--required-attributes=\ Required attributes for module, separated by a comma - \--no-docstring-rgx=\ Regular expression which should only match functions or classes name which do not require a docstring - \--min-name-length=\ Minimal length for module / class / function / method / argument / variable names - \--module-rgx=\ Regular expression which should only match correct module names - \--class-rgx=\ Regular expression which should only match correct class names - \--function-rgx=\ Regular expression which should only match correct function names - \--method-rgx=\ Regular expression which should only match correct method names - \--argument-rgx=\ Regular expression which should only match correct argument names - \--variable-rgx=\ Regular expression which should only match correct variable names - \--good-names=\ Good variable names which should always be accepted, separated by a comma - \--bad-names=\ Bad variable names which should always be refused, separated by a comma - \--bad-functions=\ List of builtins function names that should not be used, separated by a comma ## CLASSES checks for : \ \* methods without self as first argument \ \* overriden methods signature \ \* access only to existant members via self \ \* attributes not defined in the \_\_init\_\_ method \ \* supported interfaces implementation \ \* unreachable code - \--enable-classes=\ Enable / disable this checker - \--ignore-iface-methods=\ List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. - \--ignore-mixin-members=\ Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). ## ENVIRONMENT VARIABLES The following environment variables are used : \ \* PYLINTHOME \ path to the directory where data of persistent run will be stored. If not found, it defaults to ~/.pylint.d/ or .pylint.d (in the current working directory) . The current PYLINTHOME is /home/syt/.pylint.d. \ \* PYLINTRC \ path to the configuration file. If not found, it will use the first existant file in ~/.pylintrc, /etc/pylintrc. The current PYLINTRC is None. ## 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 much probably bugs in the code \ \* (F) fatal, if an error occured which prevented pylint from doing further processing. ## SEE ALSO /usr/share/doc/pythonX.Y-pylint/ ## COPYRIGHT Copyright (c) 2003-2005 Sylvain Thenault (thenault@gmail.com). Copyright (c) 2003-2005 LOGILAB S.A. (Paris, FRANCE). http://www.logilab.fr/ -- mailto:contact@logilab.fr This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. ## BUGS Please report bugs on the project's mailing list: mailto://python-projects@logilab.org ## AUTHOR Sylvain Thenault \