NAME¶

twistedchecker - Twisted coding standard checker

SYNOPSIS¶

twistedchecker [options] module_or_package

DESCRIPTION¶

Checks Python source code for compliance with the Twisted coding standard.

OPTIONS¶

--version

show program's version number and exit

-h, --help

show this help message and exit

--long-help

more verbose help.

Master:

--diff=<result-file>

Set comparing result file to automatically generate a diff.

--pep8=<y_or_n>

Show pep8 warnings. [current: no]

--strict-epydoc=<y_or_n>

Check '@type' and '@rtype' in epydoc. [current: no]

--ignore=<file>[,<file>...]

Add files or directories to the blacklist. They should be base names, not paths. [current: CVS]

Messages control:

-e <msg ids>, --enable=<msg ids>

Enable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time.

-d <msg ids>, --disable=<msg ids>

Disable the message, report, category or checker with the given id(s). You can either give multiple identifier separated by comma (,) or put this option multiple time (only on the command line, not in the configuration file where it should appear only once).

Reports:

-f <format>, --output-format=<format>

Set the output format. Available formats are text, parseable, colorized, msvs (visual studio) and html [current: text]

-i <y_or_n>, --include-ids=<y_or_n>

Include message's id in output [current: yes]

-r <y_or_n>, --reports=<y_or_n>

Tells whether to display a full report or only the messages [current: no]