Repository files navigation

pycodestyle is a tool to check your Python code against some of the styleconventions inPEP 8.

• 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 justthepycodestyle.py file for this purpose.
• Comes with a comprehensive test suite.

You can install, upgrade, and uninstallpycodestyle.py with these commands:

$ pip install pycodestyle$ pip install --upgrade pycodestyle$ pip uninstall pycodestyle

There's also a package for Debian/Ubuntu, but it's not always thelatest version.

$ pycodestyle --first optparse.pyoptparse.py:69:11: E401 multiple imports on one lineoptparse.py:77:1: E302 expected 2 blank lines, found 1optparse.py:88:5: E301 expected 1 blank line, found 0optparse.py:347:31: E211 whitespace before '('optparse.py:357:17: E201 whitespace after '{'optparse.py:472:29: E221 multiple spaces before operator

You can also makepycodestyle.py show the source code for each error, andeven the relevant text from PEP 8:

$ pycodestyle --show-source --show-pep8 testing/data/E40.pytesting/data/E40.py:2:10: E401 multiple imports on one lineimport os, sys         ^    Imports should usually be on separate lines.    Okay: import os\nimport sys    E401: import sys, os

Or you can display how often each error was found:

$ pycodestyle --statistics -qq Python-2.5/Lib232     E201 whitespace after '['599     E202 whitespace before ')'631     E203 whitespace before ','842     E211 whitespace before '('2531    E221 multiple spaces before operator4473    E301 expected 1 blank line, found 04006    E302 expected 2 blank lines, found 1165     E303 too many blank lines (4)325     E401 multiple imports on one line3615    E501 line too long (82 characters)

• Read the documentation
• Fork me on GitHub