Changed Statement.multiline_command field from a string to a bool.

Author: kmvanbrunt

CHANGELOG.md

@@ -33,13 +33,14 @@ shell, and the option for a persistent bottom bar that can display realtime stat
     - `CompletionItem.descriptive_data` is now called `CompletionItem.table_row`.
     - `Cmd.default_sort_key` moved to `utils.DEFAULT_STR_SORT_KEY`.
     - Moved completion state data, which previously resided in `Cmd`, into other classes.
-        1. `Cmd.matches_sorted` -> `Completions.is_sorted` and `Choices.is_sorted`
-        1. `Cmd.completion_hint` -> `Completions.completion_hint`
-        1. `Cmd.formatted_completions` -> `Completions.completion_table`
-        1. `Cmd.matches_delimited` -> `Completions.is_delimited`
-        1. `Cmd.allow_appended_space/allow_closing_quote` -> `Completions.allow_finalization`
+        - `Cmd.matches_sorted` -> `Completions.is_sorted` and `Choices.is_sorted`
+        - `Cmd.completion_hint` -> `Completions.completion_hint`
+        - `Cmd.formatted_completions` -> `Completions.completion_table`
+        - `Cmd.matches_delimited` -> `Completions.is_delimited`
+        - `Cmd.allow_appended_space/allow_closing_quote` -> `Completions.allow_finalization`
     - Removed `flag_based_complete` and `index_based_complete` functions since their functionality
       is already provided in arpgarse-based completion.
+    - Changed `Statement.multiline_command` field from a string to a bool.
 - Enhancements
     - New `cmd2.Cmd` parameters
         - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These

cmd2/cmd2.py

@@ -2907,8 +2907,7 @@ def _input_line_to_statement(self, line: str) -> Statement:
             # Make sure all input has been read and convert it to a Statement
             statement = self._complete_statement(line)
 
-            # If this is the first loop iteration, save the original line and stop
-            # combining multiline history entries in the remaining iterations.
+            # If this is the first loop iteration, save the original line
             if orig_line is None:
                 orig_line = statement.raw
 

cmd2/parsing.py

@@ -129,8 +129,8 @@ class Statement(str):  # noqa: SLOT000
     # list of arguments to the command, not including any output redirection or terminators; quoted args remain quoted
     arg_list: list[str] = field(default_factory=list)
 
-    # if the command is a multiline command, the name of the command, otherwise empty
-    multiline_command: str = ''
+    # if the command is a multiline command
+    multiline_command: bool = False
 
     # the character which terminated the multiline command, if there was one
     terminator: str = ''
@@ -510,7 +510,7 @@ def parse(self, line: str) -> Statement:
                 arg_list = tokens[1:]
 
         # set multiline
-        multiline_command = command if command in self.multiline_commands else ''
+        multiline_command = command in self.multiline_commands
 
         # build the statement
         return Statement(
@@ -580,7 +580,7 @@ def parse_command_only(self, rawinput: str) -> Statement:
                 args = ''
 
         # set multiline
-        multiline_command = command if command in self.multiline_commands else ''
+        multiline_command = command in self.multiline_commands
 
         # build the statement
         return Statement(args, raw=rawinput, command=command, multiline_command=multiline_command)

tests/test_cmd2.py

@@ -1767,7 +1767,7 @@ def test_multiline_complete_statement_without_terminator(multiline_app, monkeypa
     statement = multiline_app._complete_statement(line)
     assert statement == args
     assert statement.command == command
-    assert statement.multiline_command == command
+    assert statement.multiline_command
 
 
 def test_multiline_complete_statement_with_unclosed_quotes(multiline_app, monkeypatch) -> None:
@@ -1780,7 +1780,7 @@ def test_multiline_complete_statement_with_unclosed_quotes(multiline_app, monkey
     statement = multiline_app._complete_statement(line)
     assert statement == 'hi "partially open\nquotes\n" now closed'
     assert statement.command == 'orate'
-    assert statement.multiline_command == 'orate'
+    assert statement.multiline_command
     assert statement.terminator == ';'
 
 
@@ -1797,7 +1797,7 @@ def test_multiline_input_line_to_statement(multiline_app, monkeypatch) -> None:
     assert statement.raw == 'orate hi\nperson\n\n'
     assert statement == 'hi person'
     assert statement.command == 'orate'
-    assert statement.multiline_command == 'orate'
+    assert statement.multiline_command
 
 
 def test_multiline_history_added(multiline_app, monkeypatch) -> None:

tests/test_history.py

@@ -85,7 +85,7 @@ def hist():
     '        "raw": "first",\n'
     '        "command": "",\n'
     '        "arg_list": [],\n'
-    '        "multiline_command": "",\n'
+    '        "multiline_command": false,\n'
     '        "terminator": "",\n'
     '        "suffix": "",\n'
     '        "pipe_to": "",\n'
@@ -99,7 +99,7 @@ def hist():
     '        "raw": "second",\n'
     '        "command": "",\n'
     '        "arg_list": [],\n'
-    '        "multiline_command": "",\n'
+    '        "multiline_command": false,\n'
     '        "terminator": "",\n'
     '        "suffix": "",\n'
     '        "pipe_to": "",\n'
@@ -113,7 +113,7 @@ def hist():
     '        "raw": "third",\n'
     '        "command": "",\n'
     '        "arg_list": [],\n'
-    '        "multiline_command": "",\n'
+    '        "multiline_command": false,\n'
     '        "terminator": "",\n'
     '        "suffix": "",\n'
     '        "pipe_to": "",\n'
@@ -127,7 +127,7 @@ def hist():
     '        "raw": "fourth",\n'
     '        "command": "",\n'
     '        "arg_list": [],\n'
-    '        "multiline_command": "",\n'
+    '        "multiline_command": false,\n'
     '        "terminator": "",\n'
     '        "suffix": "",\n'
     '        "pipe_to": "",\n'

tests/test_parsing.py

@@ -46,7 +46,7 @@ def test_parse_empty_string(parser) -> None:
     assert statement.raw == line
     assert statement.command == ''
     assert statement.arg_list == []
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -64,7 +64,7 @@ def test_parse_empty_string_default(default_parser) -> None:
     assert statement.raw == line
     assert statement.command == ''
     assert statement.arg_list == []
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -144,7 +144,7 @@ def test_parse_single_word(parser, line) -> None:
     assert not statement.arg_list
     assert statement.args == statement
     assert statement.raw == line
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -527,7 +527,7 @@ def test_parse_redirect_inside_terminator(parser) -> None:
 )
 def test_parse_multiple_terminators(parser, line, terminator) -> None:
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement == 'with | inside'
     assert statement.args == statement
     assert statement.argv == ['multiline', 'with', '|', 'inside']
@@ -538,7 +538,7 @@ def test_parse_multiple_terminators(parser, line, terminator) -> None:
 def test_parse_unfinished_multiliine_command(parser) -> None:
     line = 'multiline has > inside an unfinished command'
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement == 'has > inside an unfinished command'
     assert statement.args == statement
@@ -550,7 +550,7 @@ def test_parse_unfinished_multiliine_command(parser) -> None:
 def test_parse_basic_multiline_command(parser) -> None:
     line = 'multiline foo\nbar\n\n'
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement == 'foo bar'
     assert statement.args == statement
@@ -572,7 +572,7 @@ def test_parse_basic_multiline_command(parser) -> None:
 )
 def test_parse_multiline_command_ignores_redirectors_within_it(parser, line, terminator) -> None:
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement == 'has > inside'
     assert statement.args == statement
     assert statement.argv == ['multiline', 'has', '>', 'inside']
@@ -583,7 +583,7 @@ def test_parse_multiline_command_ignores_redirectors_within_it(parser, line, ter
 def test_parse_multiline_terminated_by_empty_line(parser) -> None:
     line = 'multiline command ends\n\n'
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement == 'command ends'
     assert statement.args == statement
@@ -605,7 +605,7 @@ def test_parse_multiline_terminated_by_empty_line(parser) -> None:
 )
 def test_parse_multiline_with_embedded_newline(parser, line, terminator) -> None:
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement == 'command "with\nembedded newline"'
     assert statement.args == statement
@@ -617,7 +617,7 @@ def test_parse_multiline_with_embedded_newline(parser, line, terminator) -> None
 def test_parse_multiline_ignores_terminators_in_quotes(parser) -> None:
     line = 'multiline command "with term; ends" now\n\n'
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement == 'command "with term; ends" now'
     assert statement.args == statement
@@ -694,7 +694,7 @@ def test_parse_alias_and_shortcut_expansion(parser, line, command, args) -> None
 def test_parse_alias_on_multiline_command(parser) -> None:
     line = 'anothermultiline has > inside an unfinished command'
     statement = parser.parse(line)
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement.command == 'multiline'
     assert statement.args == statement
     assert statement == 'has > inside an unfinished command'
@@ -761,7 +761,7 @@ def test_parse_command_only_command_and_args(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'help'
     assert statement.command_and_args == line
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
     assert statement.terminator == ''
     assert statement.suffix == ''
@@ -778,7 +778,7 @@ def test_parse_command_only_strips_line(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'help'
     assert statement.command_and_args == line.strip()
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
     assert statement.terminator == ''
     assert statement.suffix == ''
@@ -795,7 +795,7 @@ def test_parse_command_only_expands_alias(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'run_pyscript'
     assert statement.command_and_args == 'run_pyscript foobar.py "somebody.py'
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
     assert statement.terminator == ''
     assert statement.suffix == ''
@@ -812,9 +812,8 @@ def test_parse_command_only_expands_shortcuts(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'shell'
     assert statement.command_and_args == 'shell cat foobar.txt'
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
-    assert statement.multiline_command == ''
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -830,9 +829,8 @@ def test_parse_command_only_quoted_args(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'shell'
     assert statement.command_and_args == line.replace('l', 'shell ls -al')
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
-    assert statement.multiline_command == ''
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -849,9 +847,8 @@ def test_parse_command_only_unclosed_quote(parser) -> None:
     assert statement.arg_list == []
     assert statement.command == 'command'
     assert statement.command_and_args == line
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
-    assert statement.multiline_command == ''
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -877,9 +874,8 @@ def test_parse_command_only_specialchars(parser, line, args) -> None:
     assert statement == args
     assert statement.args == args
     assert statement.command == 'help'
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
-    assert statement.multiline_command == ''
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -910,9 +906,8 @@ def test_parse_command_only_empty(parser, line) -> None:
     assert statement.arg_list == []
     assert statement.command == ''
     assert statement.command_and_args == ''
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.raw == line
-    assert statement.multiline_command == ''
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert statement.pipe_to == ''
@@ -924,7 +919,7 @@ def test_parse_command_only_multiline(parser) -> None:
     line = 'multiline with partially "open quotes and no terminator'
     statement = parser.parse_command_only(line)
     assert statement.command == 'multiline'
-    assert statement.multiline_command == 'multiline'
+    assert statement.multiline_command
     assert statement == 'with partially "open quotes and no terminator'
     assert statement.command_and_args == line
     assert statement.args == statement
@@ -941,7 +936,7 @@ def test_statement_initialization() -> None:
     assert not statement.arg_list
     assert isinstance(statement.argv, list)
     assert not statement.argv
-    assert statement.multiline_command == ''
+    assert not statement.multiline_command
     assert statement.terminator == ''
     assert statement.suffix == ''
     assert isinstance(statement.pipe_to, str)