PEP 8

Topics

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

Current Rule Set

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

Changes to the Rule Set need approval from the Core Team, and must be done via the Testing Working Group.

Files which are listed in the legacy file list are tested using the legacy rule set.

All PEP 8 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.

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

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

The PEP 8 check can be run locally with:

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