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
210
211
212
213
214
215
216
217
218
219
220
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Simple, on demand git checker"""
import argparse
import os
import subprocess
import sys
import git
class ValidationError(Exception):
"""ValidationError"""
def eprint(*arg, **kwargs):
"""stdderr print wrapper"""
print(*arg, file=sys.stderr, flush=True, **kwargs)
def is_git_repo(abspath):
"""
True of abspath points to a git repo, False otherwise
"""
if not os.path.isdir(abspath):
return False
try:
git.Repo(abspath)
return True
except git.InvalidGitRepositoryError:
return False
def modifications_exist(abspath):
"""
True if modifications exist for git repo representing abspath
False if no modifications exist
git.InvalidGitRepositoryError raised if abspath points to illegal repo
"""
repo = git.Repo(abspath)
return bool(repo.is_dirty() or repo.index.diff(None))
def print_modification_status(abspath, status, args):
"""Prints the modification status for the given abspath"""
if status:
if args.verbose:
print(f'{abspath} -> modified')
else:
print(abspath)
return status
if args.verbose:
print(f'{abspath} -> unchanged')
return status
def fetch_git_repos(abspath: str):
"""Returns a list of git repo paths under abspath"""
repo_list = []
for root, dirs, _ in os.walk(abspath):
if '/.git' in root:
continue
if '.git' in dirs:
try:
git.Repo(root)
repo_list.append(root)
except git.InvalidGitRepositoryError:
continue
return repo_list
def fetch_git_files(args):
"""Fetches new and modified .py-files using git"""
try:
repo = git.Repo(args.repo_path)
return [mfile.a_path for mfile in repo.index.diff(None)
if mfile.a_path.lower().endswith('.py')]
except git.InvalidGitRepositoryError:
eprint(f'{args.repo_path} is not a valid git repository')
sys.exit(1)
def fetch_all_files(abspath):
"""Fetches all .py-files"""
all_files_list = []
for root, _, files in os.walk(abspath):
for f in files:
if os.path.splitext(f)[1].lower() == '.py':
all_files_list.append(os.path.join(abspath, root, f))
return all_files_list
def validate_flake8(pfile):
"""Validate using: flake8"""
try:
subprocess.run(['/usr/bin/flake8', pfile], check=True)
return True
except subprocess.CalledProcessError:
return False
def validate_isort(pfile):
"""Validate using: isort --check --diff"""
try:
subprocess.run(['/usr/bin/isort', '--check', '--diff', pfile],
check=True)
return True
except subprocess.CalledProcessError:
return False
def validate_pylint(pfile):
"""Validate using: pylint -r no --exit-zero"""
try:
subprocess.run(['/usr/bin/pylint', '-r', 'no', '--exit-zero', pfile],
check=True)
return True
except subprocess.CalledProcessError:
return False
def validate_python_file(pfile, args):
"""
Validates a single .py file
:return: False if validation fails, False otherwise
:rtype: bool
"""
if not validate_flake8(pfile) and not args.continue_checks:
if args.verbose:
eprint(f'{pfile}: flake8 validation failed')
sys.exit(0)
if not validate_isort(pfile) and not args.continue_checks:
if args.verbose:
eprint(f'{pfile}: isort validation failed')
sys.exit(0)
if not validate_pylint(pfile) and not args.continue_checks:
if args.verbose:
eprint(f'{pfile}: pylint validation failed')
sys.exit(0)
def main(inargs=None):
"""Main entry point"""
parser = argparse.ArgumentParser(
description='The following options are available')
parser.add_argument(
'repo_path',
metavar='REPO',
nargs='?',
default=os.getcwd(),
help='Git repo path (default: cwd)')
parser.add_argument(
'-a', '--all-files',
action='store_true',
dest='all_files',
help='Check all files, not only the modified ones')
parser.add_argument(
'-c', '--continue-checks',
action='store_true',
dest='continue_checks',
help='Continue with the checks if validation fails')
parser.add_argument(
'-f', '--full',
action='store_true',
dest='full_search',
help='Consider repos that contain untracked files (used with -m)')
parser.add_argument(
'-m', '--modifications-only',
action='store_true',
dest='mod_only',
help='Only check for git modifications')
parser.add_argument(
'-r', '--recursive',
action='store_true',
dest='recursive',
help='Look for several repos recursively')
parser.add_argument(
'-v', '--verbose',
action='store_true',
dest='verbose',
help='Verbosity')
args = parser.parse_args(inargs)
abs_repo_path = os.path.abspath(os.path.expanduser(args.repo_path))
if args.mod_only:
if not args.recursive:
if not is_git_repo(abs_repo_path):
eprint(f'{abs_repo_path} is not a valid git repository')
sys.exit(1)
print_modification_status(abs_repo_path,
modifications_exist(abs_repo_path),
args)
sys.exit(0)
# resursive
repo_list = fetch_git_repos(abs_repo_path)
if not repo_list:
print('No git-repos found')
sys.exit(0)
repo_list.sort()
for repo_path in repo_list:
print_modification_status(repo_path,
modifications_exist(repo_path),
args)
sys.exit(0)
if args.all_files:
selected_files = fetch_all_files(abs_repo_path)
else:
selected_files = fetch_git_files(args)
if not selected_files:
print('No files selected')
sys.exit(0)
for target_file in selected_files:
if args.verbose:
print(f'Validating {target_file}:')
validate_python_file(target_file, args)
if __name__ == '__main__':
main()
|
