-
-
Notifications
You must be signed in to change notification settings - Fork 328
Expand file tree
/
Copy pathgit.py
More file actions
341 lines (268 loc) · 9.75 KB
/
git.py
File metadata and controls
341 lines (268 loc) · 9.75 KB
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
from __future__ import annotations
import os
from enum import Enum
from functools import lru_cache
from pathlib import Path
from tempfile import NamedTemporaryFile
from commitizen import cmd, out
from commitizen.exceptions import GitCommandError
class EOLType(Enum):
"""The EOL type from `git config core.eol`."""
LF = "lf"
CRLF = "crlf"
NATIVE = "native"
@classmethod
def for_open(cls) -> str:
c = cmd.run("git config core.eol")
eol = c.out.strip().upper()
return cls._char_for_open()[cls._safe_cast(eol)]
@classmethod
def _safe_cast(cls, eol: str) -> EOLType:
try:
return cls[eol]
except KeyError:
return cls.NATIVE
@classmethod
@lru_cache
def _char_for_open(cls) -> dict[EOLType, str]:
"""Get the EOL character for `open()`."""
return {
cls.LF: "\n",
cls.CRLF: "\r\n",
cls.NATIVE: os.linesep,
}
class GitObject:
rev: str
name: str
date: str
def __eq__(self, other: object) -> bool:
return hasattr(other, "rev") and self.rev == other.rev
def __hash__(self) -> int:
return hash(self.rev)
class GitCommit(GitObject):
def __init__(
self,
rev: str,
title: str,
body: str = "",
author: str = "",
author_email: str = "",
parents: list[str] | None = None,
) -> None:
self.rev = rev.strip()
self.title = title.strip()
self.body = body.strip()
self.author = author.strip()
self.author_email = author_email.strip()
self.parents = parents or []
@property
def message(self) -> str:
return f"{self.title}\n\n{self.body}".strip()
@classmethod
def from_rev_and_commit(cls, rev_and_commit: str) -> GitCommit:
"""Create a GitCommit instance from a formatted commit string.
This method parses a multi-line string containing commit information in the following format:
```
<rev>
<parents>
<title>
<author>
<author_email>
<body_line_1>
<body_line_2>
...
```
Args:
rev_and_commit (str): A string containing commit information with fields separated by newlines.
- rev: The commit hash/revision
- parents: Space-separated list of parent commit hashes
- title: The commit title/message
- author: The commit author's name
- author_email: The commit author's email
- body: Optional multi-line commit body
Returns:
GitCommit: A new GitCommit instance with the parsed information.
Example:
>>> commit_str = '''abc123
... def456 ghi789
... feat: add new feature
... John Doe
... john@example.com
... This is a detailed description
... of the new feature'''
>>> commit = GitCommit.from_rev_and_commit(commit_str)
>>> commit.rev
'abc123'
>>> commit.title
'feat: add new feature'
>>> commit.parents
['def456', 'ghi789']
"""
rev, parents, title, author, author_email, *body_list = (
rev_and_commit.splitlines()
)
return cls(
rev=rev.strip(),
title=title.strip(),
body="\n".join(body_list).strip(),
author=author,
author_email=author_email,
parents=[p for p in parents.strip().split(" ") if p],
)
def __repr__(self) -> str:
return f"{self.title} ({self.rev})"
class GitTag(GitObject):
def __init__(self, name: str, rev: str, date: str) -> None:
self.rev = rev.strip()
self.name = name.strip()
self._date = date.strip()
def __repr__(self) -> str:
return f"GitTag('{self.name}', '{self.rev}', '{self.date}')"
@property
def date(self) -> str:
return self._date
@date.setter
def date(self, value: str) -> None:
self._date = value
@classmethod
def from_line(cls, line: str, inner_delimiter: str) -> GitTag:
name, objectname, date, obj = line.split(inner_delimiter)
if not obj:
obj = objectname
return cls(name=name, rev=obj, date=date)
def tag(
tag: str, annotated: bool = False, signed: bool = False, msg: str | None = None
) -> cmd.Command:
if not annotated and not signed:
return cmd.run(f"git tag {tag}")
# according to https://git-scm.com/book/en/v2/Git-Basics-Tagging,
# we're not able to create lightweight tag with message.
# by adding message, we make it a annotated tags
option = "-s" if signed else "-a" # The else case is for annotated tags
return cmd.run(f'git tag {option} {tag} -m "{msg or tag}"')
def add(*args: str) -> cmd.Command:
return cmd.run(f"git add {' '.join(args)}")
def commit(
message: str,
args: str = "",
committer_date: str | None = None,
) -> cmd.Command:
f = NamedTemporaryFile("wb", delete=False)
f.write(message.encode("utf-8"))
f.close()
command = _create_commit_cmd_string(args, committer_date, f.name)
c = cmd.run(command)
os.unlink(f.name)
return c
def _create_commit_cmd_string(args: str, committer_date: str | None, name: str) -> str:
command = f'git commit {args} -F "{name}"'
if not committer_date:
return command
if os.name != "nt":
return f"GIT_COMMITTER_DATE={committer_date} {command}"
# Using `cmd /v /c "{command}"` sets environment variables only for that command
return f'cmd /v /c "set GIT_COMMITTER_DATE={committer_date}&& {command}"'
def get_commits(
start: str | None = None,
end: str | None = None,
*,
args: str = "",
) -> list[GitCommit]:
"""Get the commits between start and end."""
if end is None:
end = "HEAD"
git_log_entries = _get_log_as_str_list(start, end, args)
return [
GitCommit.from_rev_and_commit(rev_and_commit)
for rev_and_commit in git_log_entries
if rev_and_commit
]
def get_filenames_in_commit(git_reference: str = "") -> list[str]:
"""Get the list of files that were committed in the requested git reference.
:param git_reference: a git reference as accepted by `git show`, default: the last commit
:returns: file names committed in the last commit by default or inside the passed git reference
"""
c = cmd.run(f"git show --name-only --pretty=format: {git_reference}")
if c.return_code == 0:
return c.out.strip().split("\n")
raise GitCommandError(c.err)
def get_tags(
dateformat: str = "%Y-%m-%d", reachable_only: bool = False
) -> list[GitTag]:
inner_delimiter = "---inner_delimiter---"
formatter = (
f'"%(refname:strip=2){inner_delimiter}'
f"%(objectname){inner_delimiter}"
f"%(creatordate:format:{dateformat}){inner_delimiter}"
f'%(object)"'
)
extra = "--merged" if reachable_only else ""
# Force the default language for parsing
env = {"LC_ALL": "C", "LANG": "C", "LANGUAGE": "C"}
c = cmd.run(f"git tag --format={formatter} --sort=-creatordate {extra}", env=env)
if c.return_code != 0:
if reachable_only and c.err == "fatal: malformed object name HEAD\n":
# this can happen if there are no commits in the repo yet
return []
raise GitCommandError(c.err)
if c.err:
out.warn(f"Attempting to proceed after: {c.err}")
return [
GitTag.from_line(line=line, inner_delimiter=inner_delimiter)
for line in c.out.split("\n")[:-1]
]
def tag_exist(tag: str) -> bool:
c = cmd.run(f"git tag --list {tag}")
return tag in c.out
def is_signed_tag(tag: str) -> bool:
return cmd.run(f"git tag -v {tag}").return_code == 0
def get_latest_tag_name() -> str | None:
c = cmd.run("git describe --abbrev=0 --tags")
if c.err:
return None
return c.out.strip()
def get_tag_message(tag: str) -> str | None:
c = cmd.run(f"git tag -l --format='%(contents:subject)' {tag}")
if c.err:
return None
return c.out.strip()
def get_tag_names() -> list[str]:
c = cmd.run("git tag --list")
if c.err:
return []
return [tag for raw in c.out.split("\n") if (tag := raw.strip())]
def find_git_project_root() -> Path | None:
c = cmd.run("git rev-parse --show-toplevel")
if c.err:
return None
return Path(c.out.strip())
def is_staging_clean() -> bool:
"""Check if staging is clean."""
c = cmd.run("git diff --no-ext-diff --cached --name-only")
return not bool(c.out)
def is_git_project() -> bool:
c = cmd.run("git rev-parse --is-inside-work-tree")
return c.out.strip() == "true"
def get_core_editor() -> str | None:
c = cmd.run("git var GIT_EDITOR")
if c.out:
return c.out.strip()
return None
def smart_open(*args, **kwargs): # type: ignore[no-untyped-def,unused-ignore] # noqa: ANN201
"""Open a file with the EOL style determined from Git."""
return open(*args, newline=EOLType.for_open(), **kwargs)
def _get_log_as_str_list(start: str | None, end: str, args: str) -> list[str]:
"""Get string representation of each log entry"""
delimiter = "----------commit-delimiter----------"
log_format: str = "%H%n%P%n%s%n%an%n%ae%n%b"
command_range = f"{start}..{end}" if start else end
command = f"git -c log.showSignature=False log --pretty={log_format}{delimiter} {args} {command_range}"
c = cmd.run(command)
if c.return_code != 0:
raise GitCommandError(c.err)
return c.out.split(f"{delimiter}\n")
def get_default_branch() -> str:
c = cmd.run("git symbolic-ref refs/remotes/origin/HEAD")
if c.return_code != 0:
raise GitCommandError(c.err)
return c.out.strip()