Allow bypassing automatic connection in Remote.ls_remotes()

Remote.ls_remotes() used to force a new connection to the remote. This can be harmful if a connection was already set up for other purposes, e.g. when calling ls_remotes from RemoteCallbacks.push_negotiation.

This new argument `ls_remotes(..., connect)` lets you bypass the automatic connection.

Author: jorio

pygit2/remotes.py

@@ -224,7 +224,10 @@ def fetch(
         return TransferProgress(C.git_remote_stats(self._remote))
 
     def ls_remotes(
-        self, callbacks: RemoteCallbacks | None = None, proxy: str | None | bool = None
+        self,
+        callbacks: RemoteCallbacks | None = None,
+        proxy: str | None | bool = None,
+        connect: bool = True,
     ) -> list[LsRemotesDict]:
         """
         Return a list of dicts that maps to `git_remote_head` from a
@@ -235,9 +238,14 @@ def ls_remotes(
         callbacks : Passed to connect()
 
         proxy : Passed to connect()
+
+        connect : Whether to connect to the remote first. You can pass False
+        if the remote has already connected. The list remains available after
+        disconnecting as long as a new connection is not initiated.
         """
 
-        self.connect(callbacks=callbacks, proxy=proxy)
+        if connect:
+            self.connect(callbacks=callbacks, proxy=proxy)
 
         refs = ffi.new('git_remote_head ***')
         refs_len = ffi.new('size_t *')

test/test_remote.py

@@ -204,6 +204,22 @@ def test_ls_remotes(testrepo: Repository) -> None:
     assert next(iter(r for r in refs if r['name'] == 'refs/tags/v0.28.2'))
 
 
+@utils.requires_network
+def test_ls_remotes_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.connect()
+    refs = remote.ls_remotes(connect=False)
+    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'))
+
+
 def test_remote_collection(testrepo: Repository) -> None:
     remote = testrepo.remotes['origin']
     assert REMOTE_NAME == remote.name