Enable ruff TC type checking ruleset and accept automated refactorings

Author: tleonhardt

cmd2/ansi.py

@@ -106,7 +106,7 @@ def style_aware_wcswidth(text: str) -> int:
              then this function returns -1. Replace tabs with spaces before calling this.
     """
     # Strip ANSI style sequences since they cause wcswidth to return -1
-    return cast(int, wcswidth(strip_style(text)))
+    return cast('int', wcswidth(strip_style(text)))
 
 
 def widest_line(text: str) -> int:

cmd2/argparse_custom.py

@@ -455,7 +455,7 @@ def _action_get_choices_callable(self: argparse.Action) -> Optional[ChoicesCalla
     :param self: argparse Action being queried
     :return: A ChoicesCallable instance or None if attribute does not exist
     """
-    return cast(Optional[ChoicesCallable], getattr(self, ATTR_CHOICES_CALLABLE, None))
+    return cast("Optional[ChoicesCallable]", getattr(self, ATTR_CHOICES_CALLABLE, None))
 
 
 setattr(argparse.Action, 'get_choices_callable', _action_get_choices_callable)
@@ -545,7 +545,7 @@ def _action_get_descriptive_header(self: argparse.Action) -> Optional[str]:
     :param self: argparse Action being queried
     :return: The value of descriptive_header or None if attribute does not exist
     """
-    return cast(Optional[str], getattr(self, ATTR_DESCRIPTIVE_HEADER, None))
+    return cast("Optional[str]", getattr(self, ATTR_DESCRIPTIVE_HEADER, None))
 
 
 setattr(argparse.Action, 'get_descriptive_header', _action_get_descriptive_header)
@@ -582,7 +582,7 @@ def _action_get_nargs_range(self: argparse.Action) -> Optional[Tuple[int, Union[
     :param self: argparse Action being queried
     :return: The value of nargs_range or None if attribute does not exist
     """
-    return cast(Optional[Tuple[int, Union[int, float]]], getattr(self, ATTR_NARGS_RANGE, None))
+    return cast("Optional[Tuple[int, Union[int, float]]]", getattr(self, ATTR_NARGS_RANGE, None))
 
 
 setattr(argparse.Action, 'get_nargs_range', _action_get_nargs_range)
@@ -619,7 +619,7 @@ def _action_get_suppress_tab_hint(self: argparse.Action) -> bool:
     :param self: argparse Action being queried
     :return: The value of suppress_tab_hint or False if attribute does not exist
     """
-    return cast(bool, getattr(self, ATTR_SUPPRESS_TAB_HINT, False))
+    return cast("bool", getattr(self, ATTR_SUPPRESS_TAB_HINT, False))
 
 
 setattr(argparse.Action, 'get_suppress_tab_hint', _action_get_suppress_tab_hint)
@@ -929,7 +929,7 @@ def _ArgumentParser_get_ap_completer_type(self: argparse.ArgumentParser) -> Opti
     :param self: ArgumentParser being queried
     :return: An ArgparseCompleter-based class or None if attribute does not exist
     """
-    return cast(Optional[Type['ArgparseCompleter']], getattr(self, ATTR_AP_COMPLETER_TYPE, None))
+    return cast("Optional[Type[ArgparseCompleter]]", getattr(self, ATTR_AP_COMPLETER_TYPE, None))
 
 
 setattr(argparse.ArgumentParser, 'get_ap_completer_type', _ArgumentParser_get_ap_completer_type)

cmd2/clipboard.py

@@ -13,7 +13,7 @@ def get_paste_buffer() -> str:
 
     :return: contents of the clipboard
     """
-    pb_str = typing.cast(str, pyperclip.paste())
+    pb_str = typing.cast("str", pyperclip.paste())
     return pb_str
 
 

cmd2/cmd2.py

@@ -183,7 +183,7 @@
         )
 
         rl_basic_quote_characters = ctypes.c_char_p.in_dll(readline_lib, "rl_basic_quote_characters")
-        orig_rl_basic_quotes = cast(bytes, ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value)
+        orig_rl_basic_quotes = cast("bytes", ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value)
 
 
 class _SavedReadlineSettings:
@@ -715,7 +715,7 @@ def register_command_set(self, cmdset: CommandSet) -> None:
 
         cmdset.on_register(self)
         methods = cast(
-            List[Tuple[str, Callable[..., Any]]],
+            "List[Tuple[str, Callable[..., Any]]]",
             inspect.getmembers(
                 cmdset,
                 predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
@@ -978,7 +978,7 @@ def find_subcommand(action: argparse.ArgumentParser, subcmd_names: List[str]) ->
 
             target_parser = find_subcommand(command_parser, subcommand_names)
 
-            subcmd_parser = cast(argparse.ArgumentParser, self._build_parser(cmdset, subcmd_parser_builder))
+            subcmd_parser = cast("argparse.ArgumentParser", self._build_parser(cmdset, subcmd_parser_builder))
             from .decorators import (
                 _set_parser_prog,
             )
@@ -1161,7 +1161,7 @@ def allow_style_type(value: str) -> ansi.AllowStyle:
                 'Allow ANSI text style sequences in output (valid values: '
                 f'{ansi.AllowStyle.ALWAYS}, {ansi.AllowStyle.NEVER}, {ansi.AllowStyle.TERMINAL})',
                 self,
-                choices_provider=cast(ChoicesProviderFunc, get_allow_style_choices),
+                choices_provider=cast("ChoicesProviderFunc", get_allow_style_choices),
             )
         )
 
@@ -1953,7 +1953,7 @@ def _display_matches_gnu_readline(
 
                 # rl_display_match_list() expects matches to be in argv format where
                 # substitution is the first element, followed by the matches, and then a NULL.
-                strings_array = cast(List[Optional[bytes]], (ctypes.c_char_p * (1 + len(encoded_matches) + 1))())
+                strings_array = cast("List[Optional[bytes]]", (ctypes.c_char_p * (1 + len(encoded_matches) + 1))())
 
                 # Copy in the encoded strings and add a NULL to the end
                 strings_array[0] = encoded_substitution
@@ -2877,7 +2877,7 @@ def _redirect_output(self, statement: Statement) -> utils.RedirectionSavedState:
 
         # Initialize the redirection saved state
         redir_saved_state = utils.RedirectionSavedState(
-            cast(TextIO, self.stdout), sys.stdout, self._cur_pipe_proc_reader, self._redirecting
+            cast("TextIO", self.stdout), sys.stdout, self._cur_pipe_proc_reader, self._redirecting
         )
 
         # The ProcReader for this command
@@ -2893,7 +2893,7 @@ def _redirect_output(self, statement: Statement) -> utils.RedirectionSavedState:
 
             # Open each side of the pipe
             subproc_stdin = io.open(read_fd, 'r')
-            new_stdout: TextIO = cast(TextIO, io.open(write_fd, 'w'))
+            new_stdout: TextIO = cast("TextIO", io.open(write_fd, 'w'))
 
             # Create pipe process in a separate group to isolate our signals from it. If a Ctrl-C event occurs,
             # our sigint handler will forward it only to the most recent pipe process. This makes sure pipe
@@ -2934,7 +2934,7 @@ def _redirect_output(self, statement: Statement) -> utils.RedirectionSavedState:
                 new_stdout.close()
                 raise RedirectionError(f'Pipe process exited with code {proc.returncode} before command could run')
             redir_saved_state.redirecting = True  # type: ignore[unreachable]
-            cmd_pipe_proc_reader = utils.ProcReader(proc, cast(TextIO, self.stdout), sys.stderr)
+            cmd_pipe_proc_reader = utils.ProcReader(proc, cast("TextIO", self.stdout), sys.stderr)
             sys.stdout = self.stdout = new_stdout
 
         elif statement.output:
@@ -2944,7 +2944,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(utils.strip_quotes(statement.output_to), mode=mode, buffering=1))
+                    new_stdout = cast("TextIO", open(utils.strip_quotes(statement.output_to), mode=mode, buffering=1))
                 except OSError as ex:
                     raise RedirectionError(f'Failed to redirect because: {ex}')
 
@@ -2965,7 +2965,7 @@ def _redirect_output(self, statement: Statement) -> utils.RedirectionSavedState:
                 # no point opening up the temporary file
                 current_paste_buffer = get_paste_buffer()
                 # create a temporary file to store output
-                new_stdout = cast(TextIO, tempfile.TemporaryFile(mode="w+"))
+                new_stdout = cast("TextIO", tempfile.TemporaryFile(mode="w+"))
                 redir_saved_state.redirecting = True
                 sys.stdout = self.stdout = new_stdout
 
@@ -2998,8 +2998,8 @@ def _restore_output(self, statement: Statement, saved_redir_state: utils.Redirec
                 pass
 
             # Restore the stdout values
-            self.stdout = cast(TextIO, saved_redir_state.saved_self_stdout)
-            sys.stdout = cast(TextIO, saved_redir_state.saved_sys_stdout)
+            self.stdout = cast("TextIO", saved_redir_state.saved_self_stdout)
+            sys.stdout = cast("TextIO", saved_redir_state.saved_sys_stdout)
 
             # Check if we need to wait for the process being piped to
             if self._cur_pipe_proc_reader is not None:
@@ -3025,7 +3025,7 @@ def cmd_func(self, command: str) -> Optional[CommandFunc]:
         """
         func_name = constants.COMMAND_FUNC_PREFIX + command
         func = getattr(self, func_name, None)
-        return cast(CommandFunc, func) if callable(func) else None
+        return cast("CommandFunc", func) if callable(func) else None
 
     def onecmd(self, statement: Union[Statement, str], *, add_to_history: bool = True) -> bool:
         """This executes the actual do_* method for a command.
@@ -3285,7 +3285,7 @@ def _set_up_cmd2_readline(self) -> _SavedReadlineSettings:
                 # We don't want this behavior since cmd2 only adds a closing quote when self.allow_closing_quote is True.
                 # To fix this behavior, set readline's rl_basic_quote_characters to NULL. We don't need to worry about setting
                 # rl_completion_suppress_quote since we never declared rl_completer_quote_characters.
-                readline_settings.basic_quotes = cast(bytes, ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value)
+                readline_settings.basic_quotes = cast("bytes", ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value)
                 rl_basic_quote_characters.value = None
 
             readline_settings.completer = readline.get_completer()
@@ -3950,7 +3950,7 @@ def _build_command_info(self) -> Tuple[Dict[str, List[str]], List[str], List[str
         cmds_undoc: List[str] = []
         cmds_cats: Dict[str, List[str]] = {}
         for command in visible_commands:
-            func = cast(CommandFunc, self.cmd_func(command))
+            func = cast("CommandFunc", self.cmd_func(command))
             has_help_func = False
             has_parser = func in self._command_parsers
 
@@ -4020,7 +4020,7 @@ def _print_topics(self, header: str, cmds: List[str], verbose: bool) -> None:
                             stdout_orig = self.stdout
                             try:
                                 # redirect our internal stdout
-                                self.stdout = cast(TextIO, result)
+                                self.stdout = cast("TextIO", result)
                                 help_func()
                             finally:
                                 # restore internal stdout
@@ -4087,7 +4087,7 @@ def select(self, opts: Union[str, List[str], List[Tuple[Any, Optional[str]]]], p
                                 the text advertised to the user"""
         local_opts: Union[List[str], List[Tuple[Any, Optional[str]]]]
         if isinstance(opts, str):
-            local_opts = cast(List[Tuple[Any, Optional[str]]], list(zip(opts.split(), opts.split())))
+            local_opts = cast("List[Tuple[Any, Optional[str]]]", list(zip(opts.split(), opts.split())))
         else:
             local_opts = opts
         fulloptions: List[Tuple[Any, Optional[str]]] = []
@@ -4287,7 +4287,7 @@ def do_shell(self, args: argparse.Namespace) -> None:
                 **kwargs,
             )
 
-            proc_reader = utils.ProcReader(proc, cast(TextIO, self.stdout), sys.stderr)  # type: ignore[arg-type]
+            proc_reader = utils.ProcReader(proc, cast("TextIO", self.stdout), sys.stderr)  # type: ignore[arg-type]
             proc_reader.wait()
 
             # Save the return code of the application for use in a pyscript
@@ -4346,7 +4346,7 @@ def _set_up_py_shell_env(self, interp: InteractiveConsole) -> _SavedCmd2Env:
                 # rlcompleter relies on the default settings of the Python readline module
                 if rl_type == RlType.GNU:
                     cmd2_env.readline_settings.basic_quotes = cast(
-                        bytes, ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value
+                        "bytes", ctypes.cast(rl_basic_quote_characters, ctypes.c_void_p).value
                     )
                     rl_basic_quote_characters.value = orig_rl_basic_quotes
 
@@ -4995,8 +4995,8 @@ def _generate_transcript(
                 transcript += command
 
                 # Use a StdSim object to capture output
-                stdsim = utils.StdSim(cast(TextIO, self.stdout))
-                self.stdout = cast(TextIO, stdsim)
+                stdsim = utils.StdSim(cast("TextIO", self.stdout))
+                self.stdout = cast("TextIO", stdsim)
 
                 # then run the command and let the output go into our buffer
                 try:
@@ -5021,7 +5021,7 @@ def _generate_transcript(
             with self.sigint_protection:
                 # Restore altered attributes to their original state
                 self.echo = saved_echo
-                self.stdout = cast(TextIO, saved_stdout)
+                self.stdout = cast("TextIO", saved_stdout)
 
         # Check if all commands ran
         if commands_run < len(history):
@@ -5235,7 +5235,7 @@ class TestMyAppCase(Cmd2TestCase):
         setattr(self.__class__, 'testfiles', transcripts_expanded)
         sys.argv = [sys.argv[0]]  # the --test argument upsets unittest.main()
         testcase = TestMyAppCase()
-        stream = cast(TextIO, utils.StdSim(sys.stderr))
+        stream = cast("TextIO", utils.StdSim(sys.stderr))
         runner = unittest.TextTestRunner(stream=stream)
         start_time = time.time()
         test_results = runner.run(testcase)
@@ -5624,7 +5624,7 @@ def register_postloop_hook(self, func: Callable[[], None]) -> None:
     @classmethod
     def _validate_postparsing_callable(cls, func: Callable[[plugin.PostparsingData], plugin.PostparsingData]) -> None:
         """Check parameter and return types for postparsing hooks"""
-        cls._validate_callable_param_count(cast(Callable[..., Any], func), 1)
+        cls._validate_callable_param_count(cast("Callable[..., Any]", func), 1)
         signature = inspect.signature(func)
         _, param = list(signature.parameters.items())[0]
         if param.annotation != plugin.PostparsingData:
@@ -5646,7 +5646,7 @@ def _validate_prepostcmd_hook(
         """Check parameter and return types for pre and post command hooks."""
         signature = inspect.signature(func)
         # validate that the callable has the right number of parameters
-        cls._validate_callable_param_count(cast(Callable[..., Any], func), 1)
+        cls._validate_callable_param_count(cast("Callable[..., Any]", func), 1)
         # validate the parameter has the right annotation
         paramname = list(signature.parameters.keys())[0]
         param = signature.parameters[paramname]

cmd2/py_bridge.py

@@ -117,7 +117,7 @@ def __call__(self, command: str, *, echo: Optional[bool] = None) -> CommandResul
             echo = self.cmd_echo
 
         # This will be used to capture _cmd2_app.stdout and sys.stdout
-        copy_cmd_stdout = StdSim(cast(Union[TextIO, StdSim], self._cmd2_app.stdout), echo=echo)
+        copy_cmd_stdout = StdSim(cast('Union[TextIO, StdSim]', self._cmd2_app.stdout), echo=echo)
 
         # Pause the storing of stdout until onecmd_plus_hooks enables it
         copy_cmd_stdout.pause_storage = True
@@ -129,17 +129,17 @@ def __call__(self, command: str, *, echo: Optional[bool] = None) -> CommandResul
 
         stop = False
         try:
-            self._cmd2_app.stdout = cast(TextIO, copy_cmd_stdout)
-            with redirect_stdout(cast(IO[str], copy_cmd_stdout)):
-                with redirect_stderr(cast(IO[str], copy_stderr)):
+            self._cmd2_app.stdout = cast('TextIO', copy_cmd_stdout)
+            with redirect_stdout(cast('IO[str]', copy_cmd_stdout)):
+                with redirect_stderr(cast('IO[str]', copy_stderr)):
                     stop = self._cmd2_app.onecmd_plus_hooks(
                         command,
                         add_to_history=self._add_to_history,
                         py_bridge_call=True,
                     )
         finally:
             with self._cmd2_app.sigint_protection:
-                self._cmd2_app.stdout = cast(IO[str], copy_cmd_stdout.inner_stream)
+                self._cmd2_app.stdout = cast('IO[str]', copy_cmd_stdout.inner_stream)
                 self.stop = stop or self.stop
 
         # Save the result

cmd2/transcript.py

@@ -51,7 +51,7 @@ def setUp(self) -> None:
 
             # Trap stdout
             self._orig_stdout = self.cmdapp.stdout
-            self.cmdapp.stdout = cast(TextIO, utils.StdSim(cast(TextIO, self.cmdapp.stdout)))
+            self.cmdapp.stdout = cast('TextIO', utils.StdSim(cast('TextIO', self.cmdapp.stdout)))
 
     def tearDown(self) -> None:
         if self.cmdapp:
@@ -66,7 +66,7 @@ def runTest(self) -> None:  # was testall
 
     def _fetchTranscripts(self) -> None:
         self.transcripts = {}
-        testfiles = cast(List[str], getattr(self.cmdapp, 'testfiles', []))
+        testfiles = cast('List[str]', getattr(self.cmdapp, 'testfiles', []))
         for fname in testfiles:
             tfile = open(fname)
             self.transcripts[fname] = iter(tfile.readlines())

cmd2/utils.py

@@ -164,7 +164,7 @@ def get_bool_choices(_) -> List[str]:  # type: ignore[no-untyped-def]
                 return ['true', 'false']
 
             val_type = to_bool
-            choices_provider = cast(ChoicesProviderFunc, get_bool_choices)
+            choices_provider = cast('ChoicesProviderFunc', get_bool_choices)
 
         self.name = name
         self.val_type = val_type
@@ -1194,7 +1194,7 @@ def get_defining_class(meth: Callable[..., Any]) -> Optional[Type[Any]]:
         cls = getattr(inspect.getmodule(meth), meth.__qualname__.split('.<locals>', 1)[0].rsplit('.', 1)[0])
         if isinstance(cls, type):
             return cls
-    return cast(type, getattr(meth, '__objclass__', None))  # handle special descriptor objects
+    return cast('type', getattr(meth, '__objclass__', None))  # handle special descriptor objects
 
 
 class CompletionMode(Enum):

pyproject.toml

@@ -212,7 +212,7 @@ select = [
     # "SLOT", # flake8-slots (warn about subclasses that should define __slots__)
     "T10", # flake8-debugger (check for pdb traces left in Python code)
     # "T20",  # flake8-print (warn about use of `print` or `pprint` - force use of loggers)
-    # "TC",  # flake8-type-checking (type checking warnings)
+    "TC", # flake8-type-checking (type checking warnings)
     # "TD", # flake8-todos (force all TODOs to include an author and issue link)
     "TID", # flake8-tidy-imports (extra import rules to check)
     # "TRY",  # tryceratops (warnings related to exceptions and try/except)