pep257 0.3.0

Installation

Use pip or easy_install:

pip install pep257

Alternatively, you can use pep257.py source file directly–it is self-contained.

pep257 is tested with Python 2.6, 2.7, 3.2, 3.3

Example

$ pep257 --help
Usage: pep257 [options] [<file|dir>...]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -e, --explain         show explanation of each error
  -s, --source          show source for each error
  --ignore=<codes>      ignore a list comma-separated error codes, for
                        example: --ignore=D101,D202
  --match=<pattern>     check only files that exactly match <pattern> regular
                        expression; default is --match='(?!test_).*\.py' which
                        matches files that don't start with 'test_' but end
                        with '.py'
  --match-dir=<pattern>
                        search only dirs that exactly match <pattern> regular
                        expression; default is --match-dir='[^\.].*', which
                        matches all dirs that don't start with a dot

$ pep257 test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:22 in public method `method`:
        D102: Docstring missing
...

$ pep257 test.py --explain
test.py:18 in private nested class `meta`:
        D101: Docstring missing

        All modules should normally have docstrings.  [...] all functions and
        classes exported by a module should also have docstrings. Public
        methods (including the __init__ constructor) should also have
        docstrings.

        Note: Public (exported) definitions are either those with names listed
              in __all__ variable (if present), or those that do not start
              with a single underscore.
...

$ pep257 test.py --source
test.py:15 in public class `class_`:
        D101: Docstring missing

    15: class class_:
    16:
...

Error codes

All pep257 errors have unique codes. All codes start with a capital D and are grouped as follows: