Merge pull request #627 from python-cmd2/tab_settables

Tab settables

Author: kmvanbrunt

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.9 (TBD, 2019)
+* Bug Fixes
+    * Fixed bug where the ``set`` command was not tab completing from the current ``settable`` dictionary.
+    
 ## 0.9.8 (February 06, 2019)
 * Bug Fixes
     * Fixed issue with echoing strings in StdSim. Because they were being sent to a binary buffer, line buffering

README.md

@@ -242,12 +242,14 @@ class CmdLineApp(cmd2.Cmd):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'max repetitions for speak command'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'&': 'speak'})
 
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=False)
+        
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'max repetitions for speak command'
 
     speak_parser = argparse.ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')

cmd2/cmd2.py

@@ -1599,13 +1599,17 @@ def get_visible_commands(self) -> List[str]:
         return commands
 
     def get_alias_names(self) -> List[str]:
-        """Return a list of alias names."""
+        """Return list of current alias names"""
         return list(self.aliases)
 
     def get_macro_names(self) -> List[str]:
-        """Return a list of macro names."""
+        """Return list of current macro names"""
         return list(self.macros)
 
+    def get_settable_names(self) -> List[str]:
+        """Return list of current settable names"""
+        return list(self.settable)
+
     def get_commands_aliases_and_macros_for_completion(self) -> List[str]:
         """Return a list of visible commands, aliases, and macros for tab completion"""
         visible_commands = set(self.get_visible_commands())
@@ -2832,7 +2836,7 @@ def show(self, args: argparse.Namespace, parameter: str='') -> None:
     set_parser.add_argument('-a', '--all', action='store_true', help='display read-only settings as well')
     set_parser.add_argument('-l', '--long', action='store_true', help='describe function of parameter')
     setattr(set_parser.add_argument('param', nargs='?', help='parameter to set or view'),
-            ACTION_ARG_CHOICES, settable)
+            ACTION_ARG_CHOICES, get_settable_names)
     set_parser.add_argument('value', nargs='?', help='the new value for settable')
 
     @with_argparser(set_parser)

examples/cmd_as_argument.py

@@ -33,13 +33,15 @@ def __init__(self):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'max repetitions for speak command'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'&': 'speak'})
 
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=False)
 
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'max repetitions for speak command'
+
     speak_parser = argparse.ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
     speak_parser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')

examples/colors.py

@@ -66,13 +66,15 @@ def __init__(self):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'max repetitions for speak command'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'&': 'speak'})
 
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=True)
 
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'max repetitions for speak command'
+
     speak_parser = argparse.ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
     speak_parser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')

examples/decorator_example.py

@@ -23,12 +23,12 @@ def __init__(self, ip_addr=None, port=None, transcript_files=None):
         self.shortcuts.update({'&': 'speak'})
         self.maxrepeats = 3
 
-        # Add stuff to settable and/or shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'Max number of `--repeat`s allowed'
-
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=False, transcript_files=transcript_files)
 
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'Max number of `--repeat`s allowed'
+
         # Disable cmd's usage of command-line arguments as commands to be run at invocation
         # self.allow_cli_args = False
 

examples/environment.py

@@ -14,9 +14,9 @@ class EnvironmentApp(cmd2.Cmd):
     sunny = False
 
     def __init__(self):
+        super().__init__()
         self.settable.update({'degrees_c': 'Temperature in Celsius'})
         self.settable.update({'sunny': 'Is it sunny outside?'})
-        super().__init__()
 
     def do_sunbathe(self, arg):
         if self.degrees_c < 20:

examples/example.py

@@ -30,13 +30,15 @@ def __init__(self):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'max repetitions for speak command'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'&': 'speak'})
 
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=False)
 
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'max repetitions for speak command'
+
     speak_parser = argparse.ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
     speak_parser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')

examples/pirate.py

@@ -32,12 +32,15 @@ def __init__(self):
         self.terminators = self.terminators + ['...']
         self.songcolor = Fore.BLUE
 
-        # Add stuff to settable and/or shortcuts before calling base class initializer
-        self.settable['songcolor'] = 'Color to ``sing`` in (black/red/green/yellow/blue/magenta/cyan/white)'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'~': 'sing'})
 
         """Initialize the base class as well as this one"""
         super().__init__()
+
+        # Make songcolor settable at runtime
+        self.settable['songcolor'] = 'Color to ``sing`` in (black/red/green/yellow/blue/magenta/cyan/white)'
+
         # prompts and defaults
         self.gold = 0
         self.initial_gold = self.gold

examples/plumbum_colors.py

@@ -69,13 +69,15 @@ def __init__(self):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and shortcuts before calling base class initializer
-        self.settable['maxrepeats'] = 'max repetitions for speak command'
+        # Add stuff to shortcuts before calling base class initializer
         self.shortcuts.update({'&': 'speak'})
 
         # Set use_ipython to True to enable the "ipy" command which embeds and interactive IPython shell
         super().__init__(use_ipython=True)
 
+        # Make maxrepeats settable at runtime
+        self.settable['maxrepeats'] = 'max repetitions for speak command'
+
     speak_parser = argparse.ArgumentParser()
     speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
     speak_parser.add_argument('-s', '--shout', action='store_true', help='N00B EMULATION MODE')

tests/test_cmd2.py

@@ -1849,6 +1849,9 @@ def test_get_macro_names(base_app):
     assert len(base_app.macros) == 2
     assert sorted(base_app.get_macro_names()) == ['bar', 'foo']
 
+def test_get_settable_names(base_app):
+    assert sorted(base_app.get_settable_names()) == sorted(base_app.settable.keys())
+
 def test_alias_no_subcommand(base_app, capsys):
     out = run_cmd(base_app, 'alias')
     assert "Usage: alias [-h]" in out[0]

tests/test_transcript.py

@@ -32,10 +32,11 @@ def __init__(self, *args, **kwargs):
         self.multiline_commands = ['orate']
         self.maxrepeats = 3
 
-        # Add stuff to settable and/or shortcuts before calling base class initializer
+        super().__init__(*args, **kwargs)
+
+        # Make maxrepeats settable at runtime
         self.settable['maxrepeats'] = 'Max number of `--repeat`s allowed'
 
-        super().__init__(*args, **kwargs)
         self.intro = 'This is an intro banner ...'
 
     speak_parser = argparse.ArgumentParser()