Merge pull request #623 from python-cmd2/pyscript_quit

Fixed issue where calling exit() or quit() from a pyscript would close the whole console

Author: tleonhardt

CHANGELOG.md

@@ -1,7 +1,10 @@
-## 0.9.8 (TBD, 2019)
+## 0.9.8 (February 06, 2019)
 * Bug Fixes
     * Fixed issue with echoing strings in StdSim. Because they were being sent to a binary buffer, line buffering
     was being ignored.
+* Enhancements
+    * Made quit() and exit() functions available to scripts run with pyscript. This allows those scripts to exit
+    back to the console's prompt instead of exiting the whole application.
 
 ## 0.9.7 (January 08, 2019)
 * Bug Fixes

cmd2/cmd2.py

@@ -2957,14 +2957,13 @@ def do_py(self, args: argparse.Namespace) -> bool:
             self.perror(err, traceback_war=False)
             self._last_result = CommandResult('', err)
             return False
-        self._in_py = True
 
-        # noinspection PyBroadException
         try:
+            self._in_py = True
+
             # Support the run command even if called prior to invoking an interactive interpreter
-            def run(filename: str):
+            def py_run(filename: str):
                 """Run a Python script file in the interactive console.
-
                 :param filename: filename of *.py script file to run
                 """
                 expanded_filename = os.path.expanduser(filename)
@@ -2979,9 +2978,16 @@ def run(filename: str):
                     error_msg = "Error opening script file '{}': {}".format(expanded_filename, ex)
                     self.perror(error_msg, traceback_war=False)
 
+            def py_quit():
+                """Function callable from the interactive Python console to exit that environment"""
+                raise EmbeddedConsoleExit
+
+            # Set up Python environment
             bridge = PyscriptBridge(self)
-            self.pystate['run'] = run
             self.pystate[self.pyscript_name] = bridge
+            self.pystate['run'] = py_run
+            self.pystate['quit'] = py_quit
+            self.pystate['exit'] = py_quit
 
             if self.locals_in_py:
                 self.pystate['self'] = self
@@ -3002,18 +3008,16 @@ def run(filename: str):
                 # Set cmd_echo to True so PyscriptBridge statements like: py app('help')
                 # run at the command line will print their output.
                 bridge.cmd_echo = True
-                interp.runcode(full_command)
+
+                # noinspection PyBroadException
+                try:
+                    interp.runcode(full_command)
+                except BaseException:
+                    # We don't care about any exception that happened in the interactive console
+                    pass
 
             # If there are no args, then we will open an interactive Python console
             else:
-                # noinspection PyShadowingBuiltins
-                def quit():
-                    """Function callable from the interactive Python console to exit that environment"""
-                    raise EmbeddedConsoleExit
-
-                self.pystate['quit'] = quit
-                self.pystate['exit'] = quit
-
                 # Set up readline for Python console
                 if rl_type != RlType.NONE:
                     # Save cmd2 history
@@ -3072,10 +3076,12 @@ def quit():
                                 'Run Python code from external script files with: run("script.py")'
                                 .format(self.pyscript_name))
 
+                # noinspection PyBroadException
                 try:
                     interp.interact(banner="Python {} on {}\n{}\n\n{}\n".
                                     format(sys.version, sys.platform, cprt, instructions))
-                except EmbeddedConsoleExit:
+                except BaseException:
+                    # We don't care about any exception that happened in the interactive console
                     pass
 
                 finally:
@@ -3109,10 +3115,12 @@ def quit():
                                     else:
                                         sys.modules['readline'] = saved_readline
 
-        except Exception:
+        except KeyboardInterrupt:
             pass
+
         finally:
             self._in_py = False
+
         return self._should_quit
 
     pyscript_parser = ACArgumentParser()
@@ -3123,21 +3131,30 @@ def quit():
             ACTION_ARG_CHOICES, ('path_complete',))
 
     @with_argparser(pyscript_parser)
-    def do_pyscript(self, args: argparse.Namespace) -> None:
+    def do_pyscript(self, args: argparse.Namespace) -> bool:
         """Run a Python script file inside the console"""
         script_path = os.path.expanduser(args.script_path)
+        py_return = False
 
         # Save current command line arguments
         orig_args = sys.argv
 
-        # Overwrite sys.argv to allow the script to take command line arguments
-        sys.argv = [script_path] + args.script_arguments
+        try:
+            # Overwrite sys.argv to allow the script to take command line arguments
+            sys.argv = [script_path] + args.script_arguments
+
+            # Run the script - use repr formatting to escape things which
+            # need to be escaped to prevent issues on Windows
+            py_return = self.do_py("run({!r})".format(script_path))
 
-        # Run the script - use repr formatting to escape things which need to be escaped to prevent issues on Windows
-        self.do_py("run({!r})".format(script_path))
+        except KeyboardInterrupt:
+            pass
+
+        finally:
+            # Restore command line arguments to original state
+            sys.argv = orig_args
 
-        # Restore command line arguments to original state
-        sys.argv = orig_args
+        return py_return
 
     # Only include the do_ipy() method if IPython is available on the system
     if ipython_available:  # pragma: no cover

examples/scripts/conditional.py

@@ -7,8 +7,8 @@
     ./python_scripting.py
     pyscript scripts/conditional.py directory_path
 
-Note: The "cmd" function is defined within the cmd2 embedded Python environment and in there "self" is your cmd2
-application instance.
+Note: The "app" function is defined within the cmd2 embedded Python environment and in there "self" is your cmd2
+application instance. Note: self only exists in this environment if locals_in_py is True.
 """
 import os
 import sys