refactor(git): Rename FileChanges to ChangedFile

Author: Ishirui

src/dda/utils/git/changeset.py

@@ -23,7 +23,7 @@ class ChangeType(StrEnum):
     DELETED = "D"
 
 
-class FileChanges(Struct, frozen=True):
+class ChangedFile(Struct, frozen=True):
     """Represents changes to a single file in a git repository."""
 
     file: Path
@@ -161,7 +161,7 @@ def dec_hook(cls, obj_type: type, obj: Any) -> Any:  # type: ignore[valid-type]
 
 # Need dict=True so that cached_property can be used
 class ChangeSet(Struct, dict=True, frozen=True):
-    _changes: dict[Path, FileChanges] = field(default_factory=dict)
+    _changes: dict[Path, ChangedFile] = field(default_factory=dict)
 
     """
     Represents a set of changes to files in a git repository.
@@ -171,16 +171,16 @@ class ChangeSet(Struct, dict=True, frozen=True):
     """
 
     # == dict proxy methods == #
-    def keys(self) -> dict_keys[Path, FileChanges]:
+    def keys(self) -> dict_keys[Path, ChangedFile]:
         return self._changes.keys()
 
-    def values(self) -> dict_values[Path, FileChanges]:
+    def values(self) -> dict_values[Path, ChangedFile]:
         return self._changes.values()
 
-    def items(self) -> dict_items[Path, FileChanges]:
+    def items(self) -> dict_items[Path, ChangedFile]:
         return self._changes.items()
 
-    def __getitem__(self, key: Path) -> FileChanges:
+    def __getitem__(self, key: Path) -> ChangedFile:
         return self._changes[key]
 
     def __contains__(self, key: Path) -> bool:
@@ -230,7 +230,7 @@ def digest(self) -> str:
         return str(digester.hexdigest())
 
     @classmethod
-    def from_iter(cls, data: Iterable[FileChanges]) -> Self:
+    def from_iter(cls, data: Iterable[ChangedFile]) -> Self:
         """Create a ChangeSet from an iterable of FileChanges."""
         items = {change.file: change for change in data}
         return cls(_changes=items)
@@ -241,7 +241,7 @@ def generate_from_diff_output(cls, diff_output: str | list[str]) -> Self:
         Generate a changeset from the output of a git diff command.
         The output should be passed as a string or a list of lines.
         """
-        return cls.from_iter(FileChanges.generate_from_diff_output(diff_output))
+        return cls.from_iter(ChangedFile.generate_from_diff_output(diff_output))
 
     @classmethod
     def enc_hook(cls, obj: Any) -> Any:

src/dda/utils/git/remote.py

@@ -70,15 +70,15 @@ def get_details_and_changes_for_commit(self, commit: Commit) -> tuple[CommitDeta
         from datetime import datetime
 
         from dda.utils.fs import Path
-        from dda.utils.git.changeset import ChangeSet, FileChanges
+        from dda.utils.git.changeset import ChangeSet, ChangedFile
         from dda.utils.network.http.client import get_http_client
 
         client = get_http_client()
         data = client.get(self.get_commit_github_api_url(commit)).json()
 
         # Compute ChangeSet
         changes = ChangeSet.from_iter(
-            FileChanges(
+            ChangedFile(
                 file=Path(file_obj["filename"]),
                 type=get_change_type_from_github_status(file_obj["status"]),
                 patch=file_obj["patch"],

tests/tools/git/test_git.py

@@ -11,7 +11,7 @@
 import pytest
 
 from dda.utils.fs import Path
-from dda.utils.git.changeset import ChangeSet, ChangeType, FileChanges
+from dda.utils.git.changeset import ChangedFile, ChangeSet, ChangeType
 from dda.utils.git.commit import Commit
 from dda.utils.git.constants import GitEnvVars
 from dda.utils.process import EnvVars
@@ -196,12 +196,12 @@ def test_get_changes_with_base(app: Application, mocker: Any, repo_testcase: str
 
     # Test with working tree changes
     working_tree_changes = ChangeSet({
-        Path("test.txt"): FileChanges(file=Path("test.txt"), type=ChangeType.ADDED, patch="@@ -0,0 +1 @@\n+test")
+        Path("test.txt"): ChangedFile(file=Path("test.txt"), type=ChangeType.ADDED, patch="@@ -0,0 +1 @@\n+test")
     })
     mocker.patch("dda.tools.git.Git.get_working_tree_changes", return_value=working_tree_changes)
 
     changeset_with_working_tree = git.get_changes_with_base(base_commit.sha1, include_working_tree=True)
     expected_changeset_with_working_tree = expected_changeset | ChangeSet.from_iter([
-        FileChanges(file=Path("test.txt"), type=ChangeType.ADDED, patch="@@ -0,0 +1 @@\n+test")
+        ChangedFile(file=Path("test.txt"), type=ChangeType.ADDED, patch="@@ -0,0 +1 @@\n+test")
     ])
     assert_changesets_equal(changeset_with_working_tree, expected_changeset_with_working_tree)

tests/utils/git/test_changeset.py

@@ -7,13 +7,13 @@
 import pytest
 
 from dda.utils.fs import Path
-from dda.utils.git.changeset import ChangeSet, ChangeType, FileChanges
+from dda.utils.git.changeset import ChangedFile, ChangeSet, ChangeType
 from tests.tools.git.conftest import REPO_TESTCASES
 
 
 class TestFileChangesClass:
     def test_basic(self):
-        file_changes = FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
+        file_changes = ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
         assert file_changes.file == Path("/path/to/file")
         assert file_changes.type == ChangeType.ADDED
         assert file_changes.patch == "patch"
@@ -37,7 +37,7 @@ def test_generate_from_diff_output(self, repo_testcase):
             key=lambda x: x.file.as_posix(),
         )
 
-        seen_filechanges = sorted(FileChanges.generate_from_diff_output(diff_output), key=lambda x: x.file.as_posix())
+        seen_filechanges = sorted(ChangedFile.generate_from_diff_output(diff_output), key=lambda x: x.file.as_posix())
 
         assert len(seen_filechanges) == len(expected_filechanges)
         for seen, expected in zip(seen_filechanges, expected_filechanges, strict=True):
@@ -46,39 +46,39 @@ def test_generate_from_diff_output(self, repo_testcase):
             assert seen.patch == expected.patch
 
     def test_encode_decode(self):
-        file_changes = FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
-        encoded_file_changes = msgspec.json.encode(file_changes, enc_hook=FileChanges.enc_hook)
+        file_changes = ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
+        encoded_file_changes = msgspec.json.encode(file_changes, enc_hook=ChangedFile.enc_hook)
         decoded_file_changes = msgspec.json.decode(
-            encoded_file_changes, type=FileChanges, dec_hook=FileChanges.dec_hook
+            encoded_file_changes, type=ChangedFile, dec_hook=ChangedFile.dec_hook
         )
         assert decoded_file_changes == file_changes
 
 
 class TestChangeSetClass:
     def test_basic(self):
-        change = FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
+        change = ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
         changeset = ChangeSet({change.file: change})
         assert changeset[Path("/path/to/file")] == change
 
     def test_add(self):
-        change = FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
+        change = ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch")
         changeset = ChangeSet.from_iter([change])
         assert changeset[Path("/path/to/file")] == change
 
     def test_digest(self):
         changes = [
-            FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
-            FileChanges(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
-            FileChanges(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
+            ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
+            ChangedFile(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
+            ChangedFile(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
         ]
         changeset = ChangeSet.from_iter(changes)
         assert changeset.digest() == "95a9fe4d808bdda19da9285b6d1a31a6e29ddbfa"
 
     def test_properties(self):
         changes = [
-            FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
-            FileChanges(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
-            FileChanges(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
+            ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
+            ChangedFile(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
+            ChangedFile(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
         ]
         changeset = ChangeSet.from_iter(changes)
         assert changeset.added == {Path("/path/to/file")}
@@ -111,9 +111,9 @@ def test_generate_from_diff_output(self, repo_testcase):
 
     def test_encode_decode(self):
         changes = [
-            FileChanges(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
-            FileChanges(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
-            FileChanges(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
+            ChangedFile(file=Path("/path/to/file"), type=ChangeType.ADDED, patch="patch"),
+            ChangedFile(file=Path("file2"), type=ChangeType.MODIFIED, patch="patch2"),
+            ChangedFile(file=Path("/path/../file3"), type=ChangeType.DELETED, patch="patch3"),
         ]
         changeset = ChangeSet.from_iter(changes)
         encoded_changeset = msgspec.json.encode(changeset, enc_hook=ChangeSet.enc_hook)

tests/utils/git/test_remote.py

@@ -10,7 +10,7 @@
 from httpx import Response
 
 from dda.utils.fs import Path
-from dda.utils.git.changeset import ChangeSet, FileChanges
+from dda.utils.git.changeset import ChangeSet, ChangedFile
 from dda.utils.git.commit import Commit, CommitDetails
 from dda.utils.git.remote import HTTPSRemote, Remote, SSHRemote, get_change_type_from_github_status
 
@@ -87,7 +87,7 @@ def test_get_commit_details_and_changes_from_remote(self, mocker, github_payload
 
         # Create a ChangeSet object
         changes = [
-            FileChanges(
+            ChangedFile(
                 file=Path(file["filename"]),
                 type=get_change_type_from_github_status(file["status"]),
                 patch=file["patch"],