Changed default behavior of runcmds_plus_hooks() to not stop when Ctrl-C is pressed and instead run the next command in its list.

Author: kmvanbrunt

CHANGELOG.md

@@ -28,6 +28,8 @@
       of this parameter.
     * Removed ability to run Python commands from the command line with `py`. Now `py` takes no arguments
       and just opens an interactive Python shell.
+    * Changed default behavior of `runcmds_plus_hooks()` to not stop when Ctrl-C is pressed and instead
+      run the next command in its list.
 * Enhancements
     * Added support for custom tab completion and up-arrow input history to `cmd2.Cmd2.read_input`.
       See [read_input.py](https://github.com/python-cmd2/cmd2/blob/master/examples/read_input.py)

cmd2/cmd2.py

@@ -2405,16 +2405,17 @@ def runcmds_plus_hooks(
         cmds: Union[List[HistoryItem], List[str]],
         *,
         add_to_history: bool = True,
-        stop_on_keyboard_interrupt: bool = True,
+        stop_on_keyboard_interrupt: bool = False,
     ) -> bool:
         """
         Used when commands are being run in an automated fashion like text scripts or history replays.
         The prompt and command line for each command will be printed if echo is True.
 
         :param cmds: commands to run
         :param add_to_history: If True, then add these commands to history. Defaults to True.
-        :param stop_on_keyboard_interrupt: stop command loop if Ctrl-C is pressed instead of just
-                                           moving to the next command. Defaults to True.
+        :param stop_on_keyboard_interrupt: if True, then stop running contents of cmds if Ctrl-C is pressed instead of moving
+                                           to the next command in the list. This is used when the commands are part of a
+                                           group, like a text script, which should stop upon Ctrl-C. Defaults to False.
         :return: True if running of commands should stop
         """
         for line in cmds:
@@ -4684,7 +4685,7 @@ def do_run_script(self, args: argparse.Namespace) -> Optional[bool]:
             if args.transcript:
                 self._generate_transcript(script_commands, os.path.expanduser(args.transcript))
             else:
-                return self.runcmds_plus_hooks(script_commands)
+                return self.runcmds_plus_hooks(script_commands, stop_on_keyboard_interrupt=True)
 
         finally:
             with self.sigint_protection:

tests/test_cmd2.py

@@ -422,19 +422,19 @@ def do_keyboard_interrupt(self, _):
 
     setattr(base_app, 'do_keyboard_interrupt', types.MethodType(do_keyboard_interrupt, base_app))
 
-    # Default behavior is to stop command loop on Ctrl-C
+    # Default behavior is to not stop runcmds_plus_hooks() on Ctrl-C
     base_app.history.clear()
     base_app.runcmds_plus_hooks(['help', 'keyboard_interrupt', 'shortcuts'])
     out, err = capsys.readouterr()
-    assert err.startswith("Interrupting this command")
-    assert len(base_app.history) == 2
+    assert not err
+    assert len(base_app.history) == 3
 
-    # Ctrl-C should not stop command loop in this case
+    # Ctrl-C should stop runcmds_plus_hooks() in this case
     base_app.history.clear()
-    base_app.runcmds_plus_hooks(['help', 'keyboard_interrupt', 'shortcuts'], stop_on_keyboard_interrupt=False)
+    base_app.runcmds_plus_hooks(['help', 'keyboard_interrupt', 'shortcuts'], stop_on_keyboard_interrupt=True)
     out, err = capsys.readouterr()
-    assert not err
-    assert len(base_app.history) == 3
+    assert err.startswith("Interrupting this command")
+    assert len(base_app.history) == 2
 
 
 def test_relative_run_script(base_app, request):