Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Python style guide checker

Project description

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 two have two that are not forks of one another. At some
point in the future it is hoped some git magic will clean this
situating up.)



Changelog
=========


0.4 (2009-10-20)
----------------

* Support for all versions of Python from 2.3 to 3.1.

* New and greatly expanded self tests.

* Added --count option to print the total number of errors and warnings.

* Further improvements to the handling of comments and blank lines.
(Issue #1 and others changes.)

* check all py files in directory when passed a directory (Issue
#2). This also prevents an exception when traversing directories
with non *.py files.

* E231 should allow commas to be followed by ) (Issue #3)

* Spaces are not longer required around the equals sign for keyword
arguments or default parameter values.


0.3.1 (2009-09-14)
------------------

* Fixes for comments: do not count them when checking for blank lines between
items.

* Added setup.py for pypi upload and easy_installability.


0.2 (2007-10-16)
----------------

* Loads of fixes and improvements.


0.1 (2006-10-01)
----------------

* First release.


TODO
====

- script to verify testcases pass.

- testcase for ignoring '#' before function change change.

- I have observed problems with decorators and 200 warnings, look into this.

Project details


Release history Release notifications

History Node

1.7.1

History Node

1.7.0

History Node

1.6.2

History Node

1.6.1

History Node

1.6.0

History Node

1.5.7

History Node

1.5.6

History Node

1.5.5

History Node

1.5.4

History Node

1.5.3

History Node

1.5.2

History Node

1.5.1

History Node

1.5.0

History Node

1.4.6

History Node

1.4.5

History Node

1.4.4

History Node

1.4.3

History Node

1.4.2

History Node

1.4.1

History Node

1.4

History Node

1.3.4

History Node

1.3.3

History Node

1.3.2

History Node

1.3.1

History Node

1.3

History Node

1.2

History Node

1.1

History Node

1.0.1

History Node

1.0

History Node

0.7.0

History Node

0.6.1

History Node

0.6.0

History Node

0.5.0

History Node

0.4.2

History Node

0.4.1

This version
History Node

0.4

History Node

0.3.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pep8-0.4.tar.gz (16.5 kB) Copy SHA256 hash SHA256 Source None Oct 20, 2009

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page