Add argv to Statement object

Author: kotfu

cmd2/parsing.py

@@ -7,6 +7,7 @@
 from typing import List, Tuple
 
 from . import constants
+from . import utils
 
 LINE_FEED = '\n'
 
@@ -33,6 +34,10 @@ class Statement(str):
                             redirection or terminators. quoted arguments remain
                             quoted.
     :type args:             str or None
+    :var: argv:             a list of arguments a la sys.argv. Quotes, if any, are removed
+                            from the elements of the list, and aliases and shortcuts
+                            are expanded
+    :type argv:             list
     :var terminator:        the charater which terminated the multiline command, if
                             there was one
     :type terminator:       str or None
@@ -53,6 +58,7 @@ def __init__(self, obj):
         self.command = None
         self.multiline_command = None
         self.args = None
+        self.argv = None
         self.terminator = None
         self.suffix = None
         self.pipe_to = None
@@ -65,7 +71,14 @@ def command_and_args(self):
 
         Quoted arguments remain quoted.
         """
-        return '{} {}'.format('' if self.command is None else self.command, self.args).strip()
+        if self.command and self.args:
+            rtn = '{} {}'.format(self.command, self.args)
+        elif self.command:
+            # we are trusting that if we get here that self.args is None
+            rtn = self.command
+        else:
+            rtn = None
+        return rtn
 
 
 class StatementParser():
@@ -175,6 +188,7 @@ def parse(self, rawinput: str) -> Statement:
 
         command = None
         args = None
+        argv = None
 
         # lex the input into a list of tokens
         tokens = self.tokenize(rawinput)
@@ -198,7 +212,8 @@ def parse(self, rawinput: str) -> Statement:
             else:
                 terminator_pos = tokens.index(terminator)
             # everything before the first terminator is the command and the args
-            (command, args) = self._command_and_args(tokens[:terminator_pos])
+            argv = tokens[:terminator_pos]
+            (command, args) = self._command_and_args(argv)
             # we will set the suffix later
             # remove all the tokens before and including the terminator
             tokens = tokens[terminator_pos+1:]
@@ -210,6 +225,7 @@ def parse(self, rawinput: str) -> Statement:
                 # because redirectors can only be after a terminator
                 command = testcommand
                 args = testargs
+                argv = tokens
                 tokens = []
 
         # check for output redirect
@@ -253,7 +269,8 @@ def parse(self, rawinput: str) -> Statement:
             suffix = None
             if not command:
                 # command could already have been set, if so, don't set it again
-                (command, args) = self._command_and_args(tokens)
+                argv = tokens
+                (command, args) = self._command_and_args(argv)
 
         # set multiline
         if command in self.multiline_commands:
@@ -268,8 +285,9 @@ def parse(self, rawinput: str) -> Statement:
         statement.raw = rawinput
         statement.command = command
         # if there are no args we will use None since we don't have to worry
-        # about compatibility wiht standard library cmd
+        # about compatibility with standard library cmd
         statement.args = args
+        statement.argv = list(map(lambda x: utils.strip_quotes(x), argv))
         statement.terminator = terminator
         statement.output = output
         statement.output_to = output_to
@@ -291,10 +309,13 @@ def parse_command_only(self, rawinput: str) -> Statement:
         (command, args) = self._command_and_args(tokens)
 
         # build the statement
-        statement = Statement(args)
+        # string representation of args must be an empty string instead of
+        # None for compatibility with standard library cmd
+        statement = Statement('' if args is None else args)
         statement.raw = rawinput
         statement.command = command
         statement.args = args
+        statement.argv = tokens
         return statement
 
     def _expand(self, line: str) -> str:
@@ -341,7 +362,7 @@ def _command_and_args(tokens: List[str]) -> Tuple[str, str]:
         with cmd in the standard library.
         """
         command = None
-        args = ''
+        args = None
 
         if tokens:
             command = tokens[0]

docs/unfreefeatures.rst

@@ -29,15 +29,28 @@ input:
 command
     Name of the command called
 
+args
+    The arguments to the command with output redirection
+    or piping to shell commands removed
+
+command_and_args
+    A string of just the command and the arguments, with
+    output redirection or piping to shell commands removed
+
+argv
+    A list of arguments a-la ``sys.argv``, including
+    the command as ``argv[0]`` and the subsequent
+    arguments as additional items in the list.
+    Quotes around arguments will be stripped as will
+    any output redirection or piping portions of the command
+
 raw
     Full input exactly as typed.
 
 terminator
     Character used to end a multiline command
 
-command_and_args
-    A string of just the command and the arguments, with
-    output redirection or piping to shell commands removed
+
 
 If ``Statement`` does not contain an attribute,
 querying for it will return ``None``.