diff options
| -rwxr-xr-x | cmd2/cmd2.py | 6 | ||||
| -rw-r--r-- | docs/features/shortcuts_aliases_macros.rst | 1 | ||||
| -rwxr-xr-x | tests/test_cmd2.py | 4 |
3 files changed, 11 insertions, 0 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index d82e58c9..305c4173 100755 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -448,6 +448,12 @@ class Cmd(cmd.Cmd): multiline_commands=multiline_commands, shortcuts=shortcuts) + # Verify commands don't have invalid names (like starting with a shortcut) + for cmd in self.get_all_commands(): + valid, errmsg = self.statement_parser.is_valid_command(cmd) + if not valid: + raise ValueError("Invalid command name {!r}: {}".format(cmd, errmsg)) + # Stores results from the last command run to enable usage of results in a Python script or interactive console # Built-in commands don't make use of this. It is purely there for user-defined commands and convenience. self.last_result = None diff --git a/docs/features/shortcuts_aliases_macros.rst b/docs/features/shortcuts_aliases_macros.rst index 5628dc66..43a26ad7 100644 --- a/docs/features/shortcuts_aliases_macros.rst +++ b/docs/features/shortcuts_aliases_macros.rst @@ -38,6 +38,7 @@ To define more shortcuts, update the dict ``App.shortcuts`` with the updating the ``shortcuts`` attribute This warning applies in general to many other attributes which are not settable at runtime. +Note: Command, alias, and macro names cannot start with a shortcut Aliases ------- diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py index 1ba10f6b..85246c96 100755 --- a/tests/test_cmd2.py +++ b/tests/test_cmd2.py @@ -87,6 +87,10 @@ def test_base_shortcuts(base_app): expected = normalize(SHORTCUTS_TXT) assert out == expected +def test_command_starts_with_shortcut(): + with pytest.raises(ValueError) as excinfo: + app = cmd2.Cmd(shortcuts={'help': 'fake'}) + assert "Invalid command name 'help'" in str(excinfo.value) def test_base_show(base_app): # force editor to be 'vim' so test is repeatable across platforms |