methfix.py 5.35 KB
Newer Older
1
#! /usr/bin/env python
Guido van Rossum's avatar
Guido van Rossum committed
2

Tim Peters's avatar
Tim Peters committed
3 4
# Fix Python source files to avoid using
#       def method(self, (arg1, ..., argn)):
Guido van Rossum's avatar
Guido van Rossum committed
5
# instead of the more rational
Tim Peters's avatar
Tim Peters committed
6
#       def method(self, arg1, ..., argn):
Guido van Rossum's avatar
Guido van Rossum committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# Command line arguments are files or directories to be processed.
# Directories are searched recursively for files whose name looks
# like a python module.
# Symbolic links are always ignored (except as explicit directory
# arguments).  Of course, the original file is kept as a back-up
# (with a "~" attached to its name).
# It complains about binaries (files containing null bytes)
# and about files that are ostensibly not Python files: if the first
# line starts with '#!' and does not contain the string 'python'.
#
# Changes made are reported to stdout in a diff-like format.
#
# Undoubtedly you can do this using find and sed or perl, but this is
# a nice example of Python code that recurses down a directory tree
# and uses regular expressions.  Also note several subtleties like
# preserving the file's mode and avoiding to even write a temp file
# when no changes are needed for a file.
#
# NB: by changing only the function fixline() you can turn this
# into a program for a different change to Python programs...

import sys
30
import re
Guido van Rossum's avatar
Guido van Rossum committed
31 32 33 34 35 36 37 38
import os
from stat import *

err = sys.stderr.write
dbg = err
rep = sys.stdout.write

def main():
Tim Peters's avatar
Tim Peters committed
39 40 41 42 43 44 45 46 47 48 49 50 51
    bad = 0
    if not sys.argv[1:]: # No arguments
        err('usage: ' + sys.argv[0] + ' file-or-directory ...\n')
        sys.exit(2)
    for arg in sys.argv[1:]:
        if os.path.isdir(arg):
            if recursedown(arg): bad = 1
        elif os.path.islink(arg):
            err(arg + ': will not process symbolic links\n')
            bad = 1
        else:
            if fix(arg): bad = 1
    sys.exit(bad)
Guido van Rossum's avatar
Guido van Rossum committed
52

53
ispythonprog = re.compile('^[a-zA-Z0-9_]+\.py$')
Guido van Rossum's avatar
Guido van Rossum committed
54
def ispython(name):
Tim Peters's avatar
Tim Peters committed
55
    return ispythonprog.match(name) >= 0
Guido van Rossum's avatar
Guido van Rossum committed
56 57

def recursedown(dirname):
58
    dbg('recursedown(%r)\n' % (dirname,))
Tim Peters's avatar
Tim Peters committed
59 60 61
    bad = 0
    try:
        names = os.listdir(dirname)
62
    except os.error as msg:
63
        err('%s: cannot list directory: %r\n' % (dirname, msg))
Tim Peters's avatar
Tim Peters committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77
        return 1
    names.sort()
    subdirs = []
    for name in names:
        if name in (os.curdir, os.pardir): continue
        fullname = os.path.join(dirname, name)
        if os.path.islink(fullname): pass
        elif os.path.isdir(fullname):
            subdirs.append(fullname)
        elif ispython(name):
            if fix(fullname): bad = 1
    for fullname in subdirs:
        if recursedown(fullname): bad = 1
    return bad
Guido van Rossum's avatar
Guido van Rossum committed
78 79

def fix(filename):
80
##  dbg('fix(%r)\n' % (filename,))
Tim Peters's avatar
Tim Peters committed
81 82
    try:
        f = open(filename, 'r')
83
    except IOError as msg:
84
        err('%s: cannot open: %r\n' % (filename, msg))
Tim Peters's avatar
Tim Peters committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
        return 1
    head, tail = os.path.split(filename)
    tempname = os.path.join(head, '@' + tail)
    g = None
    # If we find a match, we rewind the file and start over but
    # now copy everything to a temp file.
    lineno = 0
    while 1:
        line = f.readline()
        if not line: break
        lineno = lineno + 1
        if g is None and '\0' in line:
            # Check for binary files
            err(filename + ': contains null bytes; not fixed\n')
            f.close()
            return 1
        if lineno == 1 and g is None and line[:2] == '#!':
            # Check for non-Python scripts
103
            words = line[2:].split()
104
            if words and re.search('[pP]ython', words[0]) < 0:
Tim Peters's avatar
Tim Peters committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
                msg = filename + ': ' + words[0]
                msg = msg + ' script; not fixed\n'
                err(msg)
                f.close()
                return 1
        while line[-2:] == '\\\n':
            nextline = f.readline()
            if not nextline: break
            line = line + nextline
            lineno = lineno + 1
        newline = fixline(line)
        if newline != line:
            if g is None:
                try:
                    g = open(tempname, 'w')
120
                except IOError as msg:
Tim Peters's avatar
Tim Peters committed
121
                    f.close()
122
                    err('%s: cannot create: %r\n' % (tempname, msg))
Tim Peters's avatar
Tim Peters committed
123 124 125 126 127
                    return 1
                f.seek(0)
                lineno = 0
                rep(filename + ':\n')
                continue # restart from the beginning
128
            rep(repr(lineno) + '\n')
Tim Peters's avatar
Tim Peters committed
129 130 131 132
            rep('< ' + line)
            rep('> ' + newline)
        if g is not None:
            g.write(newline)
Guido van Rossum's avatar
Guido van Rossum committed
133

Tim Peters's avatar
Tim Peters committed
134 135 136
    # End of file
    f.close()
    if not g: return 0 # No changes
Guido van Rossum's avatar
Guido van Rossum committed
137

Tim Peters's avatar
Tim Peters committed
138 139 140 141 142
    # Finishing touch -- move files

    # First copy the file's mode to the temp file
    try:
        statbuf = os.stat(filename)
143
        os.chmod(tempname, statbuf[ST_MODE] & 0o7777)
144
    except os.error as msg:
145
        err('%s: warning: chmod failed (%r)\n' % (tempname, msg))
Tim Peters's avatar
Tim Peters committed
146 147 148
    # Then make a backup of the original file as filename~
    try:
        os.rename(filename, filename + '~')
149
    except os.error as msg:
150
        err('%s: warning: backup failed (%r)\n' % (filename, msg))
Tim Peters's avatar
Tim Peters committed
151 152 153
    # Now move the temp file to the original file
    try:
        os.rename(tempname, filename)
154
    except os.error as msg:
155
        err('%s: rename failed (%r)\n' % (filename, msg))
Tim Peters's avatar
Tim Peters committed
156 157 158
        return 1
    # Return succes
    return 0
Guido van Rossum's avatar
Guido van Rossum committed
159 160


161 162
fixpat = '^[ \t]+def +[a-zA-Z0-9_]+ *( *self *, *(( *(.*) *)) *) *:'
fixprog = re.compile(fixpat)
Guido van Rossum's avatar
Guido van Rossum committed
163 164

def fixline(line):
Tim Peters's avatar
Tim Peters committed
165 166 167 168
    if fixprog.match(line) >= 0:
        (a, b), (c, d) = fixprog.regs[1:3]
        line = line[:a] + line[c:d] + line[b:]
    return line
Guido van Rossum's avatar
Guido van Rossum committed
169

170 171
if __name__ == '__main__':
    main()