pep81
A tool to check your python code against some of the style conventions in pep 8.
Usage
pep8 [options]
input ...
Options
-
--version -
show program's version number and exit
-
-h, --help -
show this help message and exit
-
-v, --verbose -
print status messages, or debug with
-vv
-
-q, --quiet -
report only file names, or nothing with
-qq
-
--exclude=patterns -
exclude files or directories which match these comma separated patterns (default: .svn,CVS,.bzr,.hg,.git,__pycache__)
-
--filename=patterns -
when parsing directories, only check filenames matching these comma separated patterns (default: *.py)
-
--select=errors -
select errors and warning (e.g. E,W6)
-
--ignore=errors -
skip errors and warnings (e.g. E4,W)
-
--first -
show first occurrence of each error
-
-r, --repeat -
(obsolete) show all occurrences of the same error
-
--show-source -
show source code for each error
-
--show-pep8 -
show text of PEP 8 for each error (implies --first)
-
--statistics -
count errors and warnings
-
--count -
print total number of errors and warnings to standard error and set exit code to 1 if total is not null
-
--max-line-length=n -
set maximum allowed line length (default: 79)
-
--hang-closing -
hang closing bracket instead of matching indentation of opening bracket's line
-
--format=format -
set the error format [default|pylint|<custom>]
-
--diff -
report only lines changed according to the unified diff received on STDIN
-
--benchmark -
measure processing speed
-
--config=path -
user config file location (default: $HOME/.config/pep8)
Usage examples
Display how often each error was found:
|
% pep8 --statistics -qq example/lib/ |
|---|---|
Show source code and more verbose explanation from PEP 8:
|
% pep8 --show-source --show-pep8 foo.py |
Releases
5 releases since Debian 6.0 (Squeeze); the text changed 2 times.
--config since Debian 8 (Jessie);
--count since Debian 8 (Jessie);
--diff since Debian 8 (Jessie);
--first since Debian 8 (Jessie);
--format since Debian 8 (Jessie);
--hang-closing since Debian 8 (Jessie);
--max-line-length since Debian 8 (Jessie);
--select since Debian 8 (Jessie);
--version since Debian 8 (Jessie);
-r since Debian 8 (Jessie).
--doctest until Debian 7 (Wheezy);
--testsuite until Debian 7 (Wheezy).