Skip to content

BREAKING CHANGES for v4.0 #2177

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

Draft
Byron wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

BREAKING CHANGES for v4.0 #2177

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
4c260e4
feat: rewrite config parser to be consistent with Git
codex Jul 20, 2026
dd6f1c8
feat!: return None for detached refs and add HEAD.hexsha (#2230)
codex Sep 10, 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
9 changes: 9 additions & 0 deletions doc/source/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,15 @@ A :class:`symbolic reference <git.refs.symbolic.SymbolicReference>` is a special
:start-after: # [3-test_references_and_objects]
:end-before: # ![3-test_references_and_objects]

Use ``repo.head.hexsha`` to read HEAD's hexadecimal object ID without loading a
commit. It works with both attached and detached HEADs and returns ``None`` for an
unborn branch. Missing HEAD files, malformed references, and read errors raise
exceptions.

``repo.head.reference`` (also ``repo.head.ref``) and ``repo.active_branch`` return
``None`` when HEAD is detached. An unborn branch still has a reference, even though
it has no object ID yet.

Access the :class:`reflog <git.refs.log.RefLog>` easily.

.. literalinclude:: ../../test/test_docs.py
Expand Down
Loading