Use pycodestyle instead of pep8 (#25947)

This commit is contained in:
Pilou 2017-07-13 20:46:31 +02:00 committed by Matt Clay
parent 7329a392ff
commit 4b3d6dfa8a
8 changed files with 19 additions and 15 deletions

View file

@ -17,12 +17,12 @@ Language
PEP 8 and basic style checks
===========================
* PEP8 is a great Python style guide, which you should read.
* [PEP 8](https://www.python.org/dev/peps/pep-0008/) is a great Python style guide, which you should read.
* PEP 8 must not be strictly followed in all aspects, but most of it is good advice
* In particular, we don't really care about line lengths. Buy a bigger monitor!
* To run checks for things we care about, run "make pep8"
* To run checks for things we care about, use [ansible-test](http://docs.ansible.com/ansible/dev_guide/testing_pep8.html#running-locally).
* Similarly, additional checks can be made with "make pyflakes"
* There is no need to submit code changes for pep8 and pyflake fixes, as these break attribution history. Project leadership will make these periodically.
* There is no need to submit code changes for PEP 8 and pyflakes fixes, as these break attribution history. Project leadership will make these periodically.
* Do not submit pull requests that simply adjust whitespace in the code
Testing

View file

@ -179,7 +179,7 @@ please observe the following guidelines:
- Use a 4-space indent, not tabs.
- We do not enforce 80 column lines; up to 160 columns are acceptable.
- We do not accept 'style only' pull requests unless the code is nearly unreadable.
- We are "PEP8ish", but not strictly compliant.
- We are "PEP8ish", but not strictly compliant, see :doc:`testing_pep8` for more information.
You can also contribute by testing and revising other requests, especially if it is one you are interested
in using. Please keep your comments clear and to the point, courteous and constructive, tickets are not a

View file

@ -4,13 +4,13 @@ PEP 8
.. contents:: Topics
`PEP 8`_ style guidelines are enforced by ``pep8`` on all python files in the repository by default.
`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 ``pep8`` tests are executed, except those listed in the `current ignore list`_.
All `PEP 8`_ tests are executed, except those listed in the `current ignore list`_.
.. warning: Updating the Rule Set
@ -21,7 +21,7 @@ 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`_.
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.
@ -30,7 +30,7 @@ This is intended to prevent regressions on style guidelines for files which pass
Skipping Tests
==============
Files listed in the `skip list`_ are not tested by ``pep8``.
Files listed in the `skip list`_ are not tested by `pycodestyle`_.
Removed Files
=============
@ -40,7 +40,7 @@ Files which have been removed from the repository must be removed from the legac
Running Locally
===============
The pep8 check can be run locally with::
The `PEP 8`_ check can be run locally with::
./test/runner/ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...
@ -48,7 +48,7 @@ The pep8 check can be run locally with::
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _pycodestyle: https://pypi.python.org/pypi/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

View file

@ -210,6 +210,7 @@ class SourcesList(object):
if filename is not None:
return filename
return '_'.join(re.sub('[^a-zA-Z0-9]', ' ', s).split())
def _strip_username_password(s):
if '@' in s:
s = s.split('@', 1)

View file

@ -321,7 +321,7 @@ def command_sanity_pep8(args, targets):
return SanitySkipped(test)
cmd = [
'pep8',
'pycodestyle',
'--max-line-length', '160',
'--config', '/dev/null',
'--ignore', ','.join(sorted(current_ignore)),

View file

@ -1,8 +1,8 @@
cryptography
jinja2
mock
pep8
paramiko
pycodestyle
pylint
pytest
rstcheck

View file

@ -1 +1,4 @@
E305
E402
E722
E741