4812N/A
4812N/APylint output
4812N/A*************
4812N/A
4812N/AThe default format for the output is raw text. You can change this by
4812N/Apassing pylint the "--output-format=<value>" option. Possible values
4812N/Aare: parseable, colorized, msvs (visual studio) and html.
4812N/A
4812N/AMoreover you can customize the exact way information are displayed
4812N/Ausing the *--msg-template=<format string>* option. The *format string*
4812N/Auses the Python new format syntax and the following fields are
4812N/Aavailable :
4812N/A
4812N/Apath
4812N/A relative path to the file
4812N/A
4812N/Aabspath
4812N/A absolute path to the file
4812N/A
4812N/Aline
4812N/A line number
4812N/A
4812N/Acolumn
4812N/A column number
4812N/A
4812N/Amodule
4812N/A module name
4812N/A
4812N/Aobj
4812N/A object within the module (if any)
4812N/A
4812N/Amsg
4812N/A text of the message
4812N/A
4812N/Amsg_id
4812N/A the message code (eg. I0011)
4812N/A
4812N/Asymbol
4812N/A symbolic name of the message (eg. locally-disabled)
4812N/A
4812N/AC
4812N/A one letter indication of the message category
4812N/A
4812N/Acategory
4812N/A fullname of the message category
4812N/A
4812N/AFor example, the former (pre 1.0) default format can be obtained with:
4812N/A
4812N/A pylint --msg-template='{msg_id}:{line:3d},{column}: {obj}: {msg}'
4812N/A
4812N/AA few other examples:
4812N/A
4812N/A* the new default format:
4812N/A
4812N/A {C}:{line:3d},{column:2d}: {msg} ({symbol})
4812N/A
4812N/A* Visual Studio compatible format (former 'msvs' output format):
4812N/A
4812N/A {path}({line}): [{msg_id}{obj}] {msg}
4812N/A
4812N/A* Parseable (Emacs and all, former 'parseable' output format)
4812N/A format:
4812N/A
4812N/A {path}:{line}: [{msg_id}({symbol}), {obj}] {msg}
4812N/A
4812N/A* HTML output (Default for the html output format) format:
4812N/A
4812N/A '{category}{module}{obj}{line}{column}{msg}'
4812N/A
4812N/A
4812N/ASource code analysis section
4812N/A============================
4812N/A
4812N/AFor each python module, Pylint will first display a few '*' characters
4812N/Afollowed by the name of the module. Then, a number of messages with
4812N/Athe following format:
4812N/A
4812N/A MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
4812N/A
4812N/AYou can get another output format, useful since it's recognized by
4812N/Amost editors or other development tools using the "--output-
4812N/Aformat=parseable" option.
4812N/A
4812N/AThe message type can be:
4812N/A
4812N/A * [R]efactor for a "good practice" metric violation
4812N/A
4812N/A * [C]onvention for coding standard violation
4812N/A
4812N/A * [W]arning for stylistic problems, or minor programming issues
4812N/A
4812N/A * [E]rror for important programming issues (i.e. most probably
4812N/A bug)
4812N/A
4812N/A * [F]atal for errors which prevented further processing
4812N/A
4812N/ASometimes the line of code which caused the error is displayed with a
4812N/Acaret pointing to the error. This may be generalized in future
4812N/Aversions of Pylint.
4812N/A
4812N/AExample (extracted from a run of Pylint on itself...):
4812N/A
4812N/A ************* Module pylint.checkers.format
4812N/A W: 50: Too long line (86/80)
4812N/A W:108: Operator not followed by a space
4812N/A print >>sys.stderr, 'Unable to match %r', line
4812N/A ^
4812N/A W:141: Too long line (81/80)
4812N/A W: 74:searchall: Unreachable code
4812N/A W:171:FormatChecker.process_tokens: Redefining built-in (type)
4812N/A W:150:FormatChecker.process_tokens: Too many local variables (20/15)
4812N/A W:150:FormatChecker.process_tokens: Too many branches (13/12)
4812N/A
4812N/A
4812N/AReports section
4812N/A===============
4812N/A
4812N/AFollowing the analysis message, Pylint will display a set of reports,
4812N/Aeach one focusing on a particular aspect of the project, such as
4812N/Anumber of messages by categories, modules dependencies...
4812N/A
4812N/AFor instance, the metrics report displays summaries gathered from the
4812N/Acurrent run.
4812N/A
4812N/A * the number of processed modules
4812N/A
4812N/A * for each module, the percentage of errors and warnings
4812N/A
4812N/A * the total number of errors and warnings
4812N/A
4812N/A * percentage of classes, functions and modules with docstrings,
4812N/A and a comparison from the previous run
4812N/A
4812N/A * percentage of classes, functions and modules with correct name
4812N/A (according to the coding standard), and a comparison from the
4812N/A previous run
4812N/A
4812N/A * a list of external dependencies found in the code, and where
4812N/A they appear
4812N/A
4812N/AAlso, a global evaluation for the code is computed.