Skip to content
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

Jump to bottom

repo.blame and repo.blame_incremental now accept None as the rev parameter. #1846

Merged
merged 3 commits into from
Feb 26, 2024
Merged

repo.blame and repo.blame_incremental now accept None as the rev parameter. #1846

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2e35e7
fix: both blame methods accept None as a revision
Gaubbe Feb 24, 2024
bbabcdc
fix: branch now up to date with upstream
Gaubbe Feb 24, 2024
27d8a14
docs: updated explanation of the `rev` parameter for both blame methods
Gaubbe Feb 25, 2024
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
12 changes: 8 additions & 4 deletions git/repo/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,13 +957,15 @@ def active_branch(self) -> Head:
# reveal_type(self.head.reference) # => Reference
return self.head.reference

def blame_incremental(self, rev: str | HEAD, file: str, **kwargs: Any) -> Iterator["BlameEntry"]:
def blame_incremental(self, rev: str | HEAD | None, file: str, **kwargs: Any) -> Iterator["BlameEntry"]:
"""Iterator for blame information for the given file at the given revision.

Unlike :meth:`blame`, this does not return the actual file's contents, only a
stream of :class:`BlameEntry` tuples.

:param rev: Revision specifier, see git-rev-parse for viable options.
:param rev: Revision specifier. If `None`, the blame will include all the latest
uncommitted changes. Otherwise, anything succesfully parsed by git-rev-parse
is a valid option.

:return: Lazy iterator of :class:`BlameEntry` tuples, where the commit indicates
the commit to blame for the line, and range indicates a span of line numbers
Expand Down Expand Up @@ -1045,15 +1047,17 @@ def blame_incremental(self, rev: str | HEAD, file: str, **kwargs: Any) -> Iterat

def blame(
self,
rev: Union[str, HEAD],
rev: Union[str, HEAD, None],
file: str,
incremental: bool = False,
rev_opts: Optional[List[str]] = None,
**kwargs: Any,
) -> List[List[Commit | List[str | bytes] | None]] | Iterator[BlameEntry] | None:
"""The blame information for the given file at the given revision.

:param rev: Revision specifier, see git-rev-parse for viable options.
:param rev: Revision specifier. If `None`, the blame will include all the latest
uncommitted changes. Otherwise, anything succesfully parsed by git-rev-parse
is a valid option.

:return:
list: [git.Commit, list: [<line>]]
Expand Down
Loading