Welcome, guest | Sign In | My Account | Store | Cart

A Simple Class for Transforming Python Source Files (Python recipe) by Eric Snow
ActiveState Code (http://code.activestate.com/recipes/577788/)

Subclass with some replacements and you are ready to go. If the replacements aren't good enough simply override the transform() method.

Python, 99 lines
Download
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
"""backport module"""

import os
import shutil
import re


class Backport:
    """A simple class for transforming Python source files.

    """

    DEFAULT_PATH = "."
    PYTHON_EXTENSION = "py"
    BACKUP_EXTENSION = "orig"
    REPLACEMENTS = {}
    IGNORE = (__file__,)

    def __init__(self, path=DEFAULT_PATH, filenames=None):
        if filenames is None:
            filenames = self.get_filenames(path)
        self.filenames = filenames

    @classmethod
    def get_filenames(cls, path):
        filenames = os.listdir(path)
        for filename in filenames[:]:
            if filename in cls.IGNORE:
                filenames.remove(filename)
                continue
            try:
                name, ext = filename.rsplit(".", 1)
            except ValueError:
                filenames.remove(filename)
                continue
            if ext == cls.BACKUP_EXTENSION:
                if not name.endswith("."+cls.PYTHON_EXTENSION):
                    filenames.remove(filename)
                elif name.count(".") > 1:
                    filenames.remove(filename)
            elif "." in name:
                filenames.remove(filename)
            elif ext != cls.PYTHON_EXTENSION:
                filenames.remove(filename)
        return filenames

    def backup(self):
        """Generate a backup file for each file."""

        for filename in self.filenames[:]:
            if not filename.endswith("."+self.PYTHON_EXTENSION):
                continue
            origfilename = filename + "." + self.BACKUP_EXTENSION
            if origfilename not in self.filenames:
                shutil.copy(filename, origfilename)
                self.filenames.append(origfilename)

    def restore(self, clean=False):
        """Restore the original files.

        If clean is True, wipe out the backup files.

        """

        for origfilename in self.filenames[:]:
            if not origfilename.endswith("."+self.BACKUP_EXTENSION):
                continue
            filename = origfilename.strip("."+self.BACKUP_EXTENSION)
            shutil.copy(origfilename, filename)
            self.filenames.append(filename)
            if clean:
                os.remove(origfilename)

    def transform(self, source):
        for old, new in self.REPLACEMENTS.items():
            source = re.sub("(?m)"+old, new, source)
        return source

    def run(self, dryrun=True):
        self.backup()
        self.restore()

        for filename in self.filenames:
            if not filename.endswith(self.PYTHON_EXTENSION):
                continue

            infile = open(filename)
            source = infile.read()
            infile.close()

            source = self.transform(source)

            if __debug__:
                print("")
                print(filename + "%%"*50)
                print(source)

            if not dryrun:
                open(filename, "w").write(source)

Example

class MyBackport(Backport):
    REPLACEMENTS = {
             r"^from\s\.\simport\s": r"import ",
             }

backport = MyBackport()
backport.run()
Tags: backport, transform