Skip to content

Commit

Permalink
Merge pull request gitpython-developers#1918 from kamilkrzyskow/patch-1
Browse files Browse the repository at this point in the history
Fix iter_change_type diff renamed property to prevent warning
  • Loading branch information
Byron authored Jun 8, 2024
2 parents ca1d031 + e1c660d commit ee987da
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion git/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def iter_change_type(self, change_type: Lit_change_type) -> Iterator[T_Diff]:
yield diffidx
elif change_type == "C" and diffidx.copied_file:
yield diffidx
elif change_type == "R" and diffidx.renamed:
elif change_type == "R" and diffidx.renamed_file:
yield diffidx
elif change_type == "M" and diffidx.a_blob and diffidx.b_blob and diffidx.a_blob != diffidx.b_blob:
yield diffidx
Expand Down
15 changes: 14 additions & 1 deletion test/deprecation/test_basic.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
if TYPE_CHECKING:
from pathlib import Path

from git.diff import Diff
from git.diff import Diff, DiffIndex
from git.objects.commit import Commit

# ------------------------------------------------------------------------
Expand All @@ -54,6 +54,12 @@ def diff(commit: "Commit") -> Generator["Diff", None, None]:
yield diff


@pytest.fixture
def diffs(commit: "Commit") -> Generator["DiffIndex", None, None]:
"""Fixture to supply a DiffIndex."""
yield commit.diff(NULL_TREE)


def test_diff_renamed_warns(diff: "Diff") -> None:
"""The deprecated Diff.renamed property issues a deprecation warning."""
with pytest.deprecated_call():
Expand Down Expand Up @@ -122,3 +128,10 @@ def test_iterable_obj_inheriting_does_not_warn() -> None:

class Derived(IterableObj):
pass


def test_diff_iter_change_type(diffs: "DiffIndex") -> None:
"""The internal DiffIndex.iter_change_type function issues no deprecation warning."""
with assert_no_deprecation_warning():
for change_type in diffs.change_type:
[*diffs.iter_change_type(change_type=change_type)]

0 comments on commit ee987da

Please sign in to comment.