ansible/docs/docsite/rst/dev_guide/testing_pep8.rst

:orphan:

.. _testing_pep8:

*****
PEP 8
*****

.. contents:: 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`_.

.. warning: Updating the Rule Set

   Changes to the Rule Set need approval from the Core Team, and must be done via the `Testing Working Group <https://github.com/ansible/community/blob/master/meetings/README.md>`_.

Legacy Rule Set
===============

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.

Skipping Tests
==============

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

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 `PEP 8`_ check can be run locally with::


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


.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _pycodestyle: https://pypi.org/project/pycodestyle/
.. _current ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/current-ignore.txt
.. _legacy file list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-files.txt
.. _legacy ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-ignore.txt
.. _skip list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/skip.txt
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 6 years ago			`:orphan:`

rewrite of the developer guide, part 1 (#45179) * rewrite of the developer guide, part 1 6 years ago			`.. _testing_pep8:`

Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago			`*****`
			`PEP 8`
			`*****`

			`.. contents:: Topics`

Use pycodestyle instead of pep8 (#25947) 7 years ago			`PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago
			`Current Rule Set`
			`================`

			`By default all files are tested using the current rule set.`
Use pycodestyle instead of pep8 (#25947) 7 years ago			All `PEP 8`_ tests are executed, except those listed in the `current ignore list`_.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago
			`.. warning: Updating the Rule Set`

docs: fix community meetings link (#27264) 7 years ago			Changes to the Rule Set need approval from the Core Team, and must be done via the `Testing Working Group <https://github.com/ansible/community/blob/master/meetings/README.md>`_.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago
			`Legacy Rule Set`
			`===============`

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

Use pycodestyle instead of pep8 (#25947) 7 years ago			All `PEP 8`_ tests are executed, except those listed in the `current ignore list`_ or `legacy ignore list`_.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago
			`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`
			`==============`

Use pycodestyle instead of pep8 (#25947) 7 years ago			Files listed in the `skip list`_ are not tested by `pycodestyle`_.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago
			`Removed Files`
			`=============`

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

			`Running Locally`
			`===============`

Use pycodestyle instead of pep8 (#25947) 7 years ago			The `PEP 8`_ check can be run locally with::
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago

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



			`.. _PEP 8: https://www.python.org/dev/peps/pep-0008/`
Update all pypi.python.org URLs to pypi.org (#38988) For details on the new PyPI, see the blog post: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html 7 years ago			`.. _pycodestyle: https://pypi.org/project/pycodestyle/`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 8 years ago			`.. _current ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/current-ignore.txt`
			`.. _legacy file list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-files.txt`
			`.. _legacy ignore list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/legacy-ignore.txt`
			`.. _skip list: https://github.com/ansible/ansible/blob/devel/test/sanity/pep8/skip.txt`