Remove deprecated Remote.ls_remotes(...)

Use Remote.list_heads(...) instead

Assisted-by: Kimi-k2.7

Author: jdavid

AGENTS.md

@@ -56,8 +56,7 @@ modules:
     `repository.py`, `callbacks.py`, `config.py`, `index.py`, `remotes.py`,
     `settings.py`, `submodules.py`, `transaction.py`, `filter.py`, `blob.py`,
     `blame.py`, `branches.py`, `credentials.py`, `errors.py`, `options.py`,
-    `packbuilder.py`, `references.py`, `refspec.py`, `utils.py`, `enums.py`,
-    `legacyenums.py`.
+    `packbuilder.py`, `references.py`, `refspec.py`, `utils.py`, `enums.py`.
 
 - **`test/`** — pytest suite with fixture-based repository handling.
 - **`docs/`** — Sphinx documentation (RTD theme).
@@ -167,6 +166,9 @@ make -C docs html   # requires sphinx-rtd-theme
   - Target Python: 3.11+
   - Quote style: single quotes
   - Selected rules: `E4`, `E7`, `E9`, `F`, `I`, `UP035`, `UP007`
+  - Run `ruff format` and `ruff check` on changed files before committing.
+    CI runs `ruff format --diff` and `ruff check`; formatting failures will
+    fail the build.
 - **Type checker**: mypy (strict settings enabled; see `mypy.ini`)
 - All Python source files must include the standard GPLv2 copyright header.
 - `pygit2/__init__.py` is large because it re-exports a large surface of
@@ -275,5 +277,6 @@ and skips `*musllinux_ppc64le` plus testing on `*-*linux_ppc64le` and
   extension. Keep it in sync when adding or changing low-level APIs.
 - **Header stub order matters**: `pygit2/_run.py` concatenates `decl/*.h` in a
   fixed list; add new stubs in the correct position if dependencies require it.
-- Run the full test suite and type checks before considering a change complete:
-  `sh build.sh test` and `sh build.sh mypy`.
+- Run the full test suite, type checks, and linting/formatting before
+  considering a change complete:
+  `sh build.sh test`, `sh build.sh mypy`, `ruff check .`, and `ruff format .`.

CHANGELOG.md

@@ -15,6 +15,9 @@ Breaking changes:
   by default. The previous string-returning behavior is still available
   with `use_deprecated=True`, but is deprecated.
 
+- Remove deprecated `Remote.ls_remotes(...)`, use `Remote.list_heads(...)`
+  instead
+
 
 # 1.19.3 (2026-06-13)
 

pygit2/remotes.py

@@ -25,7 +25,6 @@
 
 from __future__ import annotations
 
-import warnings
 from collections.abc import Generator, Iterator
 from typing import TYPE_CHECKING, Any, Literal
 
@@ -281,30 +280,6 @@ def list_heads(
 
         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 if h.local else None,
-                '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

@@ -204,31 +204,6 @@ def test_list_heads(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_deprecated(testrepo: Repository) -> None:
-    assert 1 == len(testrepo.remotes)
-    remote = testrepo.remotes[0]
-
-    new_refs = remote.list_heads()
-
-    with pytest.warns(DeprecationWarning, match='Use list_heads'):
-        old_refs = remote.ls_remotes()
-
-    assert new_refs
-    assert old_refs
-
-    for new, old in zip(new_refs, old_refs, strict=True):
-        assert new.name == old['name']
-        assert new.oid == old['oid']
-        assert new.local == old['local']
-        assert new.symref_target == old['symref_target']
-        if new.local:
-            assert new.loid == old['loid']
-        else:
-            assert new.loid == pygit2.Oid(b'')
-            assert old['loid'] is None
-
-
 @utils.requires_network
 def test_list_heads_without_implicit_connect(testrepo: Repository) -> None:
     assert 1 == len(testrepo.remotes)

test/test_repository.py

@@ -1142,17 +1142,13 @@ def get_hello_txt_from_repo() -> str:
         return blob.data.decode()
 
     # no change
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_txt, hello_txt
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_txt, hello_txt)
     assert res == MergeFileResult(
         True, hello_txt.path, hello_txt.mode, get_hello_txt_from_repo()
     )
 
     # executable switch on ours
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_txt_executable, hello_txt
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_txt_executable, hello_txt)
     assert res == MergeFileResult(
         True,
         hello_txt.path,
@@ -1161,9 +1157,7 @@ def get_hello_txt_from_repo() -> str:
     )
 
     # executable switch on theirs
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_txt, hello_txt_executable
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_txt, hello_txt_executable)
     assert res == MergeFileResult(
         True,
         hello_txt.path,
@@ -1183,31 +1177,23 @@ def get_hello_txt_from_repo() -> str:
     )
 
     # path switch on ours
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_world, hello_txt
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_world, hello_txt)
     assert res == MergeFileResult(
         True, hello_world.path, hello_txt.mode, get_hello_txt_from_repo()
     )
 
     # path switch on theirs
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_txt, hello_world
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_txt, hello_world)
     assert res == MergeFileResult(
         True, hello_world.path, hello_txt.mode, get_hello_txt_from_repo()
     )
 
     # path switch on both
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_world, hello_world
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_world, hello_world)
     assert res == MergeFileResult(True, None, hello_txt.mode, get_hello_txt_from_repo())
 
     # path switch on ours, executable flag switch on theirs
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_world, hello_txt_executable
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_world, hello_txt_executable)
     assert res == MergeFileResult(
         True,
         hello_world.path,
@@ -1216,9 +1202,7 @@ def get_hello_txt_from_repo() -> str:
     )
 
     # path switch on theirs, executable flag switch on ours
-    res = testrepo.merge_file_from_index(
-        hello_txt, hello_txt_executable, hello_world
-    )
+    res = testrepo.merge_file_from_index(hello_txt, hello_txt_executable, hello_world)
     assert res == MergeFileResult(
         True,
         hello_world.path,