1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
#!/usr/bin/env python
import glob
import os
import sys
import subprocess
import packaging.version
from argparse import ArgumentParser
from get_submodule_paths import get_submodule_paths
CONFIG = os.path.join(
os.path.abspath(os.path.dirname(__file__)),
'lint.toml',
)
def rev_list(branch, num_commits):
"""List commits in reverse chronological order.
Only the first `num_commits` are shown.
"""
res = subprocess.run(
[
'git',
'rev-list',
'--max-count',
f'{num_commits}',
'--first-parent',
branch
],
stdout=subprocess.PIPE,
encoding='utf-8',
)
res.check_returncode()
return res.stdout.rstrip('\n').split('\n')
def find_branch_point(branch):
"""Find when the current branch split off from the given branch.
It is based off of this Stackoverflow post:
https://stackoverflow.com/questions/1527234/finding-a-branch-point-with-git#4991675
"""
branch_commits = rev_list('HEAD', 1000)
main_commits = set(rev_list(branch, 1000))
for branch_commit in branch_commits:
if branch_commit in main_commits:
return branch_commit
# If a branch split off over 1000 commits ago we will fail to find
# the ancestor.
raise RuntimeError(
'Failed to find a common ancestor in the last 1000 commits'
)
def diff_files(sha):
"""Find the diff since the given SHA."""
res = subprocess.run(
['git', 'diff', '--name-only', '--diff-filter=ACMR', '-z', sha, '--',
'*.py', '*.pyx', '*.pxd', '*.pxi'],
stdout=subprocess.PIPE,
encoding='utf-8'
)
res.check_returncode()
return [f for f in res.stdout.split('\0') if f]
def run_ruff(files, fix):
if not files:
return 0, ""
args = ['--fix', '--exit-non-zero-on-fix'] if fix else []
res = subprocess.run(
['ruff', 'check', f'--config={CONFIG}'] + args + list(files),
stdout=subprocess.PIPE,
encoding='utf-8'
)
return res.returncode, res.stdout
def run_ruff_all(fix):
args = ['--fix', '--exit-non-zero-on-fix'] if fix else []
submodule_paths = get_submodule_paths()
args += [f'--extend-exclude={p}' for p in submodule_paths]
res = subprocess.run(
['ruff', 'check', f'--config={CONFIG}'] + args,
stdout=subprocess.PIPE,
encoding='utf-8'
)
return res.returncode, res.stdout
def run_cython_lint(files):
if not files:
return 0, ""
res = subprocess.run(
['cython-lint', '--no-pycodestyle'] + list(files),
stdout=subprocess.PIPE,
encoding='utf-8'
)
return res.returncode, res.stdout
def run_cython_lint_all():
pyx_files = glob.glob("**/*.pyx", recursive=True)
pxd_files = glob.glob("**/*.pxd", recursive=True)
pxi_files = glob.glob("**/*.pxi", recursive=True)
files = pyx_files + pxd_files + pxi_files
res = subprocess.run(
['cython-lint', '--no-pycodestyle'] + files,
stdout=subprocess.PIPE,
encoding='utf-8'
)
return res.returncode, res.stdout
def check_ruff_version():
min_version = packaging.version.parse('0.0.292')
res = subprocess.run(
['ruff', '--version'],
stdout=subprocess.PIPE,
encoding='utf-8'
)
version = res.stdout.replace('ruff ', '')
if packaging.version.parse(version) < min_version:
raise RuntimeError("Linting requires `ruff>=0.0.292`. Please upgrade `ruff`.")
def main():
check_ruff_version()
parser = ArgumentParser(description="Also see `pre-commit-hook.py` which "
"lints all files staged in git.")
# In Python 3.9, can use: argparse.BooleanOptionalAction
parser.add_argument("--fix", action='store_true',
help='Attempt to fix linting violations')
parser.add_argument("--diff-against", dest='branch',
type=str, default=None,
help="Diff against "
"this branch and lint modified files. Use either "
"`--diff-against` or `--files`, but not both.")
parser.add_argument("--files", nargs='*',
help="Lint these files or directories; "
"use **/*.py to lint all files")
parser.add_argument("--all", action='store_true',
help="This overrides `--diff-against` and `--files` "
"to lint all local files (excluding subprojects).")
parser.add_argument("--no-cython", dest='cython', action='store_false',
help="Do not run cython-lint.")
args = parser.parse_args()
if args.all:
if args.cython:
rc_cy, errors = run_cython_lint_all()
if errors:
print(errors)
else:
rc_cy = 0
rc, errors = run_ruff_all(fix=args.fix)
if errors:
print(errors)
if rc == 0 and rc_cy != 0:
rc = rc_cy
sys.exit(rc)
if not ((args.files is None) ^ (args.branch is None)):
print('Specify either `--diff-against` or `--files`. Aborting.')
sys.exit(1)
if args.branch:
branch_point = find_branch_point(args.branch)
files = diff_files(branch_point)
else:
files = args.files
# Remove any files from submodules
root_dir = os.path.dirname(os.path.dirname(__file__))
submodule_paths = get_submodule_paths()
files = [f for f in files if all(submodule_path not in os.path.join(root_dir, f)
for submodule_path in submodule_paths)]
cython_exts = ('.pyx', '.pxd', '.pxi')
cython_files = {f for f in files if any(f.endswith(ext) for ext in cython_exts)}
other_files = set(files) - cython_files
if args.cython:
rc_cy, errors = run_cython_lint(cython_files)
if errors:
print(errors)
rc, errors = run_ruff(other_files, fix=args.fix)
if errors:
print(errors)
if args.cython:
if rc == 0 and rc_cy != 0:
rc = rc_cy
sys.exit(rc)
if __name__ == '__main__':
main()
|
