Skip to content

fix(repo): preserve timezone metadata in blame results #2343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Byron merged 2 commits into from
Nov 12, 2026
Merged

fix(repo): preserve timezone metadata in blame results #2343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b84749b
fix(repo): preserve timezone metadata in blame results
anticipate218 Nov 12, 2026
9aa6215
review
Byron Nov 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion git/repo/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
)
from git.index import IndexFile
from git.objects import Submodule, RootModule, Commit
from git.objects.util import utctz_to_altz
from git.refs import HEAD, Head, Reference, SymbolicReference, TagReference
from git.remote import Remote, _T_RemoteName, add_progress, to_progress_instance
from git.util import (
Expand Down Expand Up @@ -1363,11 +1364,13 @@ def blame_incremental(
safe_decode(props[b"author-mail"].lstrip(b"<").rstrip(b">")),
),
authored_date=int(props[b"author-time"]),
author_tz_offset=utctz_to_altz(props[b"author-tz"].decode("ascii")),
committer=Actor(
safe_decode(props[b"committer"]),
safe_decode(props[b"committer-mail"].lstrip(b"<").rstrip(b">")),
),
committed_date=int(props[b"committer-time"]),
committer_tz_offset=utctz_to_altz(props[b"committer-tz"].decode("ascii")),
)
commits[hexsha] = c
else:
Expand Down Expand Up @@ -1452,9 +1455,11 @@ class InfoTD(TypedDict, total=False):
author: str
author_email: str
author_date: int
author_tz_offset: int
committer: str
committer_email: str
committer_date: int
committer_tz_offset: int

info: InfoTD = {}

Expand Down Expand Up @@ -1504,20 +1509,24 @@ class InfoTD(TypedDict, total=False):
# committer Tom Preston-Werner
# committer-mail <tom@mojombo.com>
# committer-time 1192271832
# committer-tz -0700 - IGNORED BY US
# committer-tz -0700
role = m.group(0)
if role == "author":
if firstpart.endswith("-mail"):
info["author_email"] = parts[-1]
elif firstpart.endswith("-time"):
info["author_date"] = int(parts[-1])
elif firstpart.endswith("-tz"):
info["author_tz_offset"] = utctz_to_altz(parts[-1])
elif role == firstpart:
info["author"] = parts[-1]
elif role == "committer":
if firstpart.endswith("-mail"):
info["committer_email"] = parts[-1]
elif firstpart.endswith("-time"):
info["committer_date"] = int(parts[-1])
elif firstpart.endswith("-tz"):
info["committer_tz_offset"] = utctz_to_altz(parts[-1])
elif role == firstpart:
info["committer"] = parts[-1]
# END distinguish mail,time,name
Expand All @@ -1540,8 +1549,10 @@ class InfoTD(TypedDict, total=False):
hex_to_bin(sha),
author=Actor._from_string(f"{info['author']} {info['author_email']}"),
authored_date=info["author_date"],
author_tz_offset=info.get("author_tz_offset"),
committer=Actor._from_string(f"{info['committer']} {info['committer_email']}"),
committed_date=info["committer_date"],
committer_tz_offset=info.get("committer_tz_offset"),
)
commits[sha] = c
blames[-1][0] = c
Expand Down
24 changes: 24 additions & 0 deletions test/test_repo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,30 @@ def test_blame_preserves_line_content(self):
lines = [line for _commit, blamed in repo.blame("HEAD", "file.txt") for line in blamed]
self.assertEqual(lines, ["alpha ", "beta", "\t", "crlf\r", "gamma"])

def test_blame_preserves_timezones(self):
with fixture_repo("blame-content.sh") as repo:
for incremental in (False, True):
for rev in ("HEAD", None):
with self.subTest(incremental=incremental, rev=rev):
entry = next(iter(repo.blame(rev, "file.txt", incremental=incremental)))
commit = entry[0]
porcelain = repo.git.blame(rev, "--line-porcelain", "--", "file.txt")
offsets = dict(
line.split(" ", 1)
for line in porcelain.splitlines()
if line.startswith(("author-tz ", "committer-tz "))
)
with mock.patch.object(
Commit, "_set_cache_", side_effect=AssertionError("unexpected object read")
):
if rev is None:
self.assertEqual(commit.hexsha, "0" * 40)
else:
self.assertEqual(commit.author_tz_offset, -19800)
self.assertEqual(commit.committer_tz_offset, 14400)
self.assertEqual(commit.authored_datetime.strftime("%z"), offsets["author-tz"])
self.assertEqual(commit.committed_datetime.strftime("%z"), offsets["committer-tz"])

@mock.patch.object(Git, "_call_process")
def test_blame_complex_revision(self, git):
git.return_value = fixture("blame_complex_revision")
Expand Down
6 changes: 5 additions & 1 deletion tests/fixtures/blame-content.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,9 @@ cd repo
# CRLF line survive fixture creation on every platform.
blob=$(printf 'alpha \nbeta\n\t\ncrlf\r\ngamma\n' | git hash-object -w --stdin)
tree=$(printf '100644 blob %s\tfile.txt\0' "$blob" | git mktree -z)
commit=$(git -c user.name=A -c user.email=a@example.com commit-tree "$tree" -m content)
commit=$(GIT_AUTHOR_DATE='2020-01-01T12:00:00+0530' \
GIT_COMMITTER_DATE='2020-01-01T13:00:00-0400' \
git -c user.name=A -c user.email=a@example.com commit-tree "$tree" -m content)
git update-ref refs/heads/main "$commit"
git reset --hard -q HEAD
printf 'changed\n' > file.txt
Loading