Deprecate Remote.ls_remotes in favor of Remote.list_heads

Author: jorio

pygit2/remotes.py

@@ -55,7 +55,7 @@
 class RemoteHead:
     """
     Description of a reference advertised by a remote server,
-    given out on `Remote.ls_remotes` calls.
+    given out on `Remote.list_heads` calls.
     """
 
     local: bool
@@ -80,19 +80,6 @@ def __init__(self, c_struct: Any) -> None:
         self.name = maybe_string(c_struct.name)
         self.symref_target = maybe_string(c_struct.symref_target)
 
-    def __getitem__(self, item: str) -> Any:
-        """
-        DEPRECATED: Backwards compatibility with legacy user code
-        that expects this object to be a dictionary with string keys.
-        """
-        warnings.warn(
-            'ls_remotes no longer returns a dict. '
-            'Update your code to read from fields instead '
-            '(e.g. result["name"] --> result.name)',
-            DeprecationWarning,
-        )
-        return getattr(self, item)
-
 
 class PushUpdate:
     """
@@ -259,7 +246,7 @@ def fetch(
 
         return TransferProgress(C.git_remote_stats(self._remote))
 
-    def ls_remotes(
+    def list_heads(
         self,
         callbacks: RemoteCallbacks | None = None,
         proxy: str | None | bool = None,
@@ -294,6 +281,30 @@ def ls_remotes(
 
         return results
 
+    def ls_remotes(
+        self,
+        callbacks: RemoteCallbacks | None = None,
+        proxy: str | None | bool = None,
+        connect: bool = True,
+    ) -> list[dict[str, Any]]:
+        """
+        Deprecated interface to list_heads
+        """
+        warnings.warn('Use list_heads', DeprecationWarning)
+
+        heads = self.list_heads(callbacks, proxy, connect)
+
+        return [
+            {
+                'local': h.local,
+                'oid': h.oid,
+                'loid': h.loid,
+                'name': h.name,
+                'symref_target': h.symref_target,
+            }
+            for h in heads
+        ]
+
     def prune(self, callbacks: RemoteCallbacks | None = None) -> None:
         """Perform a prune against this remote."""
         with git_remote_callbacks(callbacks) as payload:

test/test_remote.py

@@ -193,41 +193,45 @@ def test_remote_list(testrepo: Repository) -> None:
 
 
 @utils.requires_network
-def test_ls_remotes(testrepo: Repository) -> None:
+def test_list_heads(testrepo: Repository) -> None:
     assert 1 == len(testrepo.remotes)
     remote = testrepo.remotes[0]
 
-    refs = remote.ls_remotes()
+    refs = remote.list_heads()
     assert refs
 
     # Check that a known ref is returned.
     assert next(iter(r for r in refs if r.name == 'refs/tags/v0.28.2'))
 
 
 @utils.requires_network
-def test_ls_remotes_backwards_compatibility(testrepo: Repository) -> None:
+def test_ls_remotes_deprecated(testrepo: Repository) -> None:
     assert 1 == len(testrepo.remotes)
     remote = testrepo.remotes[0]
-    refs = remote.ls_remotes()
-    ref = refs[0]
 
-    for field in ('name', 'oid', 'loid', 'local', 'symref_target'):
-        new_value = getattr(ref, field)
-        with pytest.warns(DeprecationWarning, match='no longer returns a dict'):
-            old_value = ref[field]
-        assert new_value == old_value
+    new_refs = remote.list_heads()
+
+    with pytest.warns(DeprecationWarning, match='Use list_heads'):
+        old_refs = remote.ls_remotes()
+
+    for new, old in zip(new_refs, old_refs, strict=True):
+        assert new.name == old['name']
+        assert new.oid == old['oid']
+        assert new.loid == old['loid']
+        assert new.local == old['local']
+        assert new.symref_target == old['symref_target']
 
 
 @utils.requires_network
-def test_ls_remotes_without_implicit_connect(testrepo: Repository) -> None:
+def test_list_heads_without_implicit_connect(testrepo: Repository) -> None:
     assert 1 == len(testrepo.remotes)
     remote = testrepo.remotes[0]
 
     with pytest.raises(pygit2.GitError, match='this remote has never connected'):
-        remote.ls_remotes(connect=False)
+        remote.list_heads(connect=False)
 
     remote.connect()
-    refs = remote.ls_remotes(connect=False)
+    refs = remote.list_heads(connect=False)
     assert refs
 
     # Check that a known ref is returned.
@@ -328,7 +332,7 @@ def update_tips(self, name: str, old: pygit2.Oid, new: pygit2.Oid) -> None:
 
 
 @utils.requires_network
-def test_ls_remotes_certificate_check() -> None:
+def test_list_heads_certificate_check() -> None:
     url = 'https://github.com/pygit2/empty.git'
 
     class MyCallbacks(pygit2.RemoteCallbacks):
@@ -350,7 +354,7 @@ def certificate_check(
     remote = git.remotes.create_anonymous(url)
 
     callbacks = MyCallbacks()
-    refs = remote.ls_remotes(callbacks=callbacks)
+    refs = remote.list_heads(callbacks=callbacks)
 
     # Sanity check that we indeed got some refs.
     assert len(refs) > 0