Merge pull request #1918 from kamilkrzyskow/patch-1

Byron · web-flow · commit ee987dac1c74 · 2024-06-08T07:53:16.000+02:00
Fix iter_change_type diff renamed property to prevent warning
diff --git a/git/diff.py b/git/diff.py
@@ -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
diff --git a/test/deprecation/test_basic.py b/test/deprecation/test_basic.py
@@ -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
 
 # ------------------------------------------------------------------------
@@ -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():
@@ -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)]

-Original file line number
+Diff line change
 yielddiffidx
 elifchange_type=="C"anddiffidx.copied_file:
 yielddiffidx
 -elifchange_type=="R"anddiffidx.renamed:
 +elifchange_type=="R"anddiffidx.renamed_file:
 yielddiffidx
 elifchange_type=="M"anddiffidx.a_blobanddiffidx.b_blobanddiffidx.a_blob!=diffidx.b_blob:
 yielddiffidx
-Original file line number
+Diff line change
 ifTYPE_CHECKING:
 frompathlibimportPath
 -fromgit.diffimportDiff
 +fromgit.diffimportDiff, DiffIndex
 fromgit.objects.commitimportCommit
 # ------------------------------------------------------------------------
 yielddiff
 +@pytest.fixture
 +defdiffs(commit: "Commit") ->Generator["DiffIndex", None, None]:
 +"""Fixture to supply a DiffIndex."""
 +yieldcommit.diff(NULL_TREE)
++
++
 deftest_diff_renamed_warns(diff: "Diff") ->None:
 """The deprecated Diff.renamed property issues a deprecation warning."""
 withpytest.deprecated_call():
 classDerived(IterableObj):
 pass
++
++
 +deftest_diff_iter_change_type(diffs: "DiffIndex") ->None:
 +"""The internal DiffIndex.iter_change_type function issues no deprecation warning."""
 +withassert_no_deprecation_warning():
 +forchange_typeindiffs.change_type:
 + [*diffs.iter_change_type(change_type=change_type)]