Éric Araujo | a0e92a8 | 2011-07-26 18:01:08 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 2 | import re |
| 3 | import sys |
| 4 | import shutil |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 5 | import os.path |
| 6 | import subprocess |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 7 | import sysconfig |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 8 | |
| 9 | import reindent |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 10 | import untabify |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 11 | |
| 12 | |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 13 | SRCDIR = sysconfig.get_config_var('srcdir') |
| 14 | |
| 15 | |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 16 | def n_files_str(count): |
| 17 | """Return 'N file(s)' with the proper plurality on 'file'.""" |
| 18 | return "{} file{}".format(count, "s" if count != 1 else "") |
| 19 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 20 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 21 | def status(message, modal=False, info=None): |
| 22 | """Decorator to output status info to stdout.""" |
| 23 | def decorated_fxn(fxn): |
| 24 | def call_fxn(*args, **kwargs): |
| 25 | sys.stdout.write(message + ' ... ') |
| 26 | sys.stdout.flush() |
| 27 | result = fxn(*args, **kwargs) |
| 28 | if not modal and not info: |
| 29 | print("done") |
| 30 | elif info: |
| 31 | print(info(result)) |
| 32 | else: |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 33 | print("yes" if result else "NO") |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 34 | return result |
| 35 | return call_fxn |
| 36 | return decorated_fxn |
| 37 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 38 | |
Nadeem Vawda | 9f64f73 | 2012-02-22 11:46:41 +0200 | [diff] [blame] | 39 | def mq_patches_applied(): |
| 40 | """Check if there are any applied MQ patches.""" |
| 41 | cmd = 'hg qapplied' |
| 42 | with subprocess.Popen(cmd.split(), |
| 43 | stdout=subprocess.PIPE, |
| 44 | stderr=subprocess.PIPE) as st: |
| 45 | bstdout, _ = st.communicate() |
| 46 | return st.returncode == 0 and bstdout |
| 47 | |
| 48 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 49 | @status("Getting the list of files that have been added/changed", |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 50 | info=lambda x: n_files_str(len(x))) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 51 | def changed_files(): |
Éric Araujo | 56ec5fe | 2011-07-31 18:41:25 +0200 | [diff] [blame] | 52 | """Get the list of changed or added files from Mercurial.""" |
| 53 | if not os.path.isdir(os.path.join(SRCDIR, '.hg')): |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 54 | sys.exit('need a checkout to get modified files') |
| 55 | |
Éric Araujo | 56ec5fe | 2011-07-31 18:41:25 +0200 | [diff] [blame] | 56 | cmd = 'hg status --added --modified --no-status' |
Nadeem Vawda | 6721149 | 2012-02-22 11:53:09 +0200 | [diff] [blame] | 57 | if mq_patches_applied(): |
| 58 | cmd += ' --rev qparent' |
Éric Araujo | 56ec5fe | 2011-07-31 18:41:25 +0200 | [diff] [blame] | 59 | with subprocess.Popen(cmd.split(), stdout=subprocess.PIPE) as st: |
Benjamin Peterson | 4177eff | 2011-06-27 18:25:06 -0500 | [diff] [blame] | 60 | return [x.decode().rstrip() for x in st.stdout] |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 61 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 62 | |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 63 | def report_modified_files(file_paths): |
| 64 | count = len(file_paths) |
| 65 | if count == 0: |
| 66 | return n_files_str(count) |
| 67 | else: |
| 68 | lines = ["{}:".format(n_files_str(count))] |
| 69 | for path in file_paths: |
| 70 | lines.append(" {}".format(path)) |
| 71 | return "\n".join(lines) |
| 72 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 73 | |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 74 | @status("Fixing whitespace", info=report_modified_files) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 75 | def normalize_whitespace(file_paths): |
| 76 | """Make sure that the whitespace for .py files have been normalized.""" |
| 77 | reindent.makebackup = False # No need to create backups. |
Benjamin Peterson | 4177eff | 2011-06-27 18:25:06 -0500 | [diff] [blame] | 78 | fixed = [path for path in file_paths if path.endswith('.py') and |
Éric Araujo | ad548b8 | 2011-07-31 18:33:00 +0200 | [diff] [blame] | 79 | reindent.check(os.path.join(SRCDIR, path))] |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 80 | return fixed |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 81 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 82 | |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 83 | @status("Fixing C file whitespace", info=report_modified_files) |
| 84 | def normalize_c_whitespace(file_paths): |
| 85 | """Report if any C files """ |
| 86 | fixed = [] |
| 87 | for path in file_paths: |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 88 | abspath = os.path.join(SRCDIR, path) |
| 89 | with open(abspath, 'r') as f: |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 90 | if '\t' not in f.read(): |
| 91 | continue |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 92 | untabify.process(abspath, 8, verbose=False) |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 93 | fixed.append(path) |
| 94 | return fixed |
| 95 | |
| 96 | |
| 97 | ws_re = re.compile(br'\s+(\r?\n)$') |
| 98 | |
| 99 | @status("Fixing docs whitespace", info=report_modified_files) |
| 100 | def normalize_docs_whitespace(file_paths): |
| 101 | fixed = [] |
| 102 | for path in file_paths: |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 103 | abspath = os.path.join(SRCDIR, path) |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 104 | try: |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 105 | with open(abspath, 'rb') as f: |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 106 | lines = f.readlines() |
| 107 | new_lines = [ws_re.sub(br'\1', line) for line in lines] |
| 108 | if new_lines != lines: |
Éric Araujo | a3e072b | 2011-07-30 21:34:04 +0200 | [diff] [blame] | 109 | shutil.copyfile(abspath, abspath + '.bak') |
| 110 | with open(abspath, 'wb') as f: |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 111 | f.writelines(new_lines) |
| 112 | fixed.append(path) |
| 113 | except Exception as err: |
| 114 | print('Cannot fix %s: %s' % (path, err)) |
| 115 | return fixed |
| 116 | |
| 117 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 118 | @status("Docs modified", modal=True) |
| 119 | def docs_modified(file_paths): |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 120 | """Report if any file in the Doc directory has been changed.""" |
| 121 | return bool(file_paths) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 122 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 123 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 124 | @status("Misc/ACKS updated", modal=True) |
| 125 | def credit_given(file_paths): |
| 126 | """Check if Misc/ACKS has been changed.""" |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 127 | return 'Misc/ACKS' in file_paths |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 128 | |
Florent Xicluna | e4a3380 | 2010-08-09 12:24:20 +0000 | [diff] [blame] | 129 | |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 130 | @status("Misc/NEWS updated", modal=True) |
| 131 | def reported_news(file_paths): |
| 132 | """Check if Misc/NEWS has been changed.""" |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 133 | return 'Misc/NEWS' in file_paths |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 134 | |
| 135 | |
| 136 | def main(): |
| 137 | file_paths = changed_files() |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 138 | python_files = [fn for fn in file_paths if fn.endswith('.py')] |
| 139 | c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))] |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 140 | doc_files = [fn for fn in file_paths if fn.startswith('Doc')] |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 141 | special_files = {'Misc/ACKS', 'Misc/NEWS'} & set(file_paths) |
| 142 | # PEP 8 whitespace rules enforcement. |
| 143 | normalize_whitespace(python_files) |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 144 | # C rules enforcement. |
| 145 | normalize_c_whitespace(c_files) |
| 146 | # Doc whitespace enforcement. |
| 147 | normalize_docs_whitespace(doc_files) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 148 | # Docs updated. |
Georg Brandl | a9afb68 | 2010-10-21 12:49:28 +0000 | [diff] [blame] | 149 | docs_modified(doc_files) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 150 | # Misc/ACKS changed. |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 151 | credit_given(special_files) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 152 | # Misc/NEWS changed. |
Brett Cannon | 058173e | 2010-07-04 22:05:34 +0000 | [diff] [blame] | 153 | reported_news(special_files) |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 154 | |
| 155 | # Test suite run and passed. |
Éric Araujo | fbc5ff6 | 2011-08-12 17:50:08 +0200 | [diff] [blame] | 156 | if python_files or c_files: |
| 157 | print() |
| 158 | print("Did you run the test suite?") |
Christian Heimes | ada8c3b | 2008-03-18 18:26:33 +0000 | [diff] [blame] | 159 | |
| 160 | |
| 161 | if __name__ == '__main__': |
| 162 | main() |