patchcheck.py 5.69 KB
Newer Older
1
#!/usr/bin/env python3
2 3 4
import re
import sys
import shutil
5 6
import os.path
import subprocess
7
import sysconfig
8 9

import reindent
10
import untabify
11 12


13 14 15
SRCDIR = sysconfig.get_config_var('srcdir')


16 17 18 19
def n_files_str(count):
    """Return 'N file(s)' with the proper plurality on 'file'."""
    return "{} file{}".format(count, "s" if count != 1 else "")

20

21 22 23 24 25 26 27 28 29 30 31 32
def status(message, modal=False, info=None):
    """Decorator to output status info to stdout."""
    def decorated_fxn(fxn):
        def call_fxn(*args, **kwargs):
            sys.stdout.write(message + ' ... ')
            sys.stdout.flush()
            result = fxn(*args, **kwargs)
            if not modal and not info:
                print("done")
            elif info:
                print(info(result))
            else:
33
                print("yes" if result else "NO")
34 35 36 37
            return result
        return call_fxn
    return decorated_fxn

38

39 40 41 42 43 44 45 46 47 48
def mq_patches_applied():
    """Check if there are any applied MQ patches."""
    cmd = 'hg qapplied'
    with subprocess.Popen(cmd.split(),
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE) as st:
        bstdout, _ = st.communicate()
        return st.returncode == 0 and bstdout


49
@status("Getting the list of files that have been added/changed",
50
        info=lambda x: n_files_str(len(x)))
51
def changed_files():
Éric Araujo's avatar
Éric Araujo committed
52 53
    """Get the list of changed or added files from Mercurial."""
    if not os.path.isdir(os.path.join(SRCDIR, '.hg')):
54 55
        sys.exit('need a checkout to get modified files')

Éric Araujo's avatar
Éric Araujo committed
56
    cmd = 'hg status --added --modified --no-status'
57 58
    if mq_patches_applied():
        cmd += ' --rev qparent'
Éric Araujo's avatar
Éric Araujo committed
59
    with subprocess.Popen(cmd.split(), stdout=subprocess.PIPE) as st:
Benjamin Peterson's avatar
Benjamin Peterson committed
60
        return [x.decode().rstrip() for x in st.stdout]
61

62

63 64 65 66 67 68 69 70 71 72
def report_modified_files(file_paths):
    count = len(file_paths)
    if count == 0:
        return n_files_str(count)
    else:
        lines = ["{}:".format(n_files_str(count))]
        for path in file_paths:
            lines.append("  {}".format(path))
        return "\n".join(lines)

73

74
@status("Fixing whitespace", info=report_modified_files)
75 76 77
def normalize_whitespace(file_paths):
    """Make sure that the whitespace for .py files have been normalized."""
    reindent.makebackup = False  # No need to create backups.
Benjamin Peterson's avatar
Benjamin Peterson committed
78
    fixed = [path for path in file_paths if path.endswith('.py') and
79
             reindent.check(os.path.join(SRCDIR, path))]
80
    return fixed
81

82

83 84 85 86 87
@status("Fixing C file whitespace", info=report_modified_files)
def normalize_c_whitespace(file_paths):
    """Report if any C files """
    fixed = []
    for path in file_paths:
88 89
        abspath = os.path.join(SRCDIR, path)
        with open(abspath, 'r') as f:
90 91
            if '\t' not in f.read():
                continue
92
        untabify.process(abspath, 8, verbose=False)
93 94 95 96 97 98 99 100 101 102
        fixed.append(path)
    return fixed


ws_re = re.compile(br'\s+(\r?\n)$')

@status("Fixing docs whitespace", info=report_modified_files)
def normalize_docs_whitespace(file_paths):
    fixed = []
    for path in file_paths:
103
        abspath = os.path.join(SRCDIR, path)
104
        try:
105
            with open(abspath, 'rb') as f:
106 107 108
                lines = f.readlines()
            new_lines = [ws_re.sub(br'\1', line) for line in lines]
            if new_lines != lines:
109 110
                shutil.copyfile(abspath, abspath + '.bak')
                with open(abspath, 'wb') as f:
111 112 113 114 115 116 117
                    f.writelines(new_lines)
                fixed.append(path)
        except Exception as err:
            print('Cannot fix %s: %s' % (path, err))
    return fixed


118 119
@status("Docs modified", modal=True)
def docs_modified(file_paths):
120 121
    """Report if any file in the Doc directory has been changed."""
    return bool(file_paths)
122

123

124 125 126
@status("Misc/ACKS updated", modal=True)
def credit_given(file_paths):
    """Check if Misc/ACKS has been changed."""
127
    return os.path.join('Misc', 'ACKS') in file_paths
128

129

130 131 132
@status("Misc/NEWS updated", modal=True)
def reported_news(file_paths):
    """Check if Misc/NEWS has been changed."""
133
    return os.path.join('Misc', 'NEWS') in file_paths
134

135 136 137
@status("configure regenerated", modal=True, info=str)
def regenerated_configure(file_paths):
    """Check if configure has been regenerated."""
Matthias Klose's avatar
Matthias Klose committed
138
    if 'configure.ac' in file_paths:
139 140 141 142 143 144 145
        return "yes" if 'configure' in file_paths else "no"
    else:
        return "not needed"

@status("pyconfig.h.in regenerated", modal=True, info=str)
def regenerated_pyconfig_h_in(file_paths):
    """Check if pyconfig.h.in has been regenerated."""
Matthias Klose's avatar
Matthias Klose committed
146
    if 'configure.ac' in file_paths:
147 148 149
        return "yes" if 'pyconfig.h.in' in file_paths else "no"
    else:
        return "not needed"
150 151 152

def main():
    file_paths = changed_files()
153 154
    python_files = [fn for fn in file_paths if fn.endswith('.py')]
    c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))]
155
    doc_files = [fn for fn in file_paths if fn.startswith('Doc')]
156 157
    misc_files = {os.path.join('Misc', 'ACKS'), os.path.join('Misc', 'NEWS')}\
            & set(file_paths)
158 159
    # PEP 8 whitespace rules enforcement.
    normalize_whitespace(python_files)
160 161 162 163
    # C rules enforcement.
    normalize_c_whitespace(c_files)
    # Doc whitespace enforcement.
    normalize_docs_whitespace(doc_files)
164
    # Docs updated.
165
    docs_modified(doc_files)
166
    # Misc/ACKS changed.
167
    credit_given(misc_files)
168
    # Misc/NEWS changed.
169
    reported_news(misc_files)
170 171 172 173
    # Regenerated configure, if necessary.
    regenerated_configure(file_paths)
    # Regenerated pyconfig.h.in, if necessary.
    regenerated_pyconfig_h_in(file_paths)
174 175

    # Test suite run and passed.
176
    if python_files or c_files:
177
        end = " and check for refleaks?" if c_files else "?"
178
        print()
179
        print("Did you run the test suite" + end)
180 181 182 183


if __name__ == '__main__':
    main()