Skip to content

Commit

Permalink
Merge pull request #1846 from Gaubbe/main
Browse files Browse the repository at this point in the history
`repo.blame` and `repo.blame_incremental` now accept `None` as the `rev` parameter.
  • Loading branch information
Byron committed Feb 26, 2024
2 parents 1e044ea + 27d8a14 commit fe1934c
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions git/repo/base.py
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

0 comments on commit fe1934c

Please sign in to comment.