diff options
Diffstat (limited to 'cmd2/pyscript_bridge.py')
| -rw-r--r-- | cmd2/pyscript_bridge.py | 55 |
1 files changed, 29 insertions, 26 deletions
diff --git a/cmd2/pyscript_bridge.py b/cmd2/pyscript_bridge.py index feb50bab..7551ed88 100644 --- a/cmd2/pyscript_bridge.py +++ b/cmd2/pyscript_bridge.py @@ -45,8 +45,14 @@ class CommandResult(namedtuple_with_defaults('CommandResult', ['stdout', 'stderr return not self.stderr -def _exec_cmd(cmd2_app, func: Callable, echo: bool) -> CommandResult: - """Helper to encapsulate executing a command and capturing the results""" +def _exec_cmd(cmd2_app, command: str, echo: bool) -> CommandResult: + """ + Helper to encapsulate executing a command and capturing the results + :param cmd2_app: cmd2 app that will run the command + :param command: command line being run + :param echo: if True, output will be echoed to stdout/stderr while the command runs + :return: result of the command + """ copy_stdout = StdSim(sys.stdout, echo) copy_stderr = StdSim(sys.stderr, echo) @@ -58,7 +64,8 @@ def _exec_cmd(cmd2_app, func: Callable, echo: bool) -> CommandResult: cmd2_app.stdout = copy_cmd_stdout with redirect_stdout(copy_stdout): with redirect_stderr(copy_stderr): - func() + # Include a newline in case it's a multiline command + cmd2_app.onecmd_plus_hooks(command + '\n') finally: cmd2_app.stdout = copy_cmd_stdout.inner_stream @@ -199,21 +206,21 @@ class ArgparseFunctor: self._command_name)) # reconstruct the cmd2 command from the python call - command = self._command_name + ' ' + command = self._command_name def process_argument(action, value): nonlocal command if isinstance(action, argparse._CountAction): if isinstance(value, int): for _ in range(value): - command += '{} '.format(action.option_strings[0]) + command += ' {}'.format(action.option_strings[0]) return else: raise TypeError('Expected int for ' + action.dest) if isinstance(action, argparse._StoreConstAction) or isinstance(action, argparse._AppendConstAction): if value: # Nothing else to append to the command string, just the flag is enough. - command += '{} '.format(action.option_strings[0]) + command += ' {}'.format(action.option_strings[0]) return else: # value is not True so we default to false, which means don't include the flag @@ -221,7 +228,7 @@ class ArgparseFunctor: # was the argument a flag? if action.option_strings: - command += '{} '.format(action.option_strings[0]) + command += ' {}'.format(action.option_strings[0]) is_remainder_arg = action.dest == self._remainder_arg @@ -232,14 +239,14 @@ class ArgparseFunctor: raise ValueError('{} appears to be a flag and should be supplied as a keyword argument ' 'to the function.'.format(item)) item = quote_string_if_needed(item) - command += '{} '.format(item) + command += ' {}'.format(item) # If this is a flag parameter that can accept a variable number of arguments and we have not # reached the max number, add a list completion suffix to tell argparse to move to the next # parameter if action.option_strings and isinstance(action, _RangeAction) and action.nargs_max is not None and \ action.nargs_max > len(value): - command += '{0}{0} '.format(self._parser.prefix_chars[0]) + command += ' {0}{0}'.format(self._parser.prefix_chars[0]) else: value = str(value).strip() @@ -247,19 +254,19 @@ class ArgparseFunctor: raise ValueError('{} appears to be a flag and should be supplied as a keyword argument ' 'to the function.'.format(value)) value = quote_string_if_needed(value) - command += '{} '.format(value) + command += ' {}'.format(value) # If this is a flag parameter that can accept a variable number of arguments and we have not # reached the max number, add a list completion suffix to tell argparse to move to the next # parameter if action.option_strings and isinstance(action, _RangeAction) and action.nargs_max is not None and \ action.nargs_max > 1: - command += '{0}{0} '.format(self._parser.prefix_chars[0]) + command += ' {0}{0}'.format(self._parser.prefix_chars[0]) def process_action(action): nonlocal command if isinstance(action, argparse._SubParsersAction): - command += '{} '.format(self._args[action.dest]) + command += ' {}'.format(self._args[action.dest]) traverse_parser(action.choices[self._args[action.dest]]) elif isinstance(action, argparse._AppendAction): if isinstance(self._args[action.dest], list) or isinstance(self._args[action.dest], tuple): @@ -286,9 +293,7 @@ class ArgparseFunctor: process_action(action) traverse_parser(self._parser) - return _exec_cmd(self._cmd2_app, - functools.partial(self._cmd2_app.onecmd_plus_hooks, command.strip() + '\n'), - self._echo) + return _exec_cmd(self._cmd2_app, command, self._echo) class PyscriptBridge(object): @@ -313,10 +318,10 @@ class PyscriptBridge(object): else: # Command doesn't use argparse, we will accept parameters in the form of a command string def wrap_func(args=''): - command = (item + ' ' + args).strip() - return _exec_cmd(self._cmd2_app, - functools.partial(self._cmd2_app.onecmd_plus_hooks, command + '\n'), - self.cmd_echo) + command = item + if args: + command += ' ' + args + return _exec_cmd(self._cmd2_app, command, self.cmd_echo) return wrap_func else: @@ -329,17 +334,15 @@ class PyscriptBridge(object): attributes.insert(0, 'cmd_echo') return attributes - def __call__(self, args: str, echo: Optional[bool]=None) -> CommandResult: + def __call__(self, command: str, echo: Optional[bool]=None) -> CommandResult: """ Provide functionality to call application commands by calling PyscriptBridge ex: app('help') - :param args: The string being passed to the command - :param echo: If True, output will be echoed while the command runs - This temporarily overrides the value of self.cmd_echo + :param command: command line being run + :param echo: if True, output will be echoed to stdout/stderr while the command runs + this temporarily overrides the value of self.cmd_echo """ if echo is None: echo = self.cmd_echo - return _exec_cmd(self._cmd2_app, - functools.partial(self._cmd2_app.onecmd_plus_hooks, args + '\n'), - echo) + return _exec_cmd(self._cmd2_app, command, echo) |