Automated refactoring to replace ancient print % formatting with f-strings amd the like

Author: tleonhardt

cmd2/history.py

@@ -165,7 +165,7 @@ class to gain access to the historical record.
     _history_items_field = 'history_items'
 
     def __init__(self, seq: Iterable[HistoryItem] = ()) -> None:
-        super(History, self).__init__(seq)
+        super().__init__(seq)
         self.session_start_index = 0
 
     def start_session(self) -> None:
@@ -192,7 +192,7 @@ def append(self, new: Union[Statement, HistoryItem]) -> None:
                     and added to the end of the list
         """
         history_item = HistoryItem(new) if isinstance(new, Statement) else new
-        super(History, self).append(history_item)
+        super().append(history_item)
 
     def clear(self) -> None:
         """Remove all items from the History list."""

examples/cmd_as_argument.py

@@ -49,7 +49,7 @@ def do_speak(self, args):
         words = []
         for word in args.words:
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)

examples/colors.py

@@ -63,7 +63,7 @@ def do_speak(self, args):
         words = []
         for word in args.words:
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)

examples/decorator_example.py

@@ -46,7 +46,7 @@ def do_speak(self, args: argparse.Namespace):
         words = []
         for word in args.words:
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)

examples/default_categories.py

@@ -75,7 +75,7 @@ class ExampleApp(cmd2.Cmd):
     """
 
     def __init__(self):
-        super(ExampleApp, self).__init__()
+        super().__init__()
 
     def do_something(self, arg):
         self.poutput('this is the something command')

examples/example.py

@@ -45,7 +45,7 @@ def do_speak(self, args):
         words = []
         for word in args.words:
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)

examples/first_app.py

@@ -39,7 +39,7 @@ def do_speak(self, args):
         words = []
         for word in args.words:
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)

examples/modular_commands_basic.py

@@ -28,7 +28,7 @@ class ExampleApp(cmd2.Cmd):
     """
 
     def __init__(self):
-        super(ExampleApp, self).__init__()
+        super().__init__()
 
     def do_something(self, arg):
         self.poutput('this is the something command')

examples/subcommands.py

@@ -77,7 +77,7 @@ def base_foo(self, args):
 
     def base_bar(self, args):
         """bar subcommand of base command"""
-        self.poutput('((%s))' % args.z)
+        self.poutput(f'(({args.z}))')
 
     def base_sport(self, args):
         """sport subcommand of base command"""

tests/test_argparse.py

@@ -47,7 +47,7 @@ def do_say(self, args, *, keyword_arg: Optional[str] = None):
             if word is None:
                 word = ''
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)
@@ -102,7 +102,7 @@ def do_speak(self, args, extra, *, keyword_arg: Optional[str] = None):
             if word is None:
                 word = ''
             if args.piglatin:
-                word = '%s%say' % (word[1:], word[0])
+                word = f'{word[1:]}{word[0]}ay'
             if args.shout:
                 word = word.upper()
             words.append(word)
@@ -266,11 +266,11 @@ def base_foo(self, args):
 
     def base_bar(self, args):
         """bar subcommand of base command"""
-        self.poutput('((%s))' % args.z)
+        self.poutput(f'(({args.z}))')
 
     def base_helpless(self, args):
         """helpless subcommand of base command"""
-        self.poutput('((%s))' % args.z)
+        self.poutput(f'(({args.z}))')
 
     # create the top-level parser for the base command
     base_parser = cmd2.Cmd2ArgumentParser()

tests/test_argparse_completer.py

@@ -1210,7 +1210,7 @@ def _complete_flags(self, text: str, line: str, begidx: int, endidx: int, matche
             if action.get_complete_when_ready() is True and not app.is_ready:
                 matched_flags.append(flag)
 
-        return super(CustomCompleter, self)._complete_flags(text, line, begidx, endidx, matched_flags)
+        return super()._complete_flags(text, line, begidx, endidx, matched_flags)
 
 
 # Add a custom argparse action attribute

tests/test_cmd2.py

@@ -477,17 +477,14 @@ def test_run_script_nested_run_scripts(base_app, request):
     assert base_app.last_result is True
 
     # Check that the right commands were executed.
-    expected = (
-        """
-%s
+    expected = f"""
+{initial_run}
 _relative_run_script precmds.txt
 set allow_style Always
 help
 shortcuts
 _relative_run_script postcmds.txt
 set allow_style Never"""
-        % initial_run
-    )
     out, err = run_cmd(base_app, 'history -s')
     assert out == normalize(expected)
 
@@ -498,16 +495,13 @@ def test_runcmds_plus_hooks(base_app, request):
     postfilepath = os.path.join(test_dir, 'scripts', 'postcmds.txt')
 
     base_app.runcmds_plus_hooks(['run_script ' + prefilepath, 'help', 'shortcuts', 'run_script ' + postfilepath])
-    expected = """
-run_script %s
+    expected = f"""
+run_script {prefilepath}
 set allow_style Always
 help
 shortcuts
-run_script %s
-set allow_style Never""" % (
-        prefilepath,
-        postfilepath,
-    )
+run_script {postfilepath}
+set allow_style Never"""
 
     out, err = run_cmd(base_app, 'history -s')
     assert out == normalize(expected)

tests/test_completion.py

@@ -1225,7 +1225,7 @@ def base_foo(self, args):
 
     def base_bar(self, args):
         """bar subcommand of base command"""
-        self.poutput('((%s))' % args.z)
+        self.poutput(f'(({args.z}))')
 
     def base_sport(self, args):
         """sport subcommand of base command"""

tests/test_transcript.py

@@ -53,7 +53,7 @@ def do_speak(self, opts, arg):
         """Repeats what you tell me to."""
         arg = ' '.join(arg)
         if opts.piglatin:
-            arg = '%s%say' % (arg[1:], arg[0])
+            arg = f'{arg[1:]}{arg[0]}ay'
         if opts.shout:
             arg = arg.upper()
         repetitions = opts.repeat or 1

tests/test_utils_defining_class.py

@@ -17,7 +17,7 @@ def parent_only_func(self, param1, param2):
 
 class ChildClass(ParentClass):
     def func_with_overrides(self):
-        super(ChildClass, self).func_with_overrides()
+        super().func_with_overrides()
 
     def child_function(self):
         pass

tests_isolated/test_commandset/conftest.py

@@ -178,7 +178,7 @@ class WithCommandSets(ExternalTestMixin, cmd2.Cmd):
     """Class for testing custom help_* methods which override docstring help."""
 
     def __init__(self, *args, **kwargs):
-        super(WithCommandSets, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
 
 @pytest.fixture

tests_isolated/test_commandset/test_argparse_subcommands.py

@@ -16,7 +16,7 @@ class SubcommandSet(cmd2.CommandSet):
     """Example cmd2 application where we a base command which has a couple subcommands."""
 
     def __init__(self, dummy):
-        super(SubcommandSet, self).__init__()
+        super().__init__()
 
     # subcommand functions for the base command
     def base_foo(self, args):
@@ -25,11 +25,11 @@ def base_foo(self, args):
 
     def base_bar(self, args):
         """bar subcommand of base command"""
-        self._cmd.poutput('((%s))' % args.z)
+        self._cmd.poutput(f'(({args.z}))')
 
     def base_helpless(self, args):
         """helpless subcommand of base command"""
-        self._cmd.poutput('((%s))' % args.z)
+        self._cmd.poutput(f'(({args.z}))')
 
     # create the top-level parser for the base command
     base_parser = cmd2.Cmd2ArgumentParser()

tests_isolated/test_commandset/test_categories.py

@@ -16,7 +16,7 @@ class MyBaseCommandSet(CommandSet):
     """Defines a default category for all sub-class CommandSets"""
 
     def __init__(self, _: Any):
-        super(MyBaseCommandSet, self).__init__()
+        super().__init__()
 
 
 class ChildInheritsParentCategories(MyBaseCommandSet):
@@ -79,7 +79,7 @@ class ExampleApp(cmd2.Cmd):
     """
 
     def __init__(self):
-        super(ExampleApp, self).__init__(auto_load_commands=False)
+        super().__init__(auto_load_commands=False)
 
     def do_something(self, arg):
         self.poutput('this is the something command')

tests_isolated/test_commandset/test_commandset.py

@@ -384,7 +384,7 @@ def test_load_commandset_errors(command_sets_manual, capsys):
 
 class LoadableBase(cmd2.CommandSet):
     def __init__(self, dummy):
-        super(LoadableBase, self).__init__()
+        super().__init__()
         self._dummy = dummy  # prevents autoload
         self._cut_called = False
 
@@ -444,7 +444,7 @@ def stir_pasta(self, ns: argparse.Namespace):
 
 class LoadableBadBase(cmd2.CommandSet):
     def __init__(self, dummy):
-        super(LoadableBadBase, self).__init__()
+        super().__init__()
         self._dummy = dummy  # prevents autoload
 
     def do_cut(self, ns: argparse.Namespace):
@@ -462,7 +462,7 @@ def do_cut(self, ns: argparse.Namespace):
 @cmd2.with_default_category('Fruits')
 class LoadableFruits(cmd2.CommandSet):
     def __init__(self, dummy):
-        super(LoadableFruits, self).__init__()
+        super().__init__()
         self._dummy = dummy  # prevents autoload
 
     def do_apple(self, _: cmd2.Statement):
@@ -479,7 +479,7 @@ def cut_banana(self, ns: argparse.Namespace):
 
 class LoadablePastaStir(cmd2.CommandSet):
     def __init__(self, dummy):
-        super(LoadablePastaStir, self).__init__()
+        super().__init__()
         self._dummy = dummy  # prevents autoload
 
     stir_pasta_vigor_parser = cmd2.Cmd2ArgumentParser()
@@ -493,7 +493,7 @@ def stir_pasta_vigorously(self, ns: argparse.Namespace):
 @cmd2.with_default_category('Vegetables')
 class LoadableVegetables(cmd2.CommandSet):
     def __init__(self, dummy):
-        super(LoadableVegetables, self).__init__()
+        super().__init__()
         self._dummy = dummy  # prevents autoload
 
     def do_arugula(self, _: cmd2.Statement):
@@ -679,7 +679,7 @@ def test_nested_subcommands(command_sets_manual):
 
     class BadNestedSubcommands(cmd2.CommandSet):
         def __init__(self, dummy):
-            super(BadNestedSubcommands, self).__init__()
+            super().__init__()
             self._dummy = dummy  # prevents autoload
 
         stir_pasta_vigor_parser = cmd2.Cmd2ArgumentParser()
@@ -712,7 +712,7 @@ class AppWithSubCommands(cmd2.Cmd):
     """Class for testing usage of `as_subcommand_to` decorator directly in a Cmd2 subclass."""
 
     def __init__(self, *args, **kwargs):
-        super(AppWithSubCommands, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     cut_parser = cmd2.Cmd2ArgumentParser()
     cut_subparsers = cut_parser.add_subparsers(title='item', help='item to cut')
@@ -790,7 +790,7 @@ class SupportFuncProvider(cmd2.CommandSet):
 
     def __init__(self, dummy):
         """dummy variable prevents this from being autoloaded in other tests"""
-        super(SupportFuncProvider, self).__init__()
+        super().__init__()
 
     def complete_states(self, text: str, line: str, begidx: int, endidx: int) -> list[str]:
         assert self is complete_states_expected_self
@@ -824,7 +824,7 @@ class SupportFuncUserUnrelated(cmd2.CommandSet):
 
     def __init__(self, dummy):
         """dummy variable prevents this from being autoloaded in other tests"""
-        super(SupportFuncUserUnrelated, self).__init__()
+        super().__init__()
 
     parser = cmd2.Cmd2ArgumentParser()
     parser.add_argument('state', type=str, completer=SupportFuncProvider.complete_states)
@@ -969,7 +969,7 @@ def test_cross_commandset_completer(command_sets_manual, capsys):
 class CommandSetWithPathComplete(cmd2.CommandSet):
     def __init__(self, dummy):
         """dummy variable prevents this from being autoloaded in other tests"""
-        super(CommandSetWithPathComplete, self).__init__()
+        super().__init__()
 
     parser = cmd2.Cmd2ArgumentParser()
     parser.add_argument('path', nargs='+', help='paths', completer=cmd2.Cmd.path_complete)
@@ -998,7 +998,7 @@ class BadSubcommandApp(cmd2.Cmd):
         """Class for testing usage of `as_subcommand_to` decorator directly in a Cmd2 subclass."""
 
         def __init__(self, *args, **kwargs):
-            super(BadSubcommandApp, self).__init__(*args, **kwargs)
+            super().__init__(*args, **kwargs)
 
         cut_parser = cmd2.Cmd2ArgumentParser()
         cut_subparsers = cut_parser.add_subparsers(title='item', help='item to cut')
@@ -1028,7 +1028,7 @@ def __init__(self):
     # Declare a CommandSet with a settable of some arbitrary property
     class WithSettablesA(CommandSetBase):
         def __init__(self):
-            super(WithSettablesA, self).__init__()
+            super().__init__()
 
             self._arbitrary = Arbitrary()
             self._settable_prefix = 'addon'
@@ -1047,7 +1047,7 @@ def __init__(self):
     # Declare a CommandSet with an empty settable prefix
     class WithSettablesNoPrefix(CommandSetBase):
         def __init__(self):
-            super(WithSettablesNoPrefix, self).__init__()
+            super().__init__()
 
             self._arbitrary = Arbitrary()
             self._settable_prefix = ''
@@ -1066,7 +1066,7 @@ def __init__(self):
     # Declare a commandset with duplicate settable name
     class WithSettablesB(CommandSetBase):
         def __init__(self):
-            super(WithSettablesB, self).__init__()
+            super().__init__()
 
             self._arbitrary = Arbitrary()
             self._settable_prefix = 'some'
@@ -1200,7 +1200,7 @@ class NsProviderSet(cmd2.CommandSet):
     # CommandSet which implements a namespace provider
     def __init__(self, dummy):
         # Use dummy argument so this won't be autoloaded by other tests
-        super(NsProviderSet, self).__init__()
+        super().__init__()
 
     def ns_provider(self) -> argparse.Namespace:
         ns = argparse.Namespace()
@@ -1213,7 +1213,7 @@ class NsProviderApp(cmd2.Cmd):
     # Used to test namespace providers in CommandSets
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
-        super(NsProviderApp, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
     @cmd2.with_argparser(cmd2.Cmd2ArgumentParser(), ns_provider=NsProviderSet.ns_provider)
     def do_test_ns(self, args: argparse.Namespace) -> None: