GeezerVison is showing github.com — cpython/Tools/scripts/patchcheck.py at 2.7 · python/cpython

Expand file tree

patchcheck.py

Copy path

More file actions

Latest commit

History

executable file

235 lines (197 loc) · 7.5 KB

patchcheck.py

Copy path

File metadata and controls

executable file

235 lines (197 loc) · 7.5 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

#!/usr/bin/env python

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'),

os.path.join('Modules', '_ctypes', 'libffi_osx'),

os.path.join('Modules', '_ctypes', 'libffi_msvc'),

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.PIPE)

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.PIPE)

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 = []

st = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)

try:

for line in st.stdout:

line = line.decode().rstrip()

status_text, filename = line.split(None, 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)

finally:

st.stdout.close()

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 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(os.path.join(SRCDIR, 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:

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)

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)

# Test suite run and passed.

if python_files or c_files:

end = " and check for refleaks?" if c_files else "?"

print "Did you run the test suite" + end

if __name__ == '__main__':

main()