Better completion results order

gpotter2 · gpotter2 · commit de333118a7dc · 2023-07-22T17:03:16.000+02:00
diff --git a/bpython/autocomplete.py b/bpython/autocomplete.py
@@ -747,6 +747,16 @@ def get_completer(
             double underscore methods like __len__ in method signatures
     """
 
+    def _cmpl_sort(x: str) -> Tuple[Any, ...]:
+        """
+        Function used to sort the matches.
+        """
+        # put parameters above everything in completion
+        return (
+            x[-1] != "=",
+            x,
+        )
+
     for completer in completers:
         try:
             matches = completer.matches(
@@ -765,7 +775,9 @@ def get_completer(
             )
             continue
         if matches is not None:
-            return sorted(matches), (completer if matches else None)
+            return sorted(matches, key=_cmpl_sort), (
+                completer if matches else None
+            )
 
     return [], None
 
diff --git a/bpython/test/test_autocomplete.py b/bpython/test/test_autocomplete.py
@@ -106,6 +106,15 @@ def test_two_completers_get_both(self):
         cumulative = autocomplete.CumulativeCompleter([a, b])
         self.assertEqual(cumulative.matches(3, "abc"), {"a", "b"})
 
+    def test_order_completer(self):
+        a = self.completer(["ax", "ab="])
+        b = self.completer(["aa"])
+        cumulative = autocomplete.CumulativeCompleter([a, b])
+        self.assertEqual(
+            autocomplete.get_completer([cumulative], 1, "a"),
+            (["ab=", "aa", "ax"], cumulative),
+        )
+
 
 class TestFilenameCompletion(unittest.TestCase):
     def setUp(self):
