pep257 Python docstring style checker
Download

pep257 Ranking & Summary

pep257 Tags

style Python docstring style checker

pep257 Description

pep275 is a static analysis tool for checking compliance with Python PEP 257: http://www.python.org/dev/peps/pep-0257/.The framework for checking docstring style is flexible, and custom checks can be easily added, for example to cover NumPy docstring conventions: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt.Adding new checks is described in docstring of pep257.py file.InstallationUse pip or easy_install:pip install pep257Alternatively, you can use pep257.py source file directly--it is self-contained.pep257 is tested with Python 2.4, 2.5, 2.6, 2.7, 3.1, 3.2.Example$ pep257 --helpUsage: pep257 Options: -h, --help show this help message and exit -e, --explain show explanation of each error -r, --range show error start..end positions -q, --quote quote erroneous lines$ pep257 *.pydocopt.py:1:0: PEP257 Modules should have docstrings.docopt.py:14:4: PEP257 Class docstring should have 1 blank line around them.docopt.py:27:0: PEP257 Exported classes should have docstrings.docopt.py:43:4: PEP257 Exported definitions should have docstrings....$ pep257 *.py --explaindocopt.py:1:0: PEP257 Modules should have docstrings.PEP257 Modules should have docstrings. All modules should normally have docstrings.docopt.py:14:4: PEP257 Class docstring should have 1 blank line around them.PEP257 Class docstring should have 1 blank line around them. Insert a blank line before and after all docstrings (one-line or multi-line) that document a class -- generally speaking, the class's methods are separated from each other by a single blank line, and the docstring needs to be offset from the first method by a blank line; for symmetry, put a blank line between the class header and the docstring....$ pep257 --quote *.pydocopt.py:1:0: PEP257 Modules should have docstrings. import sys import re # Python 3 Compatibility try: basestring except NameError:docopt.py:14:4: PEP257 Class docstring should have 1 blank line around them. """Error in construction of usage-message."""docopt.py:27:0: PEP257 Exported classes should have docstrings. class Pattern(object):docopt.py:43:4: PEP257 Exported definitions should have docstrings. def flat(self):...Python APIpep257 Python API is useful when you want to include PEP 257 checks into your test-suite.>>> import pep257>>> pep257.check_files()A pytest-style test can look like this:import pep257test_pep257(): errors = pep257.check_files() assert len(errors) == 0Product's homepage

pep257 Related Software