Removed cmd2.Cmd.quit_on_sigint.

Author: kmvanbrunt

CHANGELOG.md

@@ -30,6 +30,7 @@
       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.
+    * Removed `cmd2.Cmd.quit_on_sigint` flag, which when `True`, quit the application when Ctrl-C was pressed at the prompt.
 * 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

@@ -293,7 +293,6 @@ def __init__(
 
         # Attributes which should NOT be dynamically settable via the set command at runtime
         self.default_to_shell = False  # Attempt to run unrecognized commands as shell commands
-        self.quit_on_sigint = False  # Ctrl-C at the prompt will quit the program instead of just resetting prompt
         self.allow_redirection = allow_redirection  # Security setting to prevent redirection of stdout
 
         # Attributes which ARE dynamically settable via the set command at runtime
@@ -2490,13 +2489,10 @@ def _complete_statement(self, line: str) -> Statement:
                     nextline = '\n'
                     self.poutput(nextline)
                 line = f'{self._multiline_in_progress}{nextline}'
-            except KeyboardInterrupt as ex:
-                if self.quit_on_sigint:
-                    raise ex
-                else:
-                    self.poutput('^C')
-                    statement = self.statement_parser.parse('')
-                    break
+            except KeyboardInterrupt:
+                self.poutput('^C')
+                statement = self.statement_parser.parse('')
+                break
             finally:
                 self._at_continuation_prompt = False
 
@@ -3067,12 +3063,9 @@ def _cmdloop(self) -> None:
                 # Get commands from user
                 try:
                     line = self._read_command_line(self.prompt)
-                except KeyboardInterrupt as ex:
-                    if self.quit_on_sigint:
-                        raise ex
-                    else:
-                        self.poutput('^C')
-                        line = ''
+                except KeyboardInterrupt:
+                    self.poutput('^C')
+                    line = ''
 
                 # Run the command along with all associated pre and post hooks
                 stop = self.onecmd_plus_hooks(line)

docs/features/initialization.rst

@@ -146,8 +146,6 @@ override:
   everything available with **self_in_py**)
 - **quiet**: if ``True`` then completely suppress nonessential output (Default:
   ``False``)
-- **quit_on_sigint**: if ``True`` Ctrl-C at the prompt will quit the program
-  instead of just resetting prompt
 - **settable**: dictionary that controls which of these instance attributes
   are settable at runtime using the *set* command
 - **timing**: if ``True`` display execution time for each command (Default:

docs/features/misc.rst

@@ -99,21 +99,3 @@ method be called.
   (Cmd) my dog has fleas
   sh: my: not found
   *** Unknown syntax: my dog has fleas
-
-
-Quit on SIGINT
---------------
-
-On many shells, SIGINT (most often triggered by the user pressing Ctrl+C)
-while at the prompt only cancels the current line, not the entire command
-loop. By default, a ``cmd2`` application matches this behavior. However, if
-``quit_on_sigint`` is set to ``True``, the command loop will quit instead.
-
-::
-
-  (Cmd) typing a comma^C
-  (Cmd)
-
-.. warning::
-    The default SIGINT behavior will only function properly if **cmdloop** is running
-    in the main thread.

tests/test_cmd2.py

@@ -962,36 +962,13 @@ def say_app():
     return app
 
 
-def test_interrupt_quit(say_app):
-    say_app.quit_on_sigint = True
-
-    # Mock out the input call so we don't actually wait for a user's response on stdin
-    m = mock.MagicMock(name='input')
-    m.side_effect = ['say hello', KeyboardInterrupt(), 'say goodbye', 'eof']
-    builtins.input = m
-
-    try:
-        say_app.cmdloop()
-    except KeyboardInterrupt:
-        pass
-
-    # And verify the expected output to stdout
-    out = say_app.stdout.getvalue()
-    assert out == 'hello\n'
-
-
-def test_interrupt_noquit(say_app):
-    say_app.quit_on_sigint = False
-
+def test_ctrl_c_at_prompt(say_app):
     # Mock out the input call so we don't actually wait for a user's response on stdin
     m = mock.MagicMock(name='input')
     m.side_effect = ['say hello', KeyboardInterrupt(), 'say goodbye', 'eof']
     builtins.input = m
 
-    try:
-        say_app.cmdloop()
-    except KeyboardInterrupt:
-        pass
+    say_app.cmdloop()
 
     # And verify the expected output to stdout
     out = say_app.stdout.getvalue()