GitPython raises UnicodeDecodeError when iterating .git/packed-refs if a packed ref name contains bytes that are not valid UTF-8.
Git ref names are byte strings and are not guaranteed to contain valid UTF-8. A single non-UTF-8 ref should not make the entire packed-refs file unreadable.
Root Cause
SymbolicReference._iter_packed_refs() opened packed-refs in text mode with strict UTF-8 decoding:
open(..., "rt", encoding="UTF-8")
This caused UnicodeDecodeError when a packed ref contained non-UTF-8 bytes.
Fix
Read packed-refs in binary mode and decode each line using surrogateescape.
This follows the existing lenient byte-to-string handling used elsewhere in GitPython and preserves the original bytes during round-tripping instead of raising an exception.
Regression Test
Added a regression test covering a packed ref containing a non-UTF-8 byte and verifying that iterating packed refs does not raise UnicodeDecodeError.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2064.
Bug
GitPython raises UnicodeDecodeError when iterating .git/packed-refs if a packed ref name contains bytes that are not valid UTF-8.
Git ref names are byte strings and are not guaranteed to contain valid UTF-8. A single non-UTF-8 ref should not make the entire packed-refs file unreadable.
Root Cause
SymbolicReference._iter_packed_refs() opened packed-refs in text mode with strict UTF-8 decoding:
This caused UnicodeDecodeError when a packed ref contained non-UTF-8 bytes.
Fix
Read packed-refs in binary mode and decode each line using surrogateescape.
This follows the existing lenient byte-to-string handling used elsewhere in GitPython and preserves the original bytes during round-tripping instead of raising an exception.
Regression Test
Added a regression test covering a packed ref containing a non-UTF-8 byte and verifying that iterating packed refs does not raise UnicodeDecodeError.
Validation