Made last_result public and restored the initialization of it in __init__ and associated comment

Author: tleonhardt

cmd2/cmd2.py

@@ -423,6 +423,10 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
         # True if running inside a Python script or interactive console, False otherwise
         self._in_py = False
 
+        # 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
+
         # Used by run_script command to store current script dir as a LIFO queue to support _relative_run_script command
         self._script_dir = []
 

cmd2/pyscript_bridge.py

@@ -23,7 +23,7 @@ class CommandResult(namedtuple_with_defaults('CommandResult', ['stdout', 'stderr
 
     Any combination of these fields can be used when developing a scripting API for a given command.
     By default stdout, stderr, and stop will be captured for you. If there is additional command specific data,
-    then write that to cmd2's _last_result member. That becomes the data member of this tuple.
+    then write that to cmd2's last_result member. That becomes the data member of this tuple.
 
     In some cases, the data member may contain everything needed for a command and storing stdout
     and stderr might just be a duplication of data that wastes memory. In that case, the StdSim can
@@ -88,7 +88,7 @@ def __call__(self, command: str, echo: Optional[bool] = None) -> CommandResult:
         # This will be used to capture sys.stderr
         copy_stderr = StdSim(sys.stderr, echo)
 
-        self._cmd2_app._last_result = None
+        self._cmd2_app.last_result = None
 
         stop = False
         try:
@@ -105,5 +105,5 @@ def __call__(self, command: str, echo: Optional[bool] = None) -> CommandResult:
         result = CommandResult(stdout=copy_cmd_stdout.getvalue(),
                                stderr=copy_stderr.getvalue() if copy_stderr.getvalue() else None,
                                stop=stop,
-                               data=self._cmd2_app._last_result)
+                               data=self._cmd2_app.last_result)
         return result

docs/argument_processing.rst

@@ -267,7 +267,7 @@ Here's what it looks like::
         if unknown:
             self.perror("dir does not take any positional arguments:", traceback_war=False)
             self.do_help('dir')
-            self._last_result = CommandResult('', 'Bad arguments')
+            self.last_result = CommandResult('', 'Bad arguments')
             return
 
         # Get the contents as a list

examples/python_scripting.py

@@ -58,7 +58,7 @@ def do_cd(self, arglist):
         if not arglist or len(arglist) != 1:
             self.perror("cd requires exactly 1 argument:", traceback_war=False)
             self.do_help('cd')
-            self._last_result = cmd2.CommandResult('', 'Bad arguments')
+            self.last_result = cmd2.CommandResult('', 'Bad arguments')
             return
 
         # Convert relative paths to absolute paths
@@ -84,7 +84,7 @@ def do_cd(self, arglist):
 
         if err:
             self.perror(err, traceback_war=False)
-        self._last_result = cmd2.CommandResult(out, err, data)
+        self.last_result = cmd2.CommandResult(out, err, data)
 
     # Enable tab completion for cd command
     def complete_cd(self, text, line, begidx, endidx):
@@ -100,7 +100,7 @@ def do_dir(self, args, unknown):
         if unknown:
             self.perror("dir does not take any positional arguments:", traceback_war=False)
             self.do_help('dir')
-            self._last_result = cmd2.CommandResult('', 'Bad arguments')
+            self.last_result = cmd2.CommandResult('', 'Bad arguments')
             return
 
         # Get the contents as a list
@@ -113,7 +113,7 @@ def do_dir(self, args, unknown):
             self.stdout.write(fmt.format(f))
         self.stdout.write('\n')
 
-        self._last_result = cmd2.CommandResult(data=contents)
+        self.last_result = cmd2.CommandResult(data=contents)
 
 
 if __name__ == '__main__':

examples/scripts/conditional.py

@@ -27,10 +27,10 @@
 app('cd {}'.format(directory))
 
 # Conditionally do something based on the results of the last command
-if self._last_result:
+if self.last_result:
     print('\nContents of directory {!r}:'.format(directory))
     app('dir -l')
-    print('{}\n'.format(self._last_result.data))
+    print('{}\n'.format(self.last_result.data))
 
     # Change back to where we were
     print('Changing back to original directory: {!r}'.format(original_dir))

tests/test_cmd2.py

@@ -1241,16 +1241,16 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def do_affirmative(self, arg):
-        self._last_result = cmd2.CommandResult(arg, data=True)
+        self.last_result = cmd2.CommandResult(arg, data=True)
 
     def do_negative(self, arg):
-        self._last_result = cmd2.CommandResult(arg, data=False)
+        self.last_result = cmd2.CommandResult(arg, data=False)
 
     def do_affirmative_no_data(self, arg):
-        self._last_result = cmd2.CommandResult(arg)
+        self.last_result = cmd2.CommandResult(arg)
 
     def do_negative_no_data(self, arg):
-        self._last_result = cmd2.CommandResult('', arg)
+        self.last_result = cmd2.CommandResult('', arg)
 
 @pytest.fixture
 def commandresult_app():
@@ -1260,22 +1260,22 @@ def commandresult_app():
 def test_commandresult_truthy(commandresult_app):
     arg = 'foo'
     run_cmd(commandresult_app, 'affirmative {}'.format(arg))
-    assert commandresult_app._last_result
-    assert commandresult_app._last_result == cmd2.CommandResult(arg, data=True)
+    assert commandresult_app.last_result
+    assert commandresult_app.last_result == cmd2.CommandResult(arg, data=True)
 
     run_cmd(commandresult_app, 'affirmative_no_data {}'.format(arg))
-    assert commandresult_app._last_result
-    assert commandresult_app._last_result == cmd2.CommandResult(arg)
+    assert commandresult_app.last_result
+    assert commandresult_app.last_result == cmd2.CommandResult(arg)
 
 def test_commandresult_falsy(commandresult_app):
     arg = 'bar'
     run_cmd(commandresult_app, 'negative {}'.format(arg))
-    assert not commandresult_app._last_result
-    assert commandresult_app._last_result == cmd2.CommandResult(arg, data=False)
+    assert not commandresult_app.last_result
+    assert commandresult_app.last_result == cmd2.CommandResult(arg, data=False)
 
     run_cmd(commandresult_app, 'negative_no_data {}'.format(arg))
-    assert not commandresult_app._last_result
-    assert commandresult_app._last_result == cmd2.CommandResult('', arg)
+    assert not commandresult_app.last_result
+    assert commandresult_app.last_result == cmd2.CommandResult('', arg)
 
 
 def test_is_text_file_bad_input(base_app):