1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
:tocdepth: 3
Modernize
/////////
.. toctree::
:maxdepth: 2
fixers
Purpose of the project
======================
.. TODO Explain WHY someone would want to have their code be Python 2/3 compatible
This library is a very thin wrapper around ``fissix`` to utilize it
to make Python 2 code more modern with the intention of eventually
porting it over to Python 3.
The ``python -m modernize`` command works like `fissix
<https://github.com/jreese/fissix>`_. Here's how you'd rewrite a
single file::
python -m modernize -w example.py
See the ``LICENSE`` file for the license of ``python -m modernize``.
Using this tool does not affect licensing of the modernized code.
The `project website`_ can be found on GitHub and the PyPI project name is
modernize_
A note about handling text literals
===================================
.. TODO Explain what a "native string" is if it is going to be referenced
- By default modernize does not change Unicode literals at all, which means that
you can take advantage of
`PEP 414 <https://www.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()`` using the
``modernize.fixes.fix_unicode`` fixer. 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 using the
``modernize.fixes.fix_unicode_future`` fixer.
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.
Indices and tables
//////////////////
* :ref:`genindex`
* :ref:`search`
.. _modernize: https://pypi.python.org/pypi/modernize
.. _project website: https://github.com/pycqa/modernize
|
