Merge branch 'macro' into argparse_conversion

Author: kmvanbrunt

CHANGELOG.md

@@ -24,7 +24,7 @@
     * Added ``macro`` command to create macros, which are similar to aliases, but can take arguments when called
     * ``alias`` is now an argparse command with subcommands to create, list, and delete aliases 
 * Deprecations
-    * Deprecated the builtin ``cmd2`` support for colors including ``Cmd.colorize()`` and ``Cmd._colorcodes``
+    * Deprecated the built-in ``cmd2`` support for colors including ``Cmd.colorize()`` and ``Cmd._colorcodes``
     * `unalias` is no longer a command since ``alias delete`` replaced it
 * Deletions
     * The ``preparse``, ``postparsing_precmd``, and ``postparsing_postcmd`` methods *deprecated* in the previous release 

cmd2/cmd2.py

@@ -59,7 +59,7 @@ class Macro:
     required_arg_count = attr.ib(validator=attr.validators.instance_of(int))
 
     # Used to fill in argument placeholders in the macro
-    arg_list = attr.ib(factory=list, validator=attr.validators.instance_of(list))
+    arg_list = attr.ib(default=attr.Factory(list), validator=attr.validators.instance_of(list))
 
 
 @attr.s(frozen=True)
@@ -308,17 +308,17 @@ def is_valid_command(self, word: str) -> Tuple[bool, str]:
 
         valid, errmsg = statement_parser.is_valid_command('>')
         if not valid:
-            errmsg = "Aliases {}".format(errmsg)
+            errmsg = "Alias {}".format(errmsg)
         """
         valid = False
 
         if not word:
             return False, 'cannot be an empty string'
 
-        errmsg = 'cannot start with a shortcut: '
-        errmsg += ', '.join(shortcut for (shortcut, expansion) in self.shortcuts)
         for (shortcut, expansion) in self.shortcuts:
             if word.startswith(shortcut):
+                errmsg = 'cannot start with a shortcut: '
+                errmsg += ', '.join(shortcut for (shortcut, expansion) in self.shortcuts)
                 return False, errmsg
 
         errmsg = 'cannot contain: whitespace, quotes, '

cmd2/parsing.py

@@ -308,7 +308,7 @@ def __getattr__(self, item: str):
 
 def unquote_redirection_tokens(args: List[str]) -> None:
     """
-    Used to unquote redirection tokens in a list of command line arguments
+    Unquote redirection tokens in a list of command-line arguments
     This is used when redirection tokens have to be passed to another command
     :param args: the command line args
     """

cmd2/utils.py

@@ -1,2 +1,2 @@
-alias ls !ls -hal
-alias pwd !pwd
+alias create ls !ls -hal
+alias create pwd !pwd

examples/.cmd2rc

@@ -2,13 +2,12 @@
 # coding=utf-8
 """A simple example demonstrating the following:
     1) How arguments and options get parsed and passed to commands
-    2) How to change what syntax get parsed as a comment and stripped from
-       the arguments
+    2) How to change what syntax get parsed as a comment and stripped from the arguments
 
 This is intended to serve as a live demonstration so that developers can
 experiment with and understand how command and argument parsing work.
 
-It also serves as an example of how to create command aliases (shortcuts).
+It also serves as an example of how to create shortcuts.
 """
 import argparse
 
@@ -18,7 +17,7 @@ class ArgumentAndOptionPrinter(cmd2.Cmd):
     """ Example cmd2 application where we create commands that just print the arguments they are called with."""
 
     def __init__(self):
-        # Create command aliases which are shorter
+        # Create command shortcuts which are typically 1 character abbreviations which can be used in place of a command
         self.shortcuts.update({'$': 'aprint', '%': 'oprint'})
 
         # Make sure to call this super class __init__ *after* setting and/or updating shortcuts

examples/arg_print.py

@@ -160,11 +160,9 @@ def get_begidx():
     def get_endidx():
         return endidx
 
-    first_match = None
     with mock.patch.object(readline, 'get_line_buffer', get_line):
         with mock.patch.object(readline, 'get_begidx', get_begidx):
             with mock.patch.object(readline, 'get_endidx', get_endidx):
                 # Run the readline tab-completion function with readline mocks in place
                 first_match = app.complete(text, 0)
-
-    return first_match
+                return first_match

tests/conftest.py

@@ -1852,7 +1852,7 @@ def test_alias_create_with_macro_name(base_app, capsys):
     run_cmd(base_app, 'macro create {} help'.format(macro))
     run_cmd(base_app, 'alias create {} help'.format(macro))
     out, err = capsys.readouterr()
-    assert "Aliases cannot have the same name as a macro" in err
+    assert "Alias cannot have the same name as a macro" in err
 
 def test_alias_list_invalid_alias(base_app, capsys):
     # Look up invalid alias
@@ -1953,13 +1953,13 @@ def test_macro_create_with_alias_name(base_app, capsys):
     run_cmd(base_app, 'alias create {} help'.format(macro))
     run_cmd(base_app, 'macro create {} help'.format(macro))
     out, err = capsys.readouterr()
-    assert "Macros cannot have the same name as an alias" in err
+    assert "Macro cannot have the same name as an alias" in err
 
 def test_macro_create_with_command_name(base_app, capsys):
     macro = "my_macro"
     run_cmd(base_app, 'macro create help stuff')
     out, err = capsys.readouterr()
-    assert "Macros cannot have the same name as a command" in err
+    assert "Macro cannot have the same name as a command" in err
 
 def test_macro_create_with_args(base_app, capsys):
     # Create the macro

tests/test_cmd2.py

@@ -15,7 +15,7 @@
 import pytest
 import cmd2
 from cmd2 import utils
-from .conftest import complete_tester
+from .conftest import base_app, complete_tester, normalize, run_cmd
 from examples.subcommands import SubcommandsExample
 
 # List of strings used with completion functions
@@ -113,6 +113,23 @@ def test_complete_bogus_command(cmd2_app):
     first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
     assert first_match is None
 
+def test_complete_macro(base_app, request):
+    # Create the macro
+    out = run_cmd(base_app, 'macro create fake pyscript {1}')
+    assert out == normalize("Macro 'fake' created")
+
+    # Macros do path completion
+    test_dir = os.path.dirname(request.module.__file__)
+
+    text = os.path.join(test_dir, 'script.py')
+    line = 'fake {}'.format(text)
+
+    endidx = len(line)
+    begidx = endidx - len(text)
+
+    first_match = complete_tester(text, line, begidx, endidx, base_app)
+    assert first_match == text + ' '
+
 
 def test_cmd2_command_completion_multiple(cmd2_app):
     text = 'h'