Fix: include sub-commands in tab completion

For commands like `pip cache` with sub-commands like `remove`, so that
e.g. `pip cache re<TAB>` completes to `pip cache remove`.

All the existing commands that used such sub-commands followed the same
approach: using a dictionary of names to methods to run, so the
implementation is just  teaching the `Command` object about this mapping
and using it in the autocompletion function.

There's no handling for the position of the argument, so e.g. `pip cache
re<TAB>` and `pip  cache --user re<TAB>` will both complete the final
word to `remove`. This is mostly because it was simpler to implement like
this, but also I think due to how `optparse` works such invocations are
valid, e.g. `pip config --user set global.timeout 60`.

This is a feature that may be simpler to implement, or just work out of
the box, with some argument parsing libraries, but moving to another
such library looks to be quite a bit of work (see discussion[1]).

I also took the opportunity to tighten some typing: dropping some use of
`Any`

Link: #4659 [1]
Fixes: #13133

Author: matthewhughes934

news/0741cad6-3007-47f8-9c53-984e9116c7ff.bugfix.rst

@@ -0,0 +1 @@
+Include sub-commands in tab completion.

src/pip/_internal/cli/autocompletion.py

@@ -100,6 +100,12 @@ def autocomplete() -> None:
             if option[1] and option[0][:2] == "--":
                 opt_label += "="
             print(opt_label)
+
+        # Complete sub-commands (unless one is already given).
+        if not any(name in cwords for name in subcommand.handler_map()):
+            for handler_name in subcommand.handler_map():
+                if handler_name.startswith(current):
+                    print(handler_name)
     else:
         # show main parser options only when necessary
 

src/pip/_internal/cli/base_command.py

@@ -7,7 +7,7 @@
 import sys
 import traceback
 from optparse import Values
-from typing import List, Optional, Tuple
+from typing import Callable, Dict, List, Optional, Tuple
 
 from pip._vendor.rich import reconfigure
 from pip._vendor.rich import traceback as rich_traceback
@@ -231,3 +231,9 @@ def _main(self, args: List[str]) -> int:
                 options.cache_dir = None
 
         return self._run_wrapper(level_number, options, args)
+
+    def handler_map(self) -> Dict[str, Callable[[Values, List[str]], None]]:
+        """
+        map of names to handler actions for commands with sub-actions
+        """
+        return {}

src/pip/_internal/commands/cache.py

@@ -1,7 +1,7 @@
 import os
 import textwrap
 from optparse import Values
-from typing import Any, List
+from typing import Callable, Dict, List
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import ERROR, SUCCESS
@@ -49,45 +49,48 @@ def add_options(self) -> None:
 
         self.parser.insert_option_group(0, self.cmd_opts)
 
-    def run(self, options: Values, args: List[str]) -> int:
-        handlers = {
+    def handler_map(self) -> Dict[str, Callable[[Values, List[str]], None]]:
+        return {
             "dir": self.get_cache_dir,
             "info": self.get_cache_info,
             "list": self.list_cache_items,
             "remove": self.remove_cache_items,
             "purge": self.purge_cache,
         }
 
+    def run(self, options: Values, args: List[str]) -> int:
+        handler_map = self.handler_map()
+
         if not options.cache_dir:
             logger.error("pip cache commands can not function since cache is disabled.")
             return ERROR
 
         # Determine action
-        if not args or args[0] not in handlers:
+        if not args or args[0] not in handler_map:
             logger.error(
                 "Need an action (%s) to perform.",
-                ", ".join(sorted(handlers)),
+                ", ".join(sorted(handler_map)),
             )
             return ERROR
 
         action = args[0]
 
         # Error handling happens here, not in the action-handlers.
         try:
-            handlers[action](options, args[1:])
+            handler_map[action](options, args[1:])
         except PipError as e:
             logger.error(e.args[0])
             return ERROR
 
         return SUCCESS
 
-    def get_cache_dir(self, options: Values, args: List[Any]) -> None:
+    def get_cache_dir(self, options: Values, args: List[str]) -> None:
         if args:
             raise CommandError("Too many arguments")
 
         logger.info(options.cache_dir)
 
-    def get_cache_info(self, options: Values, args: List[Any]) -> None:
+    def get_cache_info(self, options: Values, args: List[str]) -> None:
         if args:
             raise CommandError("Too many arguments")
 
@@ -129,7 +132,7 @@ def get_cache_info(self, options: Values, args: List[Any]) -> None:
 
         logger.info(message)
 
-    def list_cache_items(self, options: Values, args: List[Any]) -> None:
+    def list_cache_items(self, options: Values, args: List[str]) -> None:
         if len(args) > 1:
             raise CommandError("Too many arguments")
 
@@ -161,7 +164,7 @@ def format_for_abspath(self, files: List[str]) -> None:
         if files:
             logger.info("\n".join(sorted(files)))
 
-    def remove_cache_items(self, options: Values, args: List[Any]) -> None:
+    def remove_cache_items(self, options: Values, args: List[str]) -> None:
         if len(args) > 1:
             raise CommandError("Too many arguments")
 
@@ -188,7 +191,7 @@ def remove_cache_items(self, options: Values, args: List[Any]) -> None:
             logger.verbose("Removed %s", filename)
         logger.info("Files removed: %s (%s)", len(files), format_size(bytes_removed))
 
-    def purge_cache(self, options: Values, args: List[Any]) -> None:
+    def purge_cache(self, options: Values, args: List[str]) -> None:
         if args:
             raise CommandError("Too many arguments")
 

src/pip/_internal/commands/configuration.py

@@ -2,7 +2,7 @@
 import os
 import subprocess
 from optparse import Values
-from typing import Any, List, Optional
+from typing import Any, Callable, Dict, List, Optional
 
 from pip._internal.cli.base_command import Command
 from pip._internal.cli.status_codes import ERROR, SUCCESS
@@ -93,8 +93,8 @@ def add_options(self) -> None:
 
         self.parser.insert_option_group(0, self.cmd_opts)
 
-    def run(self, options: Values, args: List[str]) -> int:
-        handlers = {
+    def handler_map(self) -> Dict[str, Callable[[Values, List[str]], None]]:
+        return {
             "list": self.list_values,
             "edit": self.open_in_editor,
             "get": self.get_name,
@@ -103,11 +103,14 @@ def run(self, options: Values, args: List[str]) -> int:
             "debug": self.list_config_values,
         }
 
+    def run(self, options: Values, args: List[str]) -> int:
+        handler_map = self.handler_map()
+
         # Determine action
-        if not args or args[0] not in handlers:
+        if not args or args[0] not in handler_map:
             logger.error(
                 "Need an action (%s) to perform.",
-                ", ".join(sorted(handlers)),
+                ", ".join(sorted(handler_map)),
             )
             return ERROR
 
@@ -131,7 +134,7 @@ def run(self, options: Values, args: List[str]) -> int:
 
         # Error handling happens here, not in the action-handlers.
         try:
-            handlers[action](options, args[1:])
+            handler_map[action](options, args[1:])
         except PipError as e:
             logger.error(e.args[0])
             return ERROR

src/pip/_internal/commands/index.py

@@ -1,7 +1,7 @@
 import json
 import logging
 from optparse import Values
-from typing import Any, Iterable, List, Optional
+from typing import Any, Callable, Dict, Iterable, List, Optional
 
 from pip._vendor.packaging.version import Version
 
@@ -50,24 +50,27 @@ def add_options(self) -> None:
         self.parser.insert_option_group(0, index_opts)
         self.parser.insert_option_group(0, self.cmd_opts)
 
-    def run(self, options: Values, args: List[str]) -> int:
-        handlers = {
+    def handler_map(self) -> Dict[str, Callable[[Values, List[str]], None]]:
+        return {
             "versions": self.get_available_package_versions,
         }
 
+    def run(self, options: Values, args: List[str]) -> int:
+        handler_map = self.handler_map()
+
         # Determine action
-        if not args or args[0] not in handlers:
+        if not args or args[0] not in handler_map:
             logger.error(
                 "Need an action (%s) to perform.",
-                ", ".join(sorted(handlers)),
+                ", ".join(sorted(handler_map)),
             )
             return ERROR
 
         action = args[0]
 
         # Error handling happens here, not in the action-handlers.
         try:
-            handlers[action](options, args[1:])
+            handler_map[action](options, args[1:])
         except PipError as e:
             logger.error(e.args[0])
             return ERROR

tests/functional/test_completion.py

@@ -427,3 +427,36 @@ def test_completion_uses_same_executable_name(
         expect_stderr=deprecated_python,
     )
     assert executable_name in result.stdout
+
+
+@pytest.mark.parametrize(
+    "subcommand, handler_prefix, expected",
+    [
+        ("cache", "d", "dir"),
+        ("cache", "in", "info"),
+        ("cache", "l", "list"),
+        ("cache", "re", "remove"),
+        ("cache", "pu", "purge"),
+        ("config", "li", "list"),
+        ("config", "e", "edit"),
+        ("config", "ge", "get"),
+        ("config", "se", "set"),
+        ("config", "unse", "unset"),
+        ("config", "d", "debug"),
+        ("index", "ve", "versions"),
+    ],
+)
+def test_completion_for_action_handler(
+    subcommand: str, handler_prefix: str, expected: str, autocomplete: DoAutocomplete
+) -> None:
+    res, _ = autocomplete(f"pip {subcommand} {handler_prefix}", cword="2")
+
+    assert [expected] == res.stdout.split()
+
+
+def test_completion_for_action_handler_handler_not_repeated(
+    autocomplete: DoAutocomplete,
+) -> None:
+    res, _ = autocomplete("pip cache remove re", cword="3")
+
+    assert [] == res.stdout.split()