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

Fix iter_change_type diff renamed property to prevent warning #1918

Merged
merged 2 commits into from
Jun 8, 2024
Merged

Fix iter_change_type diff renamed property to prevent warning #1918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d597088
Add deprecation test for DiffIndex.iter_change_type
kamilkrzyskow Jun 7, 2024
e1c660d
Fix iter_change_type diff renamed property to prevent warning
kamilkrzyskow May 28, 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
2 changes: 1 addition & 1 deletion git/diff.py
View file
Open in desktop
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
View file
Open in desktop
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():
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There must have been a misunderstanding. It's not about deprecation warnings, it's about adding a test that fails without the change presented here, while making clear what the issue truly is.

for change_type in diffs.change_type:
[*diffs.iter_change_type(change_type=change_type)]
Loading