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
221
222
223
|
#!/usr/bin/env python
"""
Analyze developer allocation across a codebase.
"""
import argparse
import datetime
import logging
import os
import re
import subprocess
import sys
def find_user(line):
"""Given 'Ben Sima <ben@bsima.me>', finds `Ben Sima'. Returns the first
matching string."""
return re.findall(r"^[^<]*", line)[0].strip()
def authors_for(path, active_users):
"""Return a dictionary of {author: commits} for given path. Usernames not in
the 'active_users' list will be filtered out."""
raw = subprocess.check_output(
["git", "shortlog", "--numbered", "--summary", "--email", "--", path]
).decode("utf-8")
lines = [s for s in raw.split("\n") if s]
data = {}
for line in lines:
parts = line.strip().split("\t")
author = find_user(parts[1])
commits = parts[0]
if author in active_users:
data[author] = commits
return data
def mailmap_users():
"""Returns users from the .mailmap file."""
users = []
with open(".mailmap") as file:
lines = file.readlines()
for line in lines:
users.append(find_user(line))
return users
MAX_SCORE = 10
def score(blackhole, liability, good, total):
"Calculate the score."
weights = {
"blackhole": 0.5,
"liability": 0.7,
}
return (
MAX_SCORE
* (
(blackhole * weights["blackhole"])
+ (liability * weights["liability"])
+ good
)
/ total
)
def get_args():
"Parse CLI arguments."
cli = argparse.ArgumentParser(description=__doc__)
cli.add_argument("repo", default=".", help="the git repo to run on", metavar="REPO")
cli.add_argument(
"-b",
"--blackholes",
action="store_true",
help="print the blackholes (files with one or zero active contributors)",
)
cli.add_argument(
"-l",
"--liabilities",
action="store_true",
help="print the liabilities (files with < 3 active contributors)",
)
cli.add_argument(
"-s",
"--stale",
action="store_true",
help="print stale files (haven't been touched in 6 months)",
)
cli.add_argument(
"-i", "--ignored", nargs="+", default=[], help="patterns to ignore in paths",
)
cli.add_argument(
"--active-users",
nargs="+",
default=[],
help="list of active user emails. if not provided, this is loaded from .mailmap",
)
cli.add_argument(
"-v",
"--verbosity",
help="set the log level verbosity",
choices=["debug", "warning", "error"],
default="error",
)
return cli.parse_args()
def guard_git(repo):
"Guard against non-git repos."
is_git = subprocess.run(
["git", "rev-parse"],
stderr=subprocess.PIPE,
stdout=subprocess.PIPE,
check=False,
).returncode
if is_git != 0:
sys.exit(f"error: not a git repository: {repo}")
def staleness(path, now):
timestamp = datetime.datetime.strptime(
subprocess.check_output(["git", "log", "-n1", "--pretty=%aI", path])
.decode("utf-8")
.strip(),
"%Y-%m-%dT%H:%M:%S%z",
)
delta = now - timestamp
if delta.days > 180:
return delta.days
else:
return None
class Repo:
"Represents a repo and stats for the repo."
def __init__(self, ignored_paths, active_users):
self.paths = [
p
for p in subprocess.check_output(["git", "ls-files", "--no-deleted"])
.decode("utf-8")
.split()
if not any(i in p for i in ignored_paths)
]
logging.debug("collecting stats")
self.stats = {}
for path in self.paths:
self.stats[path] = authors_for(path, active_users)
self.blackholes = [path for path, authors in self.stats.items() if not authors]
self.liabilities = {
path: list(authors)
for path, authors in self.stats.items()
if 1 <= len(authors) < 3
}
now = datetime.datetime.utcnow().astimezone()
self.stale = {}
for path, _ in self.stats.items():
_staleness = staleness(path, now)
if _staleness:
self.stale[path] = _staleness
def print_blackholes(self, full):
"Print number of blackholes, or list of all blackholes."
# note: file renames may result in false positives
n_blackhole = len(self.blackholes)
print(f"Blackholes: {n_blackhole}")
if full:
for path in self.blackholes:
print(f" {path}")
def print_liabilities(self, full):
"Print number of liabilities, or list of all liabilities."
n_liabilities = len(self.liabilities)
print(f"Liabilities: {n_liabilities}")
if full:
for path, authors in self.liabilities.items():
print(f" {path} ({', '.join(authors)})")
def print_score(self):
"Print the overall score."
n_total = len(self.stats.keys())
n_blackhole = len(self.blackholes)
n_liabilities = len(self.liabilities)
n_good = n_total - n_blackhole - n_liabilities
print("Total:", n_total)
print(
"Score: {:.2f}/{}".format(
score(n_blackhole, n_liabilities, n_good, n_total), MAX_SCORE
)
)
def print_stale(self, full):
"Print stale files"
n_stale = len(self.stale)
print(f"Stale files: {n_stale}")
if full:
for path, days in self.stale.items():
print(f" {path} ({days} days)")
if __name__ == "__main__":
ARGS = get_args()
logging.basicConfig(stream=sys.stderr, level=ARGS.verbosity.upper())
logging.debug("starting")
os.chdir(os.path.abspath(ARGS.repo))
guard_git(ARGS.repo)
# if no active users provided, load from .mailmap
if ARGS.active_users == []:
if os.path.exists(".mailmap"):
ARGS.active_users = mailmap_users()
# collect data
REPO = Repo(ARGS.ignored, ARGS.active_users)
# print data
REPO.print_score()
REPO.print_blackholes(ARGS.blackholes)
REPO.print_liabilities(ARGS.liabilities)
REPO.print_stale(ARGS.stale)
|
