Move completion exception handling back to Cmd.complete().

Author: kmvanbrunt

cmd2/cmd2.py

@@ -1488,7 +1488,7 @@ def format_exception(self, exception: BaseException) -> str:
                     )
                     final_msg.append(help_msg)
 
-                console.print(final_msg)
+                console.print(final_msg, end="")
 
         return capture.get()
 
@@ -1506,7 +1506,7 @@ def pexcept(
                        method and still call `super()` without encountering unexpected keyword argument errors.
         """
         formatted_exception = self.format_exception(exception)
-        self.print_to(sys.stderr, formatted_exception)
+        self.print_to(sys.stderr, formatted_exception + "\n")
 
     def pfeedback(
         self,
@@ -2437,82 +2437,99 @@ def complete(
         :param endidx: ending index of text
         :param custom_settings: used when not completing the main command line
         :return: a Completions object
-        :raises CompletionError: if a completion-related exception occurs
-        :raises Exception: for any unhandled underlying processing errors
         """
-        # Check if we are completing a multiline command
-        if self._at_continuation_prompt:
-            # lstrip and prepend the previously typed portion of this multiline command
-            lstripped_previous = self._multiline_in_progress.lstrip()
-            line = lstripped_previous + line
-
-            # Increment the indexes to account for the prepended text
-            begidx = len(lstripped_previous) + begidx
-            endidx = len(lstripped_previous) + endidx
-        else:
-            # lstrip the original line
-            orig_line = line
-            line = orig_line.lstrip()
-            num_stripped = len(orig_line) - len(line)
-
-            # Calculate new indexes for the stripped line. If the cursor is at a position before the end of a
-            # line of spaces, then the following math could result in negative indexes. Enforce a max of 0.
-            begidx = max(begidx - num_stripped, 0)
-            endidx = max(endidx - num_stripped, 0)
-
-        # Shortcuts are not word break characters when completing. Therefore, shortcuts become part
-        # of the text variable if there isn't a word break, like a space, after it. We need to remove it
-        # from text and update the indexes. This only applies if we are at the beginning of the command line.
-        shortcut_to_restore = ''
-        if begidx == 0 and custom_settings is None:
-            for shortcut, _ in self.statement_parser.shortcuts:
-                if text.startswith(shortcut):
-                    # Save the shortcut to restore later
-                    shortcut_to_restore = shortcut
-
-                    # Adjust text and where it begins
-                    text = text[len(shortcut_to_restore) :]
-                    begidx += len(shortcut_to_restore)
-                    break
+        try:
+            # Check if we are completing a multiline command
+            if self._at_continuation_prompt:
+                # lstrip and prepend the previously typed portion of this multiline command
+                lstripped_previous = self._multiline_in_progress.lstrip()
+                line = lstripped_previous + line
+
+                # Increment the indexes to account for the prepended text
+                begidx = len(lstripped_previous) + begidx
+                endidx = len(lstripped_previous) + endidx
             else:
-                # No shortcut was found. Complete the command token.
-                parser = argparse_custom.DEFAULT_ARGUMENT_PARSER(add_help=False)
-                parser.add_argument(
-                    'command',
-                    metavar="COMMAND",
-                    help="command, alias, or macro name",
-                    choices=self._get_commands_aliases_and_macros_choices(),
-                )
-                custom_settings = utils.CustomCompletionSettings(parser)
+                # lstrip the original line
+                orig_line = line
+                line = orig_line.lstrip()
+                num_stripped = len(orig_line) - len(line)
+
+                # Calculate new indexes for the stripped line. If the cursor is at a position before the end of a
+                # line of spaces, then the following math could result in negative indexes. Enforce a max of 0.
+                begidx = max(begidx - num_stripped, 0)
+                endidx = max(endidx - num_stripped, 0)
+
+            # Shortcuts are not word break characters when completing. Therefore, shortcuts become part
+            # of the text variable if there isn't a word break, like a space, after it. We need to remove it
+            # from text and update the indexes. This only applies if we are at the beginning of the command line.
+            shortcut_to_restore = ''
+            if begidx == 0 and custom_settings is None:
+                for shortcut, _ in self.statement_parser.shortcuts:
+                    if text.startswith(shortcut):
+                        # Save the shortcut to restore later
+                        shortcut_to_restore = shortcut
+
+                        # Adjust text and where it begins
+                        text = text[len(shortcut_to_restore) :]
+                        begidx += len(shortcut_to_restore)
+                        break
+                else:
+                    # No shortcut was found. Complete the command token.
+                    parser = argparse_custom.DEFAULT_ARGUMENT_PARSER(add_help=False)
+                    parser.add_argument(
+                        'command',
+                        metavar="COMMAND",
+                        help="command, alias, or macro name",
+                        choices=self._get_commands_aliases_and_macros_choices(),
+                    )
+                    custom_settings = utils.CustomCompletionSettings(parser)
 
-        completions = self._perform_completion(text, line, begidx, endidx, custom_settings)
+            completions = self._perform_completion(text, line, begidx, endidx, custom_settings)
 
-        # Check if we need to restore a shortcut in the completion text
-        # so it doesn't get erased from the command line.
-        if completions and shortcut_to_restore:
-            new_items = [
-                dataclasses.replace(
-                    item,
-                    text=shortcut_to_restore + item.text,
+            # Check if we need to restore a shortcut in the completion text
+            # so it doesn't get erased from the command line.
+            if completions and shortcut_to_restore:
+                new_items = [
+                    dataclasses.replace(
+                        item,
+                        text=shortcut_to_restore + item.text,
+                    )
+                    for item in completions
+                ]
+
+                # Update items and set _quote_from_offset so that any auto-inserted
+                # opening quote is placed after the shortcut.
+                completions = dataclasses.replace(
+                    completions,
+                    items=new_items,
+                    _search_text_offset=len(shortcut_to_restore),
                 )
-                for item in completions
-            ]
 
-            # Update items and set _quote_from_offset so that any auto-inserted
-            # opening quote is placed after the shortcut.
-            completions = dataclasses.replace(
-                completions,
-                items=new_items,
-                _search_text_offset=len(shortcut_to_restore),
-            )
+            # Swap between COLUMN and MULTI_COLUMN style based on the number of matches.
+            if len(completions) > self.max_column_completion_results:
+                self.session.complete_style = CompleteStyle.MULTI_COLUMN
+            else:
+                self.session.complete_style = CompleteStyle.COLUMN
 
-        # Swap between COLUMN and MULTI_COLUMN style based on the number of matches.
-        if len(completions) > self.max_column_completion_results:
-            self.session.complete_style = CompleteStyle.MULTI_COLUMN
-        else:
-            self.session.complete_style = CompleteStyle.COLUMN
+            return completions  # noqa: TRY300
+
+        except CompletionError as ex:
+            err_str = str(ex)
+            completion_error = ""
 
-        return completions
+            # Don't display anything if the error is blank (e.g. _NoResultsError for an argument which supresses hints)
+            if err_str:
+                console = ru.Cmd2GeneralConsole()
+                with console.capture() as capture:
+                    console.print(
+                        Text(err_str, style=Cmd2Style.ERROR if ex.apply_style else ""),
+                        end="",
+                    )
+                completion_error = capture.get()
+            return Completions(completion_error=completion_error)
+        except Exception as ex:  # noqa: BLE001
+            formatted_exception = self.format_exception(ex)
+            return Completions(completion_error=formatted_exception)
 
     def in_script(self) -> bool:
         """Return whether a text script is running."""

cmd2/completion.py

@@ -207,6 +207,9 @@ class Completions(CompletionResultsBase):
     # An optional hint which prints above completion suggestions
     completion_hint: str = ""
 
+    # Optional message to display if an error occurs during completion
+    completion_error: str = ""
+
     # An optional table string populated by the argparse completer
     completion_table: str = ""
 

cmd2/pt_utils.py

@@ -16,15 +16,11 @@
 from prompt_toolkit.formatted_text import ANSI
 from prompt_toolkit.history import History
 from prompt_toolkit.lexers import Lexer
-from rich.text import Text
 
 from . import (
     constants,
     utils,
 )
-from . import rich_utils as ru
-from .exceptions import CompletionError
-from .styles import Cmd2Style
 
 if TYPE_CHECKING:
     from .cmd2 import Cmd
@@ -62,23 +58,12 @@ def get_completions(self, document: Document, _complete_event: object) -> Iterab
         endidx = cursor_pos
         text = line[begidx:endidx]
 
-        try:
-            completions = self.cmd_app.complete(
-                text, line=line, begidx=begidx, endidx=endidx, custom_settings=self.custom_settings
-            )
-        except CompletionError as ex:
-            # Don't print unless error has length
-            err_str = str(ex)
-            if err_str:
-                general_console = ru.Cmd2GeneralConsole()
-                with general_console.capture() as capture:
-                    styled_err = Text(err_str, style=Cmd2Style.ERROR if ex.apply_style else "")
-                    general_console.print(styled_err, end="")
-                print_formatted_text(ANSI(capture.get()))
-            return
-        except Exception as ex:  # noqa: BLE001
-            formatted_exception = self.cmd_app.format_exception(ex)
-            print_formatted_text(ANSI(formatted_exception))
+        completions = self.cmd_app.complete(
+            text, line=line, begidx=begidx, endidx=endidx, custom_settings=self.custom_settings
+        )
+
+        if completions.completion_error:
+            print_formatted_text(ANSI(completions.completion_error + "\n"))
             return
 
         # Print completion table if present