Merge remote-tracking branch 'upstream/master'

Author: brettcannon

CHANGELOG.rst

@@ -1,14 +1,45 @@
-Unreleased
-==========
+Version 0.4
+===========
 
 Changes since 0.3:
 
+* `Documentation`_ has been added.
+* All fixers are now idempotent, which allows modernize to safely be applied
+  more than once to the same source code.
+* The option to include default fixers when ``-f`` options are used is now
+  spelled ``-f default``, rather than ``-f all``.
+* Added a ``--version`` option to the modernize command.
+* Calls to ``zip``, ``map``, and ``filter`` are now wrapped with ``list()``
+  in non-iterator contexts, to preserve Python 2 semantics.
+* Improved fixer for ``xrange`` using ``six.moves.range``.
+* Simplified use of ``six.with_metaclass`` for classes with more than
+  one base class.
+* New fixer for imports of renamed standard library modules, using
+  ``six.moves``.
+* New fixer to add ``from __future__ import absolute_import`` to all
+  files with imports, and change any implicit relative imports to explicit
+  (see PEP 328).
+* New fixer for ``input()`` and ``raw_input()``, changed to ``eval(input())``
+  and ``input()`` respectively.
+* New fixer for ``file()``, changed to ``open()``. There is also an
+  opt-in fixer that changes both of these to ``io.open()``.
+* New fixer for ``(int, long)`` or ``(long, int)``, changed to
+  ``six.integer_types``. Other references to ``long`` are changed to ``int``.
+* New fixer for ``basestring``, changed to ``six.string_types``.
+* New fixer for ``unicode``, changed to ``six.text_type``.
+* The ``fix_next`` fixer uses the ``next()`` builtin rather than
+  ``six.advance_iterator``.
+* There is test coverage for all ``libmodernize`` fixers.
+* Simplified the implementation of many ``libmodernize`` fixers by extending
+  similar fixers from ``lib2to3``.
+* Fixed a bug where ``fix_raise_six`` was adding an incorrect import
+  statement.
 * Support for targetting Python 2.5 or lower has been officially dropped.
   (Previously some fixers did output constructs that were only added in
   Python 2.6, such as the ``except ... as`` construct, but this was not
   documented.)
-* The ``fix_next`` fixer uses the ``next()`` builtin rather than
-  ``six.advance_iterator``.
+
+.. _Documentation: http://python-modernize.readthedocs.org/en/latest/
 
 
 Version 0.3

README.rst

@@ -22,26 +22,15 @@ dependency on `six <https://pypi.python.org/pypi/six>`_, unless the
 recommended. Some of the fixers output code that is not compatible with
 Python 2.5 or lower.
 
+**Documentation:** `python-modernize.rtfd.org
+<http://python-modernize.readthedocs.org/en/latest/>`_.
+
 See the ``LICENSE`` file for the license of ``python-modernize``.
 Using this tool does not affect licensing of the modernized code.
 
-
-Unicode Literal Control:
-------------------------
-
-- By default modernize does not change Unicode literals at all, which means that
-  you can take advantage of `PEP 414 <http://legacy.python.org/dev/peps/pep-0414/>`_.
-  This is the simplest option if you only want to support Python 3.3 and above
-  along with Python 2.
-- Alternatively, there is the ``--six-unicode`` flag which will wrap Unicode
-  literals with the six helper function ``six.u()``. This is useful if you want
-  to support Python 3.1 and Python 3.2 without bigger changes.
-- The last alternative is the ``--future-unicode`` flag which
-  imports the ``unicode_literals`` from the ``__future__`` module.
-  This requires Python 2.6 and later, and will require that you
-  mark bytestrings with ``b''`` and native strings in ``str('')``
-  or something similar that survives the transformation.
-
+.. image:: https://readthedocs.org/projects/python-modernize/badge/?version=latest
+    :target: https://readthedocs.org/projects/python-modernize/?badge=latest
+    :alt: Documentation Status
 
 .. image:: https://travis-ci.org/python-modernize/python-modernize.svg?branch=master
     :target: https://travis-ci.org/python-modernize/python-modernize

docs/conf.py

@@ -18,7 +18,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('sphinxext'))
 
 # -- General configuration ------------------------------------------------
 
@@ -28,7 +28,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ['extra_types', 'sphinx.ext.intersphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -93,6 +93,10 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
+intersphinx_mapping = {'python': ('http://docs.python.org/3', None),
+                       'python2': ('http://docs.python.org/2', None),
+                       'six': ('http://pythonhosted.org/six/', None)}
+
 
 # -- Options for HTML output ----------------------------------------------