285 lines
9.8 KiB
Python
285 lines
9.8 KiB
Python
#!/usr/bin/env python3
|
|
"""Check proposed changes for common issues."""
|
|
import re
|
|
import sys
|
|
import shutil
|
|
import os.path
|
|
import subprocess
|
|
import sysconfig
|
|
|
|
import reindent
|
|
import untabify
|
|
|
|
|
|
# Excluded directories which are copies of external libraries:
|
|
# don't check their coding style
|
|
EXCLUDE_DIRS = [os.path.join('Modules', '_ctypes', 'libffi_osx'),
|
|
os.path.join('Modules', '_ctypes', 'libffi_msvc'),
|
|
os.path.join('Modules', '_decimal', 'libmpdec'),
|
|
os.path.join('Modules', 'expat'),
|
|
os.path.join('Modules', 'zlib')]
|
|
SRCDIR = sysconfig.get_config_var('srcdir')
|
|
|
|
|
|
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
|
|
|
|
|
|
def get_git_branch():
|
|
"""Get the symbolic name for the current git branch"""
|
|
cmd = "git rev-parse --abbrev-ref HEAD".split()
|
|
try:
|
|
return subprocess.check_output(cmd,
|
|
stderr=subprocess.DEVNULL,
|
|
cwd=SRCDIR)
|
|
except subprocess.CalledProcessError:
|
|
return None
|
|
|
|
|
|
def get_git_upstream_remote():
|
|
"""Get the remote name to use for upstream branches
|
|
|
|
Uses "upstream" if it exists, "origin" otherwise
|
|
"""
|
|
cmd = "git remote get-url upstream".split()
|
|
try:
|
|
subprocess.check_output(cmd,
|
|
stderr=subprocess.DEVNULL,
|
|
cwd=SRCDIR)
|
|
except subprocess.CalledProcessError:
|
|
return "origin"
|
|
return "upstream"
|
|
|
|
|
|
@status("Getting base branch for PR",
|
|
info=lambda x: x if x is not None else "not a PR branch")
|
|
def get_base_branch():
|
|
if not os.path.exists(os.path.join(SRCDIR, '.git')):
|
|
# Not a git checkout, so there's no base branch
|
|
return None
|
|
version = sys.version_info
|
|
if version.releaselevel == 'alpha':
|
|
base_branch = "master"
|
|
else:
|
|
base_branch = "{0.major}.{0.minor}".format(version)
|
|
this_branch = get_git_branch()
|
|
if this_branch is None or this_branch == base_branch:
|
|
# Not on a git PR branch, so there's no base branch
|
|
return None
|
|
upstream_remote = get_git_upstream_remote()
|
|
return upstream_remote + "/" + base_branch
|
|
|
|
|
|
@status("Getting the list of files that have been added/changed",
|
|
info=lambda x: n_files_str(len(x)))
|
|
def changed_files(base_branch=None):
|
|
"""Get the list of changed or added files from git."""
|
|
if os.path.exists(os.path.join(SRCDIR, '.git')):
|
|
# We just use an existence check here as:
|
|
# directory = normal git checkout/clone
|
|
# file = git worktree directory
|
|
if base_branch:
|
|
cmd = 'git diff --name-status ' + base_branch
|
|
else:
|
|
cmd = 'git status --porcelain'
|
|
filenames = []
|
|
with subprocess.Popen(cmd.split(),
|
|
stdout=subprocess.PIPE,
|
|
cwd=SRCDIR) as st:
|
|
for line in st.stdout:
|
|
line = line.decode().rstrip()
|
|
status_text, filename = line.split(maxsplit=1)
|
|
status = set(status_text)
|
|
# modified, added or unmerged files
|
|
if not status.intersection('MAU'):
|
|
continue
|
|
if ' -> ' in filename:
|
|
# file is renamed
|
|
filename = filename.split(' -> ', 2)[1].strip()
|
|
filenames.append(filename)
|
|
else:
|
|
sys.exit('need a git checkout to get modified files')
|
|
|
|
filenames2 = []
|
|
for filename in filenames:
|
|
# Normalize the path to be able to match using .startswith()
|
|
filename = os.path.normpath(filename)
|
|
if any(filename.startswith(path) for path in EXCLUDE_DIRS):
|
|
# Exclude the file
|
|
continue
|
|
filenames2.append(filename)
|
|
|
|
return filenames2
|
|
|
|
|
|
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 Python file 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 = [path for path in file_paths if path.endswith('.py') and
|
|
reindent.check(os.path.join(SRCDIR, 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:
|
|
abspath = os.path.join(SRCDIR, path)
|
|
with open(abspath, 'r') as f:
|
|
if '\t' not in f.read():
|
|
continue
|
|
untabify.process(abspath, 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:
|
|
abspath = os.path.join(SRCDIR, path)
|
|
try:
|
|
with open(abspath, 'rb') as f:
|
|
lines = f.readlines()
|
|
new_lines = [ws_re.sub(br'\1', line) for line in lines]
|
|
if new_lines != lines:
|
|
shutil.copyfile(abspath, abspath + '.bak')
|
|
with open(abspath, '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 os.path.join('Misc', 'ACKS') in file_paths
|
|
|
|
|
|
@status("Misc/NEWS.d updated with `blurb`", modal=True)
|
|
def reported_news(file_paths):
|
|
"""Check if Misc/NEWS.d has been changed."""
|
|
return any(p.startswith(os.path.join('Misc', 'NEWS.d', 'next'))
|
|
for p in file_paths)
|
|
|
|
@status("configure regenerated", modal=True, info=str)
|
|
def regenerated_configure(file_paths):
|
|
"""Check if configure has been regenerated."""
|
|
if 'configure.ac' in file_paths:
|
|
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."""
|
|
if 'configure.ac' in file_paths:
|
|
return "yes" if 'pyconfig.h.in' in file_paths else "no"
|
|
else:
|
|
return "not needed"
|
|
|
|
def travis(pull_request):
|
|
if pull_request == 'false':
|
|
print('Not a pull request; skipping')
|
|
return
|
|
base_branch = get_base_branch()
|
|
file_paths = changed_files(base_branch)
|
|
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') and
|
|
fn.endswith(('.rst', '.inc'))]
|
|
fixed = []
|
|
fixed.extend(normalize_whitespace(python_files))
|
|
fixed.extend(normalize_c_whitespace(c_files))
|
|
fixed.extend(normalize_docs_whitespace(doc_files))
|
|
if not fixed:
|
|
print('No whitespace issues found')
|
|
else:
|
|
print(f'Please fix the {len(fixed)} file(s) with whitespace issues')
|
|
print('(on UNIX you can run `make patchcheck` to make the fixes)')
|
|
sys.exit(1)
|
|
|
|
def main():
|
|
base_branch = get_base_branch()
|
|
file_paths = changed_files(base_branch)
|
|
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') and
|
|
fn.endswith(('.rst', '.inc'))]
|
|
misc_files = {p for p in file_paths if p.startswith('Misc')}
|
|
# 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(misc_files)
|
|
# Misc/NEWS changed.
|
|
reported_news(misc_files)
|
|
# Regenerated configure, if necessary.
|
|
regenerated_configure(file_paths)
|
|
# Regenerated pyconfig.h.in, if necessary.
|
|
regenerated_pyconfig_h_in(file_paths)
|
|
|
|
# Test suite run and passed.
|
|
if python_files or c_files:
|
|
end = " and check for refleaks?" if c_files else "?"
|
|
print()
|
|
print("Did you run the test suite" + end)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
import argparse
|
|
parser = argparse.ArgumentParser(description=__doc__)
|
|
parser.add_argument('--travis',
|
|
help='Perform pass/fail checks')
|
|
args = parser.parse_args()
|
|
if args.travis:
|
|
travis(args.travis)
|
|
else:
|
|
main()
|