History

Ted Timmons 23886c5c0d add instructions for running pep8 locally (#21120 )		2017-02-13 11:09:50 -08:00
..
current-ignore.txt
legacy-files.txt	Legacy pep8 updates for setup.py and tests	2017-02-11 16:04:52 -08:00
legacy-ignore.txt	PEP 8 indent cleanup. (#20800 )	2017-01-29 07:28:53 +00:00
README.md	add instructions for running pep8 locally (#21120 )	2017-02-13 11:09:50 -08:00
skip.txt	refactoring async	2017-02-06 19:32:00 -05:00

README.md

PEP 8

PEP 8 style guidelines are enforced by pep8 on all python files in the repository by default.

Current Rule Set

By default all files are tested using the current rule set. All pep8 tests are executed, except those listed in the current ignore list.

Legacy Rule Set

Files which are listed in the legacy file list are tested using the legacy rule set. All pep8 tests are executed, except those listed in the current ignore list or legacy ignore list.

Files listed in the legacy file list which pass the current rule set will result in an error. This is intended to prevent regressions on style guidelines for files which pass the more stringent current rule set.

Skipping Tests

Files listed in the skip list are not tested by pep8.

Removed Files

Files which have been removed from the repository must be removed from the legacy file list and the skip list.

Running Locally

The pep8 check can be run locally with:

./test/runner/ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...