https://github.com/pycqa/modernize

Modernizes Python code for eventual Python 3 migration. Built on top of fissix (a fork of lib2to3)
https://github.com/pycqa/modernize

Last synced: about 1 month ago
JSON representation

Modernizes Python code for eventual Python 3 migration. Built on top of fissix (a fork of lib2to3)

• Host: GitHub
• URL: https://github.com/pycqa/modernize
• Owner: PyCQA
• License: other
• Created: 2013-08-29T02:53:54.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-04-29T23:31:50.000Z (8 months ago)
• Last Synced: 2024-05-19T07:28:46.045Z (7 months ago)
• Language: Python
• Homepage: https://modernize.readthedocs.org/
• Size: 384 KB
• Stars: 349
• Watchers: 13
• Forks: 56
• Open Issues: 56
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-codemods - **modernize** - modernize Python code for eventual Python 3 migration (By Environment / Python)

README

        
::

    Python           _              _        

       _ __  ___  __| |___ _ _ _ _ (_)______ 

      | '  \/ _ \/ _` / -_) '_| ' \| |_ / -_)

      |_|_|_\___/\__,_\___|_| |_||_|_/__\___|

.. image:: https://img.shields.io/coveralls/github/PyCQA/modernize?label=coveralls&logo=coveralls

    :alt: Coveralls

    :target: https://coveralls.io/github/PyCQA/modernize

.. image:: https://img.shields.io/readthedocs/modernize?logo=read-the-docs

    :alt: Read the Docs

    :target: https://modernize.readthedocs.io/en/latest/

.. image:: https://img.shields.io/github/workflow/status/PyCQA/modernize/CI?label=GitHub%20Actions&logo=github

    :alt: GitHub Actions

    :target: https://github.com/PyCQA/modernize

.. image:: https://img.shields.io/pypi/v/modernize?logo=pypi

    :alt: PyPI

    :target: https://pypi.org/project/modernize/

Modernize is a Python program that reads Python 2 source code

and applies a series of fixers to transform it into source code

that is valid on both Python 3 and Python 2.7.

This allows you to run your test suite on Python 2.7 and Python 3

so you can gradually port your code to being fully Python 3

compatible without slowing down development of your Python 2

project.

The ``python -m modernize`` command works like

``python -m fissix``, see `fissix `_.

Here's how you'd rewrite a

single file::

    python -m modernize -w example.py

It does not guarantee, but it attempts to spit out a codebase compatible

with Python 2.6+ or Python 3. The code that it generates has a runtime

dependency on `six `_, unless the

``--no-six`` option is used. Version 1.9.0 or later of ``six`` is

recommended. Some of the fixers output code that is not compatible with

Python 2.5 or lower.

Once your project is ready to run in production on Python 3 it's

recommended to drop Python 2.7 support using

`pyupgrade `_

**Documentation:** `modernize.readthedocs.io

`_.

See the ``LICENSE`` file for the license of ``modernize``.

Using this tool does not affect licensing of the modernized code.

This library is a very thin wrapper around `fissix

`_, a fork of lib2to3.