| 1 | """
|
|---|
| 2 | Main program for 2to3.
|
|---|
| 3 | """
|
|---|
| 4 |
|
|---|
| 5 | import sys
|
|---|
| 6 | import os
|
|---|
| 7 | import difflib
|
|---|
| 8 | import logging
|
|---|
| 9 | import shutil
|
|---|
| 10 | import optparse
|
|---|
| 11 |
|
|---|
| 12 | from . import refactor
|
|---|
| 13 |
|
|---|
| 14 |
|
|---|
| 15 | def diff_texts(a, b, filename):
|
|---|
| 16 | """Return a unified diff of two strings."""
|
|---|
| 17 | a = a.splitlines()
|
|---|
| 18 | b = b.splitlines()
|
|---|
| 19 | return difflib.unified_diff(a, b, filename, filename,
|
|---|
| 20 | "(original)", "(refactored)",
|
|---|
| 21 | lineterm="")
|
|---|
| 22 |
|
|---|
| 23 |
|
|---|
| 24 | class StdoutRefactoringTool(refactor.MultiprocessRefactoringTool):
|
|---|
| 25 | """
|
|---|
| 26 | Prints output to stdout.
|
|---|
| 27 | """
|
|---|
| 28 |
|
|---|
| 29 | def __init__(self, fixers, options, explicit, nobackups, show_diffs):
|
|---|
| 30 | self.nobackups = nobackups
|
|---|
| 31 | self.show_diffs = show_diffs
|
|---|
| 32 | super(StdoutRefactoringTool, self).__init__(fixers, options, explicit)
|
|---|
| 33 |
|
|---|
| 34 | def log_error(self, msg, *args, **kwargs):
|
|---|
| 35 | self.errors.append((msg, args, kwargs))
|
|---|
| 36 | self.logger.error(msg, *args, **kwargs)
|
|---|
| 37 |
|
|---|
| 38 | def write_file(self, new_text, filename, old_text, encoding):
|
|---|
| 39 | if not self.nobackups:
|
|---|
| 40 | # Make backup
|
|---|
| 41 | backup = filename + ".bak"
|
|---|
| 42 | if os.path.lexists(backup):
|
|---|
| 43 | try:
|
|---|
| 44 | os.remove(backup)
|
|---|
| 45 | except os.error, err:
|
|---|
| 46 | self.log_message("Can't remove backup %s", backup)
|
|---|
| 47 | try:
|
|---|
| 48 | os.rename(filename, backup)
|
|---|
| 49 | except os.error, err:
|
|---|
| 50 | self.log_message("Can't rename %s to %s", filename, backup)
|
|---|
| 51 | # Actually write the new file
|
|---|
| 52 | write = super(StdoutRefactoringTool, self).write_file
|
|---|
| 53 | write(new_text, filename, old_text, encoding)
|
|---|
| 54 | if not self.nobackups:
|
|---|
| 55 | shutil.copymode(backup, filename)
|
|---|
| 56 |
|
|---|
| 57 | def print_output(self, old, new, filename, equal):
|
|---|
| 58 | if equal:
|
|---|
| 59 | self.log_message("No changes to %s", filename)
|
|---|
| 60 | else:
|
|---|
| 61 | self.log_message("Refactored %s", filename)
|
|---|
| 62 | if self.show_diffs:
|
|---|
| 63 | diff_lines = diff_texts(old, new, filename)
|
|---|
| 64 | try:
|
|---|
| 65 | for line in diff_lines:
|
|---|
| 66 | print line
|
|---|
| 67 | except UnicodeEncodeError:
|
|---|
| 68 | warn("couldn't encode %s's diff for your terminal" %
|
|---|
| 69 | (filename,))
|
|---|
| 70 | return
|
|---|
| 71 |
|
|---|
| 72 |
|
|---|
| 73 | def warn(msg):
|
|---|
| 74 | print >> sys.stderr, "WARNING: %s" % (msg,)
|
|---|
| 75 |
|
|---|
| 76 |
|
|---|
| 77 | def main(fixer_pkg, args=None):
|
|---|
| 78 | """Main program.
|
|---|
| 79 |
|
|---|
| 80 | Args:
|
|---|
| 81 | fixer_pkg: the name of a package where the fixers are located.
|
|---|
| 82 | args: optional; a list of command line arguments. If omitted,
|
|---|
| 83 | sys.argv[1:] is used.
|
|---|
| 84 |
|
|---|
| 85 | Returns a suggested exit status (0, 1, 2).
|
|---|
| 86 | """
|
|---|
| 87 | # Set up option parser
|
|---|
| 88 | parser = optparse.OptionParser(usage="2to3 [options] file|dir ...")
|
|---|
| 89 | parser.add_option("-d", "--doctests_only", action="store_true",
|
|---|
| 90 | help="Fix up doctests only")
|
|---|
| 91 | parser.add_option("-f", "--fix", action="append", default=[],
|
|---|
| 92 | help="Each FIX specifies a transformation; default: all")
|
|---|
| 93 | parser.add_option("-j", "--processes", action="store", default=1,
|
|---|
| 94 | type="int", help="Run 2to3 concurrently")
|
|---|
| 95 | parser.add_option("-x", "--nofix", action="append", default=[],
|
|---|
| 96 | help="Prevent a fixer from being run.")
|
|---|
| 97 | parser.add_option("-l", "--list-fixes", action="store_true",
|
|---|
| 98 | help="List available transformations (fixes/fix_*.py)")
|
|---|
| 99 | parser.add_option("-p", "--print-function", action="store_true",
|
|---|
| 100 | help="Modify the grammar so that print() is a function")
|
|---|
| 101 | parser.add_option("-v", "--verbose", action="store_true",
|
|---|
| 102 | help="More verbose logging")
|
|---|
| 103 | parser.add_option("--no-diffs", action="store_true",
|
|---|
| 104 | help="Don't show diffs of the refactoring")
|
|---|
| 105 | parser.add_option("-w", "--write", action="store_true",
|
|---|
| 106 | help="Write back modified files")
|
|---|
| 107 | parser.add_option("-n", "--nobackups", action="store_true", default=False,
|
|---|
| 108 | help="Don't write backups for modified files.")
|
|---|
| 109 |
|
|---|
| 110 | # Parse command line arguments
|
|---|
| 111 | refactor_stdin = False
|
|---|
| 112 | flags = {}
|
|---|
| 113 | options, args = parser.parse_args(args)
|
|---|
| 114 | if not options.write and options.no_diffs:
|
|---|
| 115 | warn("not writing files and not printing diffs; that's not very useful")
|
|---|
| 116 | if not options.write and options.nobackups:
|
|---|
| 117 | parser.error("Can't use -n without -w")
|
|---|
| 118 | if options.list_fixes:
|
|---|
| 119 | print "Available transformations for the -f/--fix option:"
|
|---|
| 120 | for fixname in refactor.get_all_fix_names(fixer_pkg):
|
|---|
| 121 | print fixname
|
|---|
| 122 | if not args:
|
|---|
| 123 | return 0
|
|---|
| 124 | if not args:
|
|---|
| 125 | print >> sys.stderr, "At least one file or directory argument required."
|
|---|
| 126 | print >> sys.stderr, "Use --help to show usage."
|
|---|
| 127 | return 2
|
|---|
| 128 | if "-" in args:
|
|---|
| 129 | refactor_stdin = True
|
|---|
| 130 | if options.write:
|
|---|
| 131 | print >> sys.stderr, "Can't write to stdin."
|
|---|
| 132 | return 2
|
|---|
| 133 | if options.print_function:
|
|---|
| 134 | flags["print_function"] = True
|
|---|
| 135 |
|
|---|
| 136 | # Set up logging handler
|
|---|
| 137 | level = logging.DEBUG if options.verbose else logging.INFO
|
|---|
| 138 | logging.basicConfig(format='%(name)s: %(message)s', level=level)
|
|---|
| 139 |
|
|---|
| 140 | # Initialize the refactoring tool
|
|---|
| 141 | avail_fixes = set(refactor.get_fixers_from_package(fixer_pkg))
|
|---|
| 142 | unwanted_fixes = set(fixer_pkg + ".fix_" + fix for fix in options.nofix)
|
|---|
| 143 | explicit = set()
|
|---|
| 144 | if options.fix:
|
|---|
| 145 | all_present = False
|
|---|
| 146 | for fix in options.fix:
|
|---|
| 147 | if fix == "all":
|
|---|
| 148 | all_present = True
|
|---|
| 149 | else:
|
|---|
| 150 | explicit.add(fixer_pkg + ".fix_" + fix)
|
|---|
| 151 | requested = avail_fixes.union(explicit) if all_present else explicit
|
|---|
| 152 | else:
|
|---|
| 153 | requested = avail_fixes.union(explicit)
|
|---|
| 154 | fixer_names = requested.difference(unwanted_fixes)
|
|---|
| 155 | rt = StdoutRefactoringTool(sorted(fixer_names), flags, sorted(explicit),
|
|---|
| 156 | options.nobackups, not options.no_diffs)
|
|---|
| 157 |
|
|---|
| 158 | # Refactor all files and directories passed as arguments
|
|---|
| 159 | if not rt.errors:
|
|---|
| 160 | if refactor_stdin:
|
|---|
| 161 | rt.refactor_stdin()
|
|---|
| 162 | else:
|
|---|
| 163 | try:
|
|---|
| 164 | rt.refactor(args, options.write, options.doctests_only,
|
|---|
| 165 | options.processes)
|
|---|
| 166 | except refactor.MultiprocessingUnsupported:
|
|---|
| 167 | assert options.processes > 1
|
|---|
| 168 | print >> sys.stderr, "Sorry, -j isn't " \
|
|---|
| 169 | "supported on this platform."
|
|---|
| 170 | return 1
|
|---|
| 171 | rt.summarize()
|
|---|
| 172 |
|
|---|
| 173 | # Return error status (0 if rt.errors is zero)
|
|---|
| 174 | return int(bool(rt.errors))
|
|---|
