fix(gix): omit dangling symbolic references from enumeration · gitpython-developers/GitPython@9ab1e02 · GitHub

1. gitpython-developers
2. GitPython

Repository navigation

• Code
• Issues6 (6)
• Pull requests7 (7)
• Discussions
• Actions
• Security and quality42 (42)
• Insights

Commit 9ab1e02

Browse filesBrowse the repository at this point in the historyBrowse files

codex

authored and

Byron

committed

fix(gix): omit dangling symbolic references from enumeration

`for-each-ref` omits symbolic references whose targets do not exist, while GixPython's reference iterator yields them. This made `Repo.heads` include branches that the CLI backend would omit. Resolve symbolic targets while retaining their original names. A dangling target uses the existing read-error fallback, allowing Git to handle its filtering and diagnostics. Valid symbolic aliases still use native enumeration. The regression failed for both SHA-1 and SHA-256 before the fix. All six selected enumeration, query, and reference tests now pass, as do Ruff lint and format checks.

1 parent b4613e6 commit 9ab1e02
Copy full SHA for 9ab1e02

2 files changed

+19-1Lines changed: 19 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• git
  • _backend.py
• test
  • test_gix_backend.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎git/_backend.py‎

Copy file name to clipboardExpand all lines: git/_backend.py

+6-1Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -183,7 +183,12 @@ def _for_each_ref(repo: Any, args: List[str], kwargs: Dict[str, Any]) -> bytes:
183	183	if any(char in prefix for char in b"*?["):
184	184	raise _Unsupported("reference glob patterns")
185	185	with repo.references().all() as refs:
186		- names = [ref.name() for ref in refs]
	186	+ names = []
	187	+ for ref in refs:
	188	+ names.append(ref.name())
	189	+ if ref.target().try_name() is not None:
	190	+ # Git omits dangling symbolic refs; defer their diagnostics to it.
	191	+ ref.follow_to_object()
187	192	return b"".join(
188	193	name + b"\n"
189	194	for name in sorted(names)

Collapse file

‎test/test_gix_backend.py‎

Copy file name to clipboardExpand all lines: test/test_gix_backend.py

+13Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -110,6 +110,19 @@ def test_native_command_queries_match_cli(repo):
110	110	assert native == repo.git._call_process_safe(method, *args, stdout_as_string=False)
111	111
112	112
	113	+ def test_reference_enumeration_preserves_aliases_and_skips_dangling_refs(repo):
	114	+ repo.index.commit("initial", skip_hooks=True)
	115	+ repo.git.symbolic_ref("refs/heads/alias", "refs/heads/main")
	116	+ with patch.object(Git, "execute", side_effect=AssertionError("unexpected CLI call")):
	117	+ assert repo.git._call_process_safe("for_each_ref", "--format=%(refname)", "--", "refs/heads") == (
	118	+ "refs/heads/alias\nrefs/heads/main"
	119	+ )
	120	+ repo.git.symbolic_ref("refs/heads/dangling", "refs/heads/missing")
	121	+ with patch.object(_backend, "gix", None):
	122	+ expected = [ref.path for ref in repo.heads]
	123	+ assert [ref.path for ref in repo.heads] == expected == ["refs/heads/alias", "refs/heads/main"]
	124	+
	125	+
113	126	def test_a_native_write_failure_is_not_retried(repo, monkeypatch):
114	127	attempts = []
115	128

0 commit comments

Comments

0 (0)