159 lines
4.6 KiB
Python
159 lines
4.6 KiB
Python
import re
|
|
import sys
|
|
import shutil
|
|
import os.path
|
|
import subprocess
|
|
|
|
import reindent
|
|
import untabify
|
|
|
|
|
|
def n_files_str(count):
|
|
"""Return 'N file(s)' with the proper plurality on 'file'."""
|
|
return "{} file{}".format(count, "s" if count != 1 else "")
|
|
|
|
|
|
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:
|
|
print("yes" if result else "NO")
|
|
return result
|
|
return call_fxn
|
|
return decorated_fxn
|
|
|
|
|
|
@status("Getting the list of files that have been added/changed",
|
|
info=lambda x: n_files_str(len(x)))
|
|
def changed_files():
|
|
"""Get the list of changed or added files from the VCS."""
|
|
if os.path.isdir('.hg'):
|
|
vcs = 'hg'
|
|
cmd = 'hg status --added --modified --no-status'
|
|
elif os.path.isdir('.svn'):
|
|
vcs = 'svn'
|
|
cmd = 'svn status --quiet --non-interactive --ignore-externals'
|
|
else:
|
|
sys.exit('need a checkout to get modified files')
|
|
|
|
st = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
|
|
try:
|
|
st.wait()
|
|
if vcs == 'hg':
|
|
return [x.decode().rstrip() for x in st.stdout]
|
|
else:
|
|
output = (x.decode().rstrip().rsplit(None, 1)[-1]
|
|
for x in st.stdout if x[0] in b'AM')
|
|
return set(path for path in output if os.path.isfile(path))
|
|
finally:
|
|
st.stdout.close()
|
|
|
|
|
|
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)
|
|
|
|
|
|
@status("Fixing whitespace", info=report_modified_files)
|
|
def normalize_whitespace(file_paths):
|
|
"""Make sure that the whitespace for .py files have been normalized."""
|
|
reindent.makebackup = False # No need to create backups.
|
|
fixed = []
|
|
for path in (x for x in file_paths if x.endswith('.py')):
|
|
if reindent.check(path):
|
|
fixed.append(path)
|
|
return fixed
|
|
|
|
|
|
@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:
|
|
with open(path, 'r') as f:
|
|
if '\t' not in f.read():
|
|
continue
|
|
untabify.process(path, 8, verbose=False)
|
|
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:
|
|
try:
|
|
with open(path, 'rb') as f:
|
|
lines = f.readlines()
|
|
new_lines = [ws_re.sub(br'\1', line) for line in lines]
|
|
if new_lines != lines:
|
|
shutil.copyfile(path, path + '.bak')
|
|
with open(path, 'wb') as f:
|
|
f.writelines(new_lines)
|
|
fixed.append(path)
|
|
except Exception as err:
|
|
print('Cannot fix %s: %s' % (path, err))
|
|
return fixed
|
|
|
|
|
|
@status("Docs modified", modal=True)
|
|
def docs_modified(file_paths):
|
|
"""Report if any file in the Doc directory has been changed."""
|
|
return bool(file_paths)
|
|
|
|
|
|
@status("Misc/ACKS updated", modal=True)
|
|
def credit_given(file_paths):
|
|
"""Check if Misc/ACKS has been changed."""
|
|
return 'Misc/ACKS' in file_paths
|
|
|
|
|
|
@status("Misc/NEWS updated", modal=True)
|
|
def reported_news(file_paths):
|
|
"""Check if Misc/NEWS has been changed."""
|
|
return 'Misc/NEWS' in file_paths
|
|
|
|
|
|
def main():
|
|
file_paths = changed_files()
|
|
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'))]
|
|
doc_files = [fn for fn in file_paths if fn.startswith('Doc')]
|
|
special_files = {'Misc/ACKS', 'Misc/NEWS'} & set(file_paths)
|
|
# PEP 8 whitespace rules enforcement.
|
|
normalize_whitespace(python_files)
|
|
# C rules enforcement.
|
|
normalize_c_whitespace(c_files)
|
|
# Doc whitespace enforcement.
|
|
normalize_docs_whitespace(doc_files)
|
|
# Docs updated.
|
|
docs_modified(doc_files)
|
|
# Misc/ACKS changed.
|
|
credit_given(special_files)
|
|
# Misc/NEWS changed.
|
|
reported_news(special_files)
|
|
|
|
# Test suite run and passed.
|
|
print()
|
|
print("Did you run the test suite?")
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|