2to3 tool

Syntax

  • $ 2to3 [-options] path/to/file.py

Parameters

ParameterDescription
filename / directory_name2to3 accepts a list of files or directories which is to be transformed as its argument. The directories are recursively traversed for Python sources.
OptionOption Description
-f FIX, --fix=FIXSpecify transformations to be applied; default: all. List available transformations with --list-fixes
-j PROCESSES, --processes=PROCESSESRun 2to3 concurrently
-x NOFIX, --nofix=NOFIXExclude a transformation
-l, --list-fixesList available transformations
-p, --print-functionChange the grammar so that print() is considered a function
-v, --verboseMore verbose output
--no-diffsDo not output diffs of the refactoring
-wWrite back modified files
-n, --nobackupsDo not create backups of modified files
-o OUTPUT_DIR, --output-dir=OUTPUT_DIRPlace output files in this directory instead of overwriting input files. Requires the -n flag, as backup files are unnecessary when the input files are not modified.
-W, --write-unchanged-filesWrite output files even is no changes were required. Useful with -o so that a complete source tree is translated and copied. Implies -w.
--add-suffix=ADD_SUFFIXSpecify a string to be appended to all output filenames. Requires -n if non-empty. Ex.: --add-suffix='3' will generate .py3 files.

Remarks

The 2to3 tool is an python program which is used to convert the code written in Python 2.x to Python 3.x code. The tool reads Python 2.x source code and applies a series of fixers to transform it into valid Python 3.x code.

The 2to3 tool is available in the standard library as lib2to3 which contains a rich set of fixers that will handle almost all code. Since lib2to3 is a generic library, it is possible to write your own fixers for 2to3.

Basic Usage

Consider the following Python2.x code. Save the file as example.py

Python 2.x2.0
def greet(name):
    print "Hello, {0}!".format(name)
print "What's your name?"
name = raw_input()
greet(name)

In the above file, there are several incompatible lines. The raw_input() method has been replaced with input() in Python 3.x and print is no longer a statement, but a function. This code can be converted to Python 3.x code using the 2to3 tool.

Unix

$ 2to3 example.py

Windows

> path/to/2to3.py example.py

Running the above code will output the differences against the original source file as shown below.

RefactoringTool: Skipping implicit fixer: buffer
RefactoringTool: Skipping implicit fixer: idioms
RefactoringTool: Skipping implicit fixer: set_literal
RefactoringTool: Skipping implicit fixer: ws_comma
RefactoringTool: Refactored example.py
--- example.py    (original)
+++ example.py    (refactored)
@@ -1,5 +1,5 @@
 def greet(name):
-    print "Hello, {0}!".format(name)
-print "What's your name?"
-name = raw_input()
+    print("Hello, {0}!".format(name))
+print("What's your name?")
+name = input()
 greet(name)
RefactoringTool: Files that need to be modified:
RefactoringTool: example.py

The modifications can be written back to the source file using the -w flag. A backup of the original file called example.py.bak is created, unless the -n flag is given.

Unix

$ 2to3 -w example.py

Windows

> path/to/2to3.py -w example.py

Now the example.py file has been converted from Python 2.x to Python 3.x code.

Once finished, example.py will contain the following valid Python3.x code:

Python 3.x3.0
def greet(name):
    print("Hello, {0}!".format(name))
print("What's your name?")
name = input()
greet(name)