diff options
| author | Gregory P. Smith <greg@krypto.org> | 2012-02-12 23:51:21 (GMT) |
|---|---|---|
| committer | Gregory P. Smith <greg@krypto.org> | 2012-02-12 23:51:21 (GMT) |
| commit | 12426998cee12903078395cca849564179126be9 (patch) | |
| tree | d550929c756d3c83b5b17b215664fa3e405b31ce /Doc | |
| parent | 3c990e02c6f847b64845838bfc2de305c340399e (diff) | |
| download | cpython-12426998cee12903078395cca849564179126be9.zip cpython-12426998cee12903078395cca849564179126be9.tar.gz cpython-12426998cee12903078395cca849564179126be9.tar.bz2 | |
Issue #13930: Adds ability for 2to3 to write its output to a different
directory tree instead of overwriting the input files. Adds three command
line options: -o/--output-dir, -W/--write-unchanged-files and --add-suffix.
Feature backports into stable release branches for 2to3 are allowed by
a special exemption:
http://mail.python.org/pipermail/python-dev/2011-December/115089.html
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/2to3.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst index bfc1f02..d08c853 100644 --- a/Doc/library/2to3.rst +++ b/Doc/library/2to3.rst @@ -94,6 +94,38 @@ change can also be enabled manually with the :option:`-p` flag. Use :option:`-p` to run fixers on code that already has had its print statements converted. +The :option:`-o` or :option:`--output-dir` option allows specification of an +alternate directory for processed output files to be written to. The +:option:`-n` flag is required when using this as backup files do not make sense +when not overwriting the input files. + +.. versionadded:: 2.7.3 + The :option:`-o` option was added. + +The :option:`-W` or :option:`--write-unchanged-files` flag tells 2to3 to always +write output files even if no changes were required to the file. This is most +useful with :option:`-o` so that an entire Python source tree is copied with +translation from one directory to another. +This option implies the :option:`-w` flag as it would not make sense otherwise. + +.. versionadded:: 2.7.3 + The :option:`-W` flag was added. + +The :option:`--add-suffix` option specifies a string to append to all output +filenames. The :option:`-n` flag is required when specifying this as backups +are not necessary when writing to different filenames. Example:: + + $ 2to3 -n -W --add-suffix=3 example.py + +Will cause a converted file named ``example.py3`` to be written. + +.. versionadded:: 2.7.3 + The :option:`--add-suffix` option was added. + +To translate an entire project from one directory tree to another use:: + + $ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode + .. _2to3-fixers: |