1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
pep8 - Python style guide checker
=================================
pep8 is a tool to check your Python code against some of the style conventions
in `PEP 8`_.
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
Features
--------
* Plugin architecture: Adding new checks is easy.
* Parseable output: Jump to error location in your editor.
* Small: Just one Python file, requires only stdlib. You can use just the
pep8.py file for this purpose
* Easy_installable, of course!
Installation
------------
Just an ``easy_install pep8`` ought to do the trick.
Example usage and output
------------------------
::
$ pep8 optparse.py
optparse.py:69:11: E401 multiple imports on one line
optparse.py:77:1: E302 expected 2 blank lines, found 1
optparse.py:88:5: E301 expected 1 blank line, found 0
optparse.py:222:34: W602 deprecated form of raising exception
optparse.py:347:31: E211 whitespace before '('
optparse.py:357:17: E201 whitespace after '{'
optparse.py:472:29: E221 multiple spaces before operator
optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
You can also make pep8.py show the source code for each error, and
even the relevant text from PEP 8::
$ pep8 --show-source --show-pep8 testsuite/E111.py
testsuite/E111.py:2:3: E111 indentation is not a multiple of four
print x
^
Use 4 spaces per indentation level.
For really old code that you don't want to mess up, you can
continue to use 8-space tabs.
Or you can display how often each error was found::
$ pep8 --statistics -qq --filename=*.py Python-2.5/Lib
232 E201 whitespace after '['
599 E202 whitespace before ')'
631 E203 whitespace before ','
842 E211 whitespace before '('
2531 E221 multiple spaces before operator
4473 E301 expected 1 blank line, found 0
4006 E302 expected 2 blank lines, found 1
165 E303 too many blank lines (4)
325 E401 multiple imports on one line
3615 E501 line too long (82 characters)
612 W601 .has_key() is deprecated, use 'in'
1188 W602 deprecated form of raising exception
Quick help is available on the command line::
$ pep8 -h
Usage: pep8.py [options] input ...
Options:
-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)
--filename=patterns when parsing directories, only check filenames matching
these comma separated patterns (default: *.py)
--ignore=errors skip errors and warnings (e.g. E4,W)
--repeat 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
--statistics count errors and warnings
--count count total number of errors and warnings
--benchmark measure processing speed
--testsuite=dir run regression tests from dir
--doctest run doctest on myself
Feedback
--------
Your feedback is more than welcome. Write email to
johann@rocholl.net or post bugs and feature requests here:
http://github.com/cburroughs/pep8.py/issues
Source download
---------------
The source code is currently available on github. Fork away!
http://github.com/cburroughs/pep8.py/
http://github.com/jcrocholl/pep8/
(Yes it's lame to have two that are not forks of one another. At some
point in the future it is hoped some git magic will clean this
situation up.)
|
