GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Clarify detached HEAD access and isolate test branch state by Byron · Pull Request #2231 · gitpython-developers/GitPython

Conversation

@Byron

@Byron Byron commented Sep 9, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Tasks

This section is for Byron only. Models continuing this PR must not add, remove, check, uncheck, rename, or reorder checkboxes here.

  • refackiew

Everything below this line was generated by Codex GPT-6.

Created by Codex on behalf of Byron. Byron will review before this is ready to merge.

Detached HEAD makes repo.head.reference raise TypeError, but its public documentation and diagnostic did not explain how to obtain the commit. The diagnostic now points to .commit and .object, and the property documentation and tutorial show repo.head.commit.hexsha for both HEAD states. They also explain why assigning a commit to .reference succeeds while reading it afterward raises. Return types and exception types are preserved; the existing diagnostic gains a hint.

The test suite now supplies branch state in its temporary repositories, gives writable remote fixtures their own master, and uses explicit refspecs where an upstream is unnecessary. Branch-dependent assertions use writable fixtures, and the reflog assertion compares against Git instead of assuming consecutive entries name different commits. A regression covers bare and working clones of a detached commit that no branch points to. The Ubuntu/Python 3.14 CI job additionally runs the suite from detached and non-master source checkouts, with master absent in the latter.

Refs #2230.

Validation:

  • Python 3.14.7: full suite using GIT_PYTHON_TEST_GIT_REPO_BASE with non-master and detached source clones, each without a local master: 760 passed, 81 skipped, 1 xfailed, plus 14 passing subtests per state. Six tests needing network or process access were run separately and passed in both states.
  • The extended API regression failed on the missing diagnostic hint before the implementation changed.
  • Repository-wide Ruff lint and formatting checks passed.
  • Sphinx HTML build passed. Its 12 Python 3.14 annotation warnings exactly match the unchanged baseline.

Git reference: git/git at 1630431f326e15fcde608827b5ff38422528eb59, Documentation/git-symbolic-ref.adoc. Apple Git 2.50.1 confirms that git symbolic-ref -q HEAD exits 1 for detached HEAD while git rev-parse HEAD returns the commit ID.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Byron @codex
Clarify detached HEAD access and attach writable test fixtures (#2230)
6bcb25b 
<!-- agent -->
Reading head.reference or active_branch raises TypeError when HEAD points
directly to a commit, but the public documentation did not clearly explain
how to access that commit. Document head.commit.hexsha for attached and
detached HEADs, explain the reference setter/getter asymmetry, and clarify
that active_branch requires an attached HEAD. Preserve the exception type
and existing message prefix while adding a hint to use .commit or .object.

Writable test fixtures assumed cloning produced an attached HEAD, so their
branch access could fail when the source checkout was detached. Have
with_rw_repo create and attach master at the requested revision when its
clone is detached, retaining the clone's branch and tracking configuration
otherwise. Explicitly attach the temporary bare remote to its own master
branch before cloning it for remote tests.

Assisted-by: GPT 6.0
Co-authored-by: GPT 6.0 <[email protected]>
@Byron
Byron force-pushed the detached-head branch from fb9fe55 to 6bcb25b Compare September 10, 2026 03:17
@Byron
Byron marked this pull request as ready for review September 10, 2026 03:19
Copilot AI lite review requested due to automatic review settings September 10, 2026 03:19
Copilot started reviewing on behalf of Byron September 10, 2026 03:22
View session
Copilot AI reviewed Sep 10, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Normalize annotated-tag revisions to commits before creating the fixture branch.

Pull request overview

This pull request clarifies detached-HEAD access and isolates test fixtures from source branch state.

Changes:

  • Documents detached-HEAD commit and reference behavior.
  • Improves detached-reference diagnostics.
  • Stabilizes temporary repository branch setup.
File summaries
File Summary
test/lib/helper.py Adjusts writable fixture branch setup; annotated-tag revisions need normalization to a commit.
git/repo/base.py Clarifies detached active_branch behavior.
git/refs/symbolic.py Documents reference semantics and improves diagnostics.
doc/source/tutorial.rst Adds detached-HEAD usage guidance.
Review details

Suppressed comments (1)

test/lib/helper.py:165

  • create_head resolves a string with rev_parse, so an annotated tag resolves to a TagObject and Head rejects it as non-commit. The attached-HEAD branch above avoids this by calling rw_repo.commit(working_tree_ref), so detached-source fixtures regress for any annotated-tag working_tree_ref; normalize the revision to a commit before creating master.
                rw_repo.head.reference = rw_repo.create_head(
                    "master", working_tree_ref, force=True, logmsg="Create test branch"
                )
  • Files reviewed: 4/4 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Byron
Byron merged commit 4905b4a into main Sep 10, 2026
54 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@Byron
Byron deleted the detached-head branch October 5, 2026 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@Byron
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.