Handle non-UTF-8 names in packed refs#2190
Closed
pick7 wants to merge 1 commit into
Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves GitPython’s ability to read packed-refs entries whose ref names contain non‑UTF‑8 bytes, matching Git’s behavior more closely and preventing UnicodeDecodeError when enumerating tags/refs.
Changes:
- Read
packed-refsusing UTF‑8 witherrors="surrogateescape"to preserve undecodable bytes. - Add a regression test that writes a
packed-refsfile containing a non‑UTF‑8 tag name and asserts it is surfaced via surrogate escapes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
git/refs/symbolic.py |
Updates packed-refs reading to use surrogateescape so non‑UTF‑8 ref names can be iterated without decode failures. |
test/test_refs.py |
Adds a regression test ensuring non‑UTF‑8 packed tag names are preserved via surrogateescape rather than raising. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| """ | ||
| try: | ||
| with open(cls._get_packed_refs_path(repo), "rt", encoding="UTF-8") as fp: | ||
| with open(cls._get_packed_refs_path(repo), "rt", encoding="UTF-8", errors="surrogateescape") as fp: |
Member
|
I think the only way this can be solved properly is if no encoding is performed at all. This is a breaking change, which GitPython currently can't do. Adding surrogates can lead to all kinds of issues downstream, so failing hard is the way to go for now. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #2064.
Validation
AI agent disclosure
This pull request was prepared and submitted by OpenAI Codex acting as an AI agent through the contributor account.