Addressing more code review comments.

Author: kmvanbrunt

cmd2/argparse_custom.py

@@ -294,10 +294,8 @@ def get_items(self) -> list[CompletionItems]:
     RichHelpFormatter,
 )
 
-from . import (
-    constants,
-    rich_utils,
-)
+from . import constants
+from . import rich_utils as ru
 from .styles import Cmd2Style
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -1115,12 +1113,12 @@ def __init__(
         max_help_position: int = 24,
         width: int | None = None,
         *,
-        console: rich_utils.Cmd2Console | None = None,
+        console: ru.Cmd2Console | None = None,
         **kwargs: Any,
     ) -> None:
         """Initialize Cmd2HelpFormatter."""
         if console is None:
-            console = rich_utils.Cmd2Console()
+            console = ru.Cmd2Console()
 
         super().__init__(prog, indent_increment, max_help_position, width, console=console, **kwargs)
 

cmd2/cmd2.py

@@ -78,10 +78,10 @@
     argparse_custom,
     constants,
     plugin,
-    rich_utils,
-    string_utils,
     utils,
 )
+from . import rich_utils as ru
+from . import string_utils as su
 from .argparse_custom import (
     ChoicesProviderFunc,
     Cmd2ArgumentParser,
@@ -133,14 +133,6 @@
     Cmd2Console,
     RichPrintKwargs,
 )
-from .string_utils import (
-    align_center,
-    align_left,
-    quote,
-    str_width,
-    strip_quotes,
-    strip_style,
-)
 from .styles import Cmd2Style
 
 # NOTE: When using gnureadline with Python 3.13, start_ipython needs to be imported before any readline-related stuff
@@ -304,7 +296,7 @@ class Cmd(cmd.Cmd):
     DEFAULT_EDITOR = utils.find_editor()
 
     # Sorting keys for strings
-    ALPHABETICAL_SORT_KEY = string_utils.norm_fold
+    ALPHABETICAL_SORT_KEY = su.norm_fold
     NATURAL_SORT_KEY = utils.natural_keys
 
     # List for storing transcript test file names
@@ -508,7 +500,7 @@ def __init__(
         if startup_script:
             startup_script = os.path.abspath(os.path.expanduser(startup_script))
             if os.path.exists(startup_script):
-                script_cmd = f"run_script {quote(startup_script)}"
+                script_cmd = f"run_script {su.quote(startup_script)}"
                 if silence_startup_script:
                     script_cmd += f" {constants.REDIRECTION_OUTPUT} {os.devnull}"
                 self._startup_commands.append(script_cmd)
@@ -1139,24 +1131,23 @@ def build_settables(self) -> None:
 
         def get_allow_style_choices(_cli_self: Cmd) -> list[str]:
             """Tab complete allow_style values."""
-            return [val.name.lower() for val in rich_utils.AllowStyle]
+            return [val.name.lower() for val in ru.AllowStyle]
 
-        def allow_style_type(value: str) -> rich_utils.AllowStyle:
-            """Convert a string value into an rich_utils.AllowStyle."""
+        def allow_style_type(value: str) -> ru.AllowStyle:
+            """Convert a string value into an ru.AllowStyle."""
             try:
-                return rich_utils.AllowStyle[value.upper()]
+                return ru.AllowStyle[value.upper()]
             except KeyError as ex:
                 raise ValueError(
-                    f"must be {rich_utils.AllowStyle.ALWAYS}, {rich_utils.AllowStyle.NEVER}, or "
-                    f"{rich_utils.AllowStyle.TERMINAL} (case-insensitive)"
+                    f"must be {ru.AllowStyle.ALWAYS}, {ru.AllowStyle.NEVER}, or {ru.AllowStyle.TERMINAL} (case-insensitive)"
                 ) from ex
 
         self.add_settable(
             Settable(
                 'allow_style',
                 allow_style_type,
                 'Allow ANSI text style sequences in output (valid values: '
-                f'{rich_utils.AllowStyle.ALWAYS}, {rich_utils.AllowStyle.NEVER}, {rich_utils.AllowStyle.TERMINAL})',
+                f'{ru.AllowStyle.ALWAYS}, {ru.AllowStyle.NEVER}, {ru.AllowStyle.TERMINAL})',
                 self,
                 choices_provider=cast(ChoicesProviderFunc, get_allow_style_choices),
             )
@@ -1179,14 +1170,14 @@ def allow_style_type(value: str) -> rich_utils.AllowStyle:
     # -----  Methods related to presenting output to the user -----
 
     @property
-    def allow_style(self) -> rich_utils.AllowStyle:
+    def allow_style(self) -> ru.AllowStyle:
         """Read-only property needed to support do_set when it reads allow_style."""
-        return rich_utils.allow_style
+        return ru.allow_style
 
     @allow_style.setter
-    def allow_style(self, new_val: rich_utils.AllowStyle) -> None:
+    def allow_style(self, new_val: ru.AllowStyle) -> None:
         """Setter property needed to support do_set when it updates allow_style."""
-        rich_utils.allow_style = new_val
+        ru.allow_style = new_val
 
     def _completion_supported(self) -> bool:
         """Return whether tab completion is supported."""
@@ -1201,7 +1192,7 @@ def visible_prompt(self) -> str:
 
         :return: prompt stripped of any ANSI escape codes
         """
-        return strip_style(self.prompt)
+        return su.strip_style(self.prompt)
 
     def print_to(
         self,
@@ -1231,7 +1222,7 @@ def print_to(
                        method and still call `super()` without encountering unexpected keyword argument errors.
                        These arguments are not passed to Rich's Console.print().
         """
-        prepared_objects = rich_utils.prepare_objects_for_rich_print(*objects)
+        prepared_objects = ru.prepare_objects_for_rich_print(*objects)
 
         try:
             Cmd2Console(file).print(
@@ -1522,7 +1513,7 @@ def ppaged(
 
         # Check if we are outputting to a pager.
         if functional_terminal and can_block:
-            prepared_objects = rich_utils.prepare_objects_for_rich_print(*objects)
+            prepared_objects = ru.prepare_objects_for_rich_print(*objects)
 
             # Chopping overrides soft_wrap
             if chop:
@@ -1639,7 +1630,7 @@ def tokens_for_completion(self, line: str, begidx: int, endidx: int) -> tuple[li
         raw_tokens = self.statement_parser.split_on_punctuation(initial_tokens)
 
         # Save the unquoted tokens
-        tokens = [strip_quotes(cur_token) for cur_token in raw_tokens]
+        tokens = [su.strip_quotes(cur_token) for cur_token in raw_tokens]
 
         # If the token being completed had an unclosed quote, we need
         # to remove the closing quote that was added in order for it
@@ -2141,7 +2132,7 @@ def _display_matches_gnu_readline(
                     longest_match_length = 0
 
                     for cur_match in matches_to_display:
-                        cur_length = str_width(cur_match)
+                        cur_length = su.str_width(cur_match)
                         longest_match_length = max(longest_match_length, cur_length)
                 else:
                     matches_to_display = matches
@@ -3133,7 +3124,7 @@ def _redirect_output(self, statement: Statement) -> utils.RedirectionSavedState:
                 mode = 'a' if statement.output == constants.REDIRECTION_APPEND else 'w'
                 try:
                     # Use line buffering
-                    new_stdout = cast(TextIO, open(strip_quotes(statement.output_to), mode=mode, buffering=1))  # noqa: SIM115
+                    new_stdout = cast(TextIO, open(su.strip_quotes(statement.output_to), mode=mode, buffering=1))  # noqa: SIM115
                 except OSError as ex:
                     raise RedirectionError('Failed to redirect output') from ex
 
@@ -4163,7 +4154,7 @@ def columnize(self, str_list: list[str] | None, display_width: int = 80) -> None
                     if i >= size:
                         break
                     x = str_list[i]
-                    colwidth = max(colwidth, str_width(x))
+                    colwidth = max(colwidth, su.str_width(x))
                 colwidths.append(colwidth)
                 totwidth += colwidth + 2
                 if totwidth > display_width:
@@ -4184,7 +4175,7 @@ def columnize(self, str_list: list[str] | None, display_width: int = 80) -> None
             while texts and not texts[-1]:
                 del texts[-1]
             for col in range(len(texts)):
-                texts[col] = align_left(texts[col], width=colwidths[col])
+                texts[col] = su.align_left(texts[col], width=colwidths[col])
             self.poutput("  ".join(texts))
 
     def _help_menu(self, verbose: bool = False) -> None:
@@ -4480,7 +4471,7 @@ def do_set(self, args: argparse.Namespace) -> None:
                 # Try to update the settable's value
                 try:
                     orig_value = settable.get_value()
-                    settable.set_value(strip_quotes(args.value))
+                    settable.set_value(su.strip_quotes(args.value))
                 except ValueError as ex:
                     self.perror(f"Error setting {args.param}: {ex}")
                 else:
@@ -5076,7 +5067,7 @@ def do_history(self, args: argparse.Namespace) -> bool | None:
                 self.run_editor(fname)
 
                 # self.last_result will be set by do_run_script()
-                return self.do_run_script(quote(fname))
+                return self.do_run_script(su.quote(fname))
             finally:
                 os.remove(fname)
         elif args.output_file:
@@ -5371,9 +5362,9 @@ def run_editor(self, file_path: str | None = None) -> None:
         if not self.editor:
             raise OSError("Please use 'set editor' to specify your text editing program of choice.")
 
-        command = quote(os.path.expanduser(self.editor))
+        command = su.quote(os.path.expanduser(self.editor))
         if file_path:
-            command += " " + quote(os.path.expanduser(file_path))
+            command += " " + su.quote(os.path.expanduser(file_path))
 
         self.do_shell(command)
 
@@ -5511,7 +5502,7 @@ def do__relative_run_script(self, args: argparse.Namespace) -> bool | None:
         relative_path = os.path.join(self._current_script_dir or '', script_path)
 
         # self.last_result will be set by do_run_script()
-        return self.do_run_script(quote(relative_path))
+        return self.do_run_script(su.quote(relative_path))
 
     def _run_transcript_tests(self, transcript_paths: list[str]) -> None:
         """Run transcript tests for provided file(s).
@@ -5543,7 +5534,7 @@ class TestMyAppCase(Cmd2TestCase):
         verinfo = ".".join(map(str, sys.version_info[:3]))
         num_transcripts = len(transcripts_expanded)
         plural = '' if len(transcripts_expanded) == 1 else 's'
-        self.poutput(align_center(' cmd2 transcript test ', character=self.ruler), style=Style(bold=True))
+        self.poutput(su.align_center(' cmd2 transcript test ', character=self.ruler), style=Style(bold=True))
         self.poutput(f'platform {sys.platform} -- Python {verinfo}, cmd2-{cmd2.__version__}, readline-{rl_type}')
         self.poutput(f'cwd: {os.getcwd()}')
         self.poutput(f'cmd2 app: {sys.argv[0]}')
@@ -5560,7 +5551,7 @@ class TestMyAppCase(Cmd2TestCase):
         if test_results.wasSuccessful():
             self.perror(stream.read(), end="", style=None)
             finish_msg = f' {num_transcripts} transcript{plural} passed in {execution_time:.3f} seconds '
-            finish_msg = align_center(finish_msg, character=self.ruler)
+            finish_msg = su.align_center(finish_msg, character=self.ruler)
             self.psuccess(finish_msg)
         else:
             # Strip off the initial traceback which isn't particularly useful for end users
@@ -5624,7 +5615,7 @@ def async_alert(self, alert_msg: str, new_prompt: str | None = None) -> None:  #
 
                 # Print a string which replaces the onscreen prompt and input lines with the alert.
                 terminal_str = async_alert_str(
-                    terminal_columns=rich_utils.console_width(),
+                    terminal_columns=ru.console_width(),
                     prompt=rl_get_display_prompt(),
                     line=readline.get_line_buffer(),
                     cursor_offset=rl_get_point(),

cmd2/history.py

@@ -14,7 +14,7 @@
     overload,
 )
 
-from . import string_utils
+from . import string_utils as su
 from .parsing import (
     Statement,
     shlex_split,
@@ -285,9 +285,9 @@ def str_search(self, search: str, include_persisted: bool = False) -> 'OrderedDi
 
         def isin(history_item: HistoryItem) -> bool:
             """Filter function for string search of history."""
-            sloppy = string_utils.norm_fold(search)
-            inraw = sloppy in string_utils.norm_fold(history_item.raw)
-            inexpanded = sloppy in string_utils.norm_fold(history_item.expanded)
+            sloppy = su.norm_fold(search)
+            inraw = sloppy in su.norm_fold(history_item.raw)
+            inexpanded = sloppy in su.norm_fold(history_item.expanded)
             return inraw or inexpanded
 
         start = 0 if include_persisted else self.session_start_index

cmd2/parsing.py

@@ -7,18 +7,14 @@
     dataclass,
     field,
 )
-from typing import (
-    Any,
-)
+from typing import Any
 
 from . import (
     constants,
-    string_utils,
     utils,
 )
-from .exceptions import (
-    Cmd2ShlexError,
-)
+from . import string_utils as su
+from .exceptions import Cmd2ShlexError
 
 
 def shlex_split(str_to_split: str) -> list[str]:
@@ -212,8 +208,8 @@ def argv(self) -> list[str]:
         If you want to strip quotes from the input, you can use ``argv[1:]``.
         """
         if self.command:
-            rtn = [string_utils.strip_quotes(self.command)]
-            rtn.extend(string_utils.strip_quotes(cur_token) for cur_token in self.arg_list)
+            rtn = [su.strip_quotes(self.command)]
+            rtn.extend(su.strip_quotes(cur_token) for cur_token in self.arg_list)
         else:
             rtn = []
 
@@ -489,7 +485,7 @@ def parse(self, line: str) -> Statement:
 
             # Check if we are redirecting to a file
             if len(tokens) > output_index + 1:
-                unquoted_path = string_utils.strip_quotes(tokens[output_index + 1])
+                unquoted_path = su.strip_quotes(tokens[output_index + 1])
                 if unquoted_path:
                     output_to = utils.expand_user(tokens[output_index + 1])