spack.cmd.all_commands becomes more general, allowing for the location of subcommands.

greenc-FNAL · greenc-FNAL · commit 074c0f76b2e1 · 2018-10-31T15:01:49.000-05:00
diff --git a/lib/spack/spack/cmd/__init__.py b/lib/spack/spack/cmd/__init__.py
@@ -45,31 +45,33 @@ def cmd_name(python_name):
 
 #: global, cached list of all commands -- access through all_commands()
 _all_commands = None
+_default_command_path = spack.paths.command_path
 
 
-def all_commands():
-    """Get a sorted list of all spack commands.
+def all_commands(command_list, command_path=None):
+    """Get a sorted list of all commands at the specified path.
 
-    This will list the lib/spack/spack/cmd directory and find the
-    commands there to construct the list.  It does not actually import
-    the python files -- just gets the names.
+    This will list the command_path directory and find the commands
+    there to construct the list.  It does not actually import the python
+    files -- just gets the names. The names are cached in command_list.
     """
-    global _all_commands
-    if _all_commands is None:
-        _all_commands = []
+    if command_list is None:
+        command_list = []
         extensions = spack.config.get('config:extensions') or []
-        command_paths = itertools.chain(
-            [spack.paths.command_path],
-            spack.extensions.command_paths(*extensions)
-        )
+        command_paths \
+            = [command_path] if command_path else \
+            itertools.chain(
+                [_default_command_path],
+                spack.extensions.command_paths(*extensions)
+            )
         for path in command_paths:
             for file in os.listdir(path):
                 if file.endswith(".py") and not re.search(ignore_files, file):
                     cmd = re.sub(r'.py$', '', file)
-                    _all_commands.append(cmd_name(cmd))
-            _all_commands.sort()
+                    command_list.append(cmd_name(cmd))
+            command_list.sort()
 
-    return _all_commands
+    return command_list
 
 
 def remove_options(parser, *options):
diff --git a/lib/spack/spack/cmd/commands.py b/lib/spack/spack/cmd/commands.py
@@ -112,7 +112,7 @@ def rst(args):
 
 @formatter
 def names(args):
-    for cmd in spack.cmd.all_commands():
+    for cmd in spack.main.all_commands():
         print(cmd)
 
 
diff --git a/lib/spack/spack/main.py b/lib/spack/spack/main.py
@@ -80,6 +80,8 @@
 
 #: Recorded directory where spack command was originally invoked
 spack_working_dir = None
+#: All found spack commands
+_all_commands = None
 
 
 def set_working_dir():
@@ -92,16 +94,21 @@ def set_working_dir():
         spack_working_dir = spack.paths.prefix
 
 
+def all_commands():
+    """Return all top level commands available with Spack."""
+    return spack.cmd.all_commands(_all_commands)
+
+
 def add_all_commands(parser):
     """Add all spack subcommands to the parser."""
-    for cmd in spack.cmd.all_commands():
+    for cmd in spack.cmd.all_commands(_all_commands):
         parser.add_command(cmd)
 
 
 def index_commands():
     """create an index of commands by section for this help level"""
     index = {}
-    for command in spack.cmd.all_commands():
+    for command in all_commands():
         cmd_module = spack.cmd.get_module(command)
 
         # make sure command modules have required properties
@@ -160,7 +167,7 @@ def format_help_sections(self, level):
             self.actions = self._subparsers._actions[-1]._get_subactions()
 
         # make a set of commands not yet added.
-        remaining = set(spack.cmd.all_commands())
+        remaining = set(spack.main.all_commands())
 
         def add_group(group):
             formatter.start_section(group.title)
diff --git a/lib/spack/spack/test/cmd/commands.py b/lib/spack/spack/test/cmd/commands.py
@@ -20,7 +20,7 @@
 def test_commands_by_name():
     """Test default output of spack commands."""
     out = commands()
-    assert out.strip().split('\n') == sorted(spack.cmd.all_commands())
+    assert out.strip().split('\n') == sorted(spack.main.all_commands())
 
 
 def test_subcommands():
