multi-indent rebase on PyCQA/pycodestyle master branch

CHANGES.txt

@@ -1,6 +1,41 @@
 Changelog
 =========
 
+2.2.0 (2016-11-14)
+------------------
+
+Announcements:
+
+* Added Make target to obtain proper tarball file permissions; #599
+
+Bugs:
+
+* Fixed E305 regression caused by #400; #593
+
+2.1.0 (2016-11-04)
+------------------
+
+Announcements:
+
+* Change all references to the pep8 project to say pycodestyle; #530
+
+Changes:
+
+* Report E302 for blank lines before an "async def"; #556
+* Update our list of tested and supported Python versions which are 2.6, 2.7,
+  3.2, 3.3, 3.4 and 3.5 as well as the nightly Python build and PyPy.
+* Report E742 and E743 for functions and classes badly named 'l', 'O', or 'I'.
+* Report E741 on 'global' and 'nonlocal' statements, as well as prohibited
+  single-letter variables.
+* Deprecated use of `[pep8]` section name in favor of `[pycodestyle]`; #591
+* Report E722 when bare except clause is used; #579
+
+Bugs:
+
+* Fix opt_type AssertionError when using Flake8 2.6.2 and pycodestyle; #561
+* Require two blank lines after toplevel def, class; #536
+* Remove accidentally quadratic computation based on the number of colons. This
+  will make pycodestyle faster in some cases; #314
 
 2.0.0 (2016-05-31)
 ------------------

CONTRIBUTING.rst

@@ -1,4 +1,72 @@
-Contributing to ``pycodestyle``
-===============================
+Contributing to pycodestyle
+===========================
 
-Please see the `developer notes <https://pycodestyle.readthedocs.io/en/latest/developer.html>`_
+When contributing to pycodestyle, please observe our `Code of Conduct`_.
+
+Step 1: Forking pycodestyle for editing
+---------------------------------------
+
+Fork the pycodestyle repository on GitHub. This will add
+pycodestyle to your GitHub account. You will push your changes to your
+fork and then make pull requests into the official pycodestyle repository.
+
+GitHub has an excellent `guide`_ that has screenshots on how to do this.
+
+Next, clone your fork of the pycodestyle repository to your system for
+editing::
+
+    $ git clone https://www.github.com/<your_username>/pycodestyle
+
+Now you have a copy of the pycodestyle codebase that is almost ready for
+edits.  Next we will setup `virtualenv`_ which will help create an isolated
+environment to manage dependancies.
+
+
+Step 2: Use virtualenv when developing
+--------------------------------------
+
+`virtualenv`_ is a tool to create isolated python environments.
+First, install virtualenv with::
+
+    $ pip install virtualenv
+
+Next, ``cd`` to the pycodestyle repository that you cloned earlier and
+create, then activate a virtualenv::
+
+    $ cd pycodestyle
+    $ virtualenv pycodestyle-venv
+    $ source pycodestyle-venv/bin/activate
+
+Now you can install the pycodestyle requirements::
+
+    $ pip install -r dev-requirements.txt
+
+To deactivate the virtualenv you can type::
+
+    $ deactivate
+
+For more information see `virtualenv`_'s documentation.
+
+
+Step 3: Run tests
+-----------------
+
+Before creating a pull request you should run the tests to make sure that the
+changes that have been made haven't caused any regressions in functionality.
+To run the tests, the core developer team and Travis-CI use `tox`_::
+
+    $ pip install -r dev-requirements.txt
+    $ tox
+
+All the tests should pass for all available interpreters, with the summary of::
+
+    congratulations :)
+
+At this point you can create a pull request back to the official pycodestyles
+repository for review! For more information on how to make a pull request,
+GitHub has an excellent `guide`_.
+
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+.. _guide: https://guides.github.com/activities/forking/
+.. _tox: https://tox.readthedocs.io/en/latest/
+.. _Code of Conduct: http://meta.pycqa.org/en/latest/code-of-conduct.html

Makefile

@@ -1,3 +1,6 @@
+release:
+	umask 022 && chmod -R a+rX . && python setup.py sdist bdist_wheel
+
 test :
 	python pycodestyle.py --testsuite testsuite
 

README.rst

@@ -1,6 +1,22 @@
 pycodestyle (formerly called pep8) - Python style guide checker
 ===============================================================
 
+.. image:: https://img.shields.io/travis/PyCQA/pycodestyle.svg
+   :target: https://travis-ci.org/PyCQA/pycodestyle
+   :alt: Build status
+
+.. image:: https://readthedocs.org/projects/pycodestyle/badge/?version=latest
+    :target: https://pycodestyle.readthedocs.io
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg
+   :target: https://pypi.python.org/pypi/pycodestyle
+   :alt: Wheel Status
+
+.. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg
+   :alt: Join the chat at https://gitter.im/PyCQA/pycodestyle
+   :target: https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
 pycodestyle is a tool to check your Python code against some of the style
 conventions in `PEP 8`_.
 
@@ -9,8 +25,12 @@ conventions in `PEP 8`_.
 .. note::
 
     This package used to be called ``pep8`` but was renamed to ``pycodestyle``
-    to reduce confusion. Further discussion `here
-    <https://github.com/PyCQA/pycodestyle/issues/466>`_.
+    to reduce confusion. Further discussion can be found `in the issue where
+    Guido requested this
+    change <https://github.com/PyCQA/pycodestyle/issues/466>`_, or in the
+    lightning talk at PyCon 2016 by @IanLee1521:
+    `slides <https://speakerdeck.com/ianlee1521/pep8-vs-pep-8>`_
+    `video <https://youtu.be/PulzIT8KYLk?t=36m>`_.
 
 Features
 --------
@@ -27,7 +47,7 @@ Features
 Installation
 ------------
 
-You can install, upgrade, uninstall ``pycodestyle.py`` with these commands::
+You can install, upgrade, and uninstall ``pycodestyle.py`` with these commands::
 
   $ pip install pycodestyle
   $ pip install --upgrade pycodestyle
@@ -83,14 +103,6 @@ Or you can display how often each error was found::
 Links
 -----
 
-.. image:: https://api.travis-ci.org/PyCQA/pycodestyle.png?branch=master
-   :target: https://travis-ci.org/PyCQA/pycodestyle
-   :alt: Build status
-
-.. image:: https://pypip.in/wheel/pycodestyle/badge.png?branch=master
-   :target: https://pypi.python.org/pypi/pycodestyle
-   :alt: Wheel Status
-
 * `Read the documentation <https://pycodestyle.readthedocs.io/>`_
 
 * `Fork me on GitHub <http://github.com/PyCQA/pycodestyle>`_

dev-requirements.txt

@@ -0,0 +1 @@
+tox

docs/developer.rst

@@ -14,8 +14,8 @@ conditions of the :ref:`Expat license <license>`.  Fork away!
 * `Source code <https://github.com/pycqa/pycodestyle>`_ and
   `issue tracker <https://github.com/pycqa/pycodestyle/issues>`_ on GitHub.
 * `Continuous tests <http://travis-ci.org/pycqa/pycodestyle>`_ against Python
-  2.6 through 3.4 and PyPy, on `Travis-CI platform
-  <http://about.travis-ci.org/>`_.
+  2.6 through 3.5 as well as the nightly Python build and PyPy, on `Travis-CI
+  platform <https://docs.travis-ci.com//>`_.
 
 .. _available on GitHub: https://github.com/pycqa/pycodestyle
 
@@ -27,7 +27,8 @@ Some high-level aims and directions to bear in mind for contributions:
 
 * ``pycodestyle`` is intended to be as fast as possible.
   Using the ``ast`` module defeats that purpose.
-  The `pep8-naming <https://github.com/flintwork/pep8-naming>`_ plugin exists for this sort of functionality.
+  The `pep8-naming <https://github.com/flintwork/pep8-naming>`_ plugin exists
+  for this sort of functionality.
 * If you want to provide extensibility / plugins,
   please see `flake8 <https://gitlab.com/pycqa/flake8>`_ -
   ``pycodestyle`` doesn't want or need a plugin architecture.
@@ -103,6 +104,15 @@ Then be sure to pass the tests::
 
 When contributing to pycodestyle, please observe our `Code of Conduct`_.
 
+To run the tests, the core developer team and Travis-CI use tox::
+
+    $ pip install -r dev-requirements.txt
+    $ tox
+
+All the tests should pass for all available interpreters, with the summary of::
+
+    congratulations :)
+
 .. _PEP 8: http://www.python.org/dev/peps/pep-0008/
 .. _Code of Conduct: http://meta.pycqa.org/en/latest/code-of-conduct.html
 

docs/intro.rst

@@ -157,6 +157,7 @@ Quick help is available on the command line::
     --count              print total number of errors and warnings to standard
                          error and set exit code to 1 if total is not null
     --max-line-length=n  set maximum allowed line length (default: 79)
+    --indent-size=n      set how many spaces make up an indent (default: 4)
     --hang-closing       hang closing bracket instead of matching indentation of
                          opening bracket's line
     --format=format      set the error format [default|pylint|<custom>]
@@ -167,13 +168,14 @@ Quick help is available on the command line::
       --benchmark        measure processing speed
 
     Configuration:
-      The project options are read from the [pep8] section of the tox.ini
-      file or the setup.cfg file located in any parent folder of the path(s)
-      being processed.  Allowed options are: exclude, filename, select,
+      The project options are read from the [pycodestyle] section of the
+      tox.ini file or the setup.cfg file located in any parent folder of the
+      path(s) being processed.  Allowed options are: exclude, filename, select,
       ignore, max-line-length, hang-closing, count, format, quiet, show-pep8,
       show-source, statistics, verbose.
 
-      --config=path      user config file location (default: ~/.config/pep8)
+      --config=path      user config file location
+      (default: ~/.config/pycodestyle)
 
 
 Configuration
@@ -184,23 +186,23 @@ The behaviour may be configured at two levels, the user and project levels.
 At the user level, settings are read from the following locations:
 
 If on Windows:
-    ``~\.pep8``
+    ``~\.pycodestyle``
 
 Otherwise, if the :envvar:`XDG_CONFIG_HOME` environment variable is defined:
-    ``XDG_CONFIG_HOME/pep8``
+    ``XDG_CONFIG_HOME/pycodestyle``
 
 Else if :envvar:`XDG_CONFIG_HOME` is not defined:
-    ``~/.config/pep8``
+    ``~/.config/pycodestyle``
 
 Example::
 
-  [pep8]
+  [pycodestyle]
   ignore = E226,E302,E41
   max-line-length = 160
 
 At the project level, a ``setup.cfg`` file or a ``tox.ini`` file is read if
-present. If none of these files have a ``[pep8]`` section, no project specific
-configuration is loaded.
+present. If none of these files have a ``[pycodestyle]`` section, no project
+specific configuration is loaded.
 
 
 Error codes
@@ -321,6 +323,10 @@ This is the current list of error and warning codes:
 +------------+----------------------------------------------------------------------+
 | E304       | blank lines found after function decorator                           |
 +------------+----------------------------------------------------------------------+
+| E305       | expected 2 blank lines after end of function or class                |
++------------+----------------------------------------------------------------------+
+| E306       | expected 1 blank line before a nested definition                     |
++------------+----------------------------------------------------------------------+
 +------------+----------------------------------------------------------------------+
 | **E4**     | *Import*                                                             |
 +------------+----------------------------------------------------------------------+
@@ -356,8 +362,16 @@ This is the current list of error and warning codes:
 +------------+----------------------------------------------------------------------+
 | E721 (^)   | do not compare types, use 'isinstance()'                             |
 +------------+----------------------------------------------------------------------+
+| E722       | do not use bare except, specify exception instead                    |
++------------+----------------------------------------------------------------------+
 | E731       | do not assign a lambda expression, use a def                         |
 +------------+----------------------------------------------------------------------+
+| E741       | do not use variables named 'l', 'O', or 'I'                          |
++------------+----------------------------------------------------------------------+
+| E742       | do not define classes named 'l', 'O', or 'I'                         |
++------------+----------------------------------------------------------------------+
+| E743       | do not define functions named 'l', 'O', or 'I'                       |
++------------+----------------------------------------------------------------------+
 +------------+----------------------------------------------------------------------+
 | **E9**     | *Runtime*                                                            |
 +------------+----------------------------------------------------------------------+