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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
# SPDX-FileCopyrightText: 2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
# Simple module for inspecting git commits
import os
import subprocess
import datetime
import re
from typing import (
List,
Union,
Optional,
Tuple,
)
_GIT_COMMIT_COAUTHORS_RE = re.compile(r"^Co-authored-by:[ \t]*([^\n]+)$", re.MULTILINE)
class GitCommit:
__slots__ = (
"sha1",
# to extract more info
"_git_dir",
# cached values
"_author",
"_date",
"_body",
"_files",
"_files_status",
"_diff",
)
def __init__(self, sha1: bytes, git_dir: str):
self.sha1 = sha1
self._git_dir = git_dir
self._author: Optional[str] = None
self._date: Optional[datetime.datetime] = None
self._body: Optional[str] = None
self._files: Optional[List[bytes]] = None
self._files_status: Optional[List[List[bytes]]] = None
self._diff: Optional[str] = None
def cache(self) -> None:
"""
Cache all properties
(except for diff as it's significantly larger than other members).
"""
self.author
self.date
self.body
self.files
self.files_status
def _log_format(
self,
format: str,
*,
args_prefix: Tuple[Union[str, bytes], ...] = (),
args_suffix: Tuple[Union[str, bytes], ...] = (),
) -> bytes:
# sha1 = self.sha1.decode('ascii')
cmd: Tuple[Union[str, bytes], ...] = (
"git",
*args_prefix,
"--git-dir",
self._git_dir,
"log",
"-1", # only this rev
self.sha1,
"--format=" + format,
*args_suffix,
)
# print(" ".join(cmd))
with subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
) as p:
assert p is not None and p.stdout is not None
return p.stdout.read()
@property
def sha1_short(self) -> str:
cmd = (
"git",
"--git-dir",
self._git_dir,
"rev-parse",
"--short",
self.sha1,
)
with subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
) as p:
assert p is not None and p.stdout is not None
return p.stdout.read().strip().decode('ascii')
@property
def author(self) -> str:
ret = self._author
if ret is None:
content = self._log_format("%an <%ae>")[:-1]
ret = content.decode("utf8", errors="ignore")
self._author = ret
return ret
@property
def co_authors(self) -> List[str]:
authors = []
for author in _GIT_COMMIT_COAUTHORS_RE.findall(self.body):
if not ("<" in author and ">" in author):
# Always follow `Name <>` spec, even when no email is given.
author = author + " <>"
authors.append(author)
return authors
@property
def date(self) -> datetime.datetime:
ret = self._date
if ret is None:
import datetime
ret = datetime.datetime.fromtimestamp(int(self._log_format("%ct")))
self._date = ret
return ret
@property
def body(self) -> str:
ret = self._body
if ret is None:
content = self._log_format("%B")[:-1]
ret = content.decode("utf8", errors="ignore")
self._body = ret
return ret
@property
def subject(self) -> str:
return self.body.lstrip().partition("\n")[0]
@property
def files(self) -> List[bytes]:
ret = self._files
if ret is None:
ret = [
f for f in self._log_format(
"format:",
args_prefix=("-c", "diff.renameLimit=10000"),
args_suffix=("--name-only",),
).split(b"\n") if f
]
self._files = ret
return ret
@property
def files_status(self) -> List[List[bytes]]:
ret = self._files_status
if ret is None:
ret = [
f.split(None, 1) for f in self._log_format(
"format:",
args_prefix=("-c", "diff.renameLimit=10000"),
args_suffix=("--name-status",),
).split(b"\n")
if f
]
self._files_status = ret
return ret
@property
def diff(self) -> str:
ret = self._diff
if ret is None:
content = self._log_format(
"",
args_prefix=("-c", "diff.renameLimit=10000"),
args_suffix=("-p",),
)
ret = content.decode("utf8", errors="ignore")
self._diff = ret
return ret
class GitCommitIter:
__slots__ = (
"_path",
"_git_dir",
"_sha1_range",
"_process",
)
def __init__(self, path: str, sha1_range: str):
self._path = path
self._git_dir = os.path.join(path, ".git")
self._sha1_range = sha1_range
self._process: Optional[subprocess.Popen[bytes]] = None
def __iter__(self) -> "GitCommitIter":
cmd = (
"git",
"--git-dir",
self._git_dir,
"log",
self._sha1_range,
"--format=%H",
)
# print(" ".join(cmd))
self._process = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
)
return self
def __next__(self) -> GitCommit:
assert self._process is not None and self._process.stdout is not None
sha1 = self._process.stdout.readline()[:-1]
if sha1:
return GitCommit(sha1, self._git_dir)
else:
raise StopIteration
class GitRepo:
__slots__ = (
"_path",
"_git_dir",
)
def __init__(self, path: str):
self._path = path
self._git_dir = os.path.join(path, ".git")
@property
def branch(self) -> bytes:
cmd = (
"git",
"--git-dir",
self._git_dir,
"rev-parse",
"--abbrev-ref",
"HEAD",
)
# print(" ".join(cmd))
p = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
)
assert p is not None and p.stdout is not None
return p.stdout.read()
|
