Skip to content

Add Commit.is_shallow property; document stats() limitation at shallow boundary #2167

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

Open
harshitayadavv wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add Commit.is_shallow property; document stats() limitation at shallow boundary #2167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
837a4f0
Add Commit.is_shallow property and document stats() limitation at sha…
harshitayadavv Jul 5, 2026
6b1dd78
Fix formatting flagged by ruff (pre-commit.ci)
harshitayadavv Jul 5, 2026
2f49a66
Reduce to docs-only change per maintainer review
harshitayadavv Jul 12, 2026
0f6dde4
Remove unused GitCommandError import
harshitayadavv Jul 12, 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
1 change: 1 addition & 0 deletions AUTHORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,6 @@ Contributors are:
-Jonas Scharpf <jonas.scharpf _at_ checkmk.com>
-Gordon Marx
-Enji Cooper
-Harshita Yadav <harshitayadav504 _at_ gmail.com>

Portions derived from other open source works and are clearly marked.
5 changes: 5 additions & 0 deletions git/objects/commit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,11 @@ def stats(self) -> Stats:
"""Create a git stat from changes between this commit and its first parent
or from all changes done if this is the very first commit.

:note:
If this commit is at the boundary of a shallow clone, this will
raise :exc:`~git.exc.GitCommandError`, since the parent object
was never fetched and only exists as a reference on this commit.

:return:
:class:`Stats`
"""
Expand Down
Loading