cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite/rst/dev_guide/testing_pep8.rst

58 lines
1.9 KiB
ReStructuredText
Raw Normal View History

rewrite of the developer guide, part 1 (#45179) (#45349) (cherry picked from commit 9a76441c02951ce491203e1dc0efffafaf2a6bd4)
2018-09-07 17:35:13 +02:00
.. _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
2017-04-28 10:08:26 +02:00
*****
PEP 8
*****
.. contents:: Topics
Use pycodestyle instead of pep8 (#25947)
2017-07-13 20:46:31 +02:00
`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
2017-04-28 10:08:26 +02:00
Current Rule Set
================
By default all files are tested using the current rule set.
Use pycodestyle instead of pep8 (#25947)
2017-07-13 20:46:31 +02:00
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
2017-04-28 10:08:26 +02:00
.. warning: Updating the Rule Set
docs: fix community meetings link (#27264)
2017-07-25 15:23:01 +02:00
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
2017-04-28 10:08:26 +02:00
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)
2017-07-13 20:46:31 +02:00
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
2017-04-28 10:08:26 +02:00
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)
2017-07-13 20:46:31 +02:00
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
2017-04-28 10:08:26 +02:00
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)
2017-07-13 20:46:31 +02:00
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
2017-04-28 10:08:26 +02:00
./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
2018-05-15 00:41:47 +02:00
.. _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
2017-04-28 10:08:26 +02:00
.. _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
Reference in a new issue Copy permalink