Merge pull request #7826 from jaraco/bugfix/6973-format-method

Convert the remaining '%' formatters to '.format'.

Author: pradyunsg

docs/pip_sphinxext.py

@@ -42,15 +42,16 @@ def run(self):
 class PipOptions(rst.Directive):
 
     def _format_option(self, option, cmd_name=None):
-        if cmd_name:
-            bookmark_line = ".. _`%s_%s`:" % (cmd_name, option._long_opts[0])
-        else:
-            bookmark_line = ".. _`%s`:" % option._long_opts[0]
+        bookmark_line = (
+            ".. _`{cmd_name}_{option._long_opts[0]}`:"
+            if cmd_name else
+            ".. _`{option._long_opts[0]}`:"
+        ).format(**locals())
         line = ".. option:: "
         if option._short_opts:
             line += option._short_opts[0]
         if option._short_opts and option._long_opts:
-            line += ", %s" % option._long_opts[0]
+            line += ", " + option._long_opts[0]
         elif option._long_opts:
             line += option._long_opts[0]
         if option.takes_value():
@@ -60,7 +61,7 @@ def _format_option(self, option, cmd_name=None):
         opt_help = option.help.replace('%default', str(option.default))
         # fix paths with sys.prefix
         opt_help = opt_help.replace(sys.prefix, "<sys.prefix>")
-        return [bookmark_line, "", line, "", "    %s" % opt_help, ""]
+        return [bookmark_line, "", line, "", "    " + opt_help, ""]
 
     def _format_options(self, options, cmd_name=None):
         for option in options:

news/7826.feature

@@ -0,0 +1 @@
+Replaced remaining uses of '%' formatting with .format. Fixed two regressions introduced in earlier attempts.

src/pip/_internal/cli/main_parser.py

@@ -48,7 +48,7 @@ def create_main_parser():
 
     # create command listing for description
     description = [''] + [
-        '%-27s %s' % (name, command_info.summary)
+        '{name:27} {command_info.summary}'.format(**locals())
         for name, command_info in commands_dict.items()
     ]
     parser.description = '\n'.join(description)

src/pip/_internal/cli/parser.py

@@ -31,14 +31,14 @@ def __init__(self, *args, **kwargs):
         optparse.IndentedHelpFormatter.__init__(self, *args, **kwargs)
 
     def format_option_strings(self, option):
-        return self._format_option_strings(option, ' <%s>', ', ')
+        return self._format_option_strings(option)
 
     def _format_option_strings(self, option, mvarfmt=' <{}>', optsep=', '):
         """
         Return a comma-separated list of option strings and metavars.
 
         :param option:  tuple of (short opt, long opt), e.g: ('-f', '--format')
-        :param mvarfmt: metavar format string - evaluated as mvarfmt % metavar
+        :param mvarfmt: metavar format string
         :param optsep:  separator
         """
         opts = []

src/pip/_internal/cli/progress_bars.py

@@ -14,7 +14,7 @@
 from pip._internal.utils.typing import MYPY_CHECK_RUNNING
 
 if MYPY_CHECK_RUNNING:
-    from typing import Any, Dict, List
+    from typing import Any, Dict, Iterator, List, Tuple
 
 try:
     from pip._vendor import colorama
@@ -124,7 +124,7 @@ def update(self):
 
 class BlueEmojiBar(IncrementalBar):
 
-    suffix = "%(percent)d%%"
+    suffix = "{percent:.0f}%"
     bar_prefix = " "
     bar_suffix = " "
     phases = (u"\U0001F539", u"\U0001F537", u"\U0001F535")  # type: Any
@@ -203,8 +203,8 @@ class BaseDownloadProgressBar(WindowsMixin, InterruptibleMixin,
                               DownloadProgressMixin):
 
     file = sys.stdout
-    message = "%(percent)d%%"
-    suffix = "%(downloaded)s %(download_speed)s %(pretty_eta)s"
+    message = "{percent:.0f}%"
+    suffix = "{downloaded} {download_speed} {pretty_eta}"
 
 # NOTE: The "type: ignore" comments on the following classes are there to
 #       work around https://github.com/python/typing/issues/241
@@ -238,7 +238,7 @@ class DownloadProgressSpinner(WindowsMixin, InterruptibleMixin,
                               DownloadProgressMixin, Spinner):
 
     file = sys.stdout
-    suffix = "%(downloaded)s %(download_speed)s"
+    suffix = "{downloaded} {download_speed}"
 
     def next_phase(self):  # type: ignore
         if not hasattr(self, "_phaser"):
@@ -247,19 +247,22 @@ def next_phase(self):  # type: ignore
 
     def update(self):
         # type: () -> None
-        message = self.message % self
+        vals = dict(self._load_vals(
+            'downloaded', 'download_speed', 'pretty_eta', 'percent'))
+        message = self.message.format(**vals)
         phase = self.next_phase()
-        suffix = self.suffix % self
-        line = ''.join([
-            message,
-            " " if message else "",
-            phase,
-            " " if suffix else "",
-            suffix,
-        ])
-
+        suffix = self.suffix.format(**vals)
+        line = " ".join(filter(None, (message, phase, suffix)))
         self.writeln(line)
 
+    def _load_vals(self, *names):
+        # type: (*str) -> Iterator[Tuple[str, Any]]
+        for name in names:
+            try:
+                yield name, getattr(self, name)
+            except Exception:
+                pass
+
 
 BAR_TYPES = {
     "off": (DownloadSilentBar, DownloadSilentBar),

src/pip/_internal/cli/req_command.py

@@ -342,13 +342,13 @@ def get_requirements(
             opts = {'name': self.name}
             if options.find_links:
                 raise CommandError(
-                    'You must give at least one requirement to %(name)s '
-                    '(maybe you meant "pip %(name)s %(links)s"?)' %
-                    dict(opts, links=' '.join(options.find_links)))
+                    'You must give at least one requirement to {name} '
+                    '(maybe you meant "pip {name} {links}"?)'.format(
+                        **dict(opts, links=' '.join(options.find_links))))
             else:
                 raise CommandError(
-                    'You must give at least one requirement to %(name)s '
-                    '(see "pip help %(name)s")' % opts)
+                    'You must give at least one requirement to {name} '
+                    '(see "pip help {name}")'.format(**opts))
 
         return requirements
 

src/pip/_internal/cli/spinners.py

@@ -106,7 +106,8 @@ def finish(self, final_status):
         # type: (str) -> None
         if self._finished:
             return
-        self._update("finished with status '%s'" % (final_status,))
+        self._update(
+            "finished with status '{final_status}'".format(**locals()))
         self._finished = True
 
 

src/pip/_internal/commands/completion.py

@@ -10,29 +10,29 @@
 from pip._internal.utils.misc import get_prog
 
 BASE_COMPLETION = """
-# pip %(shell)s completion start%(script)s# pip %(shell)s completion end
+# pip {shell} completion start{script}# pip {shell} completion end
 """
 
 COMPLETION_SCRIPTS = {
     'bash': """
         _pip_completion()
-        {
-            COMPREPLY=( $( COMP_WORDS="${COMP_WORDS[*]}" \\
+        {{
+            COMPREPLY=( $( COMP_WORDS="${{COMP_WORDS[*]}}" \\
                            COMP_CWORD=$COMP_CWORD \\
                            PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) )
-        }
-        complete -o default -F _pip_completion %(prog)s
+        }}
+        complete -o default -F _pip_completion {prog}
     """,
     'zsh': """
-        function _pip_completion {
+        function _pip_completion {{
           local words cword
           read -Ac words
           read -cn cword
           reply=( $( COMP_WORDS="$words[*]" \\
                      COMP_CWORD=$(( cword-1 )) \\
                      PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null ))
-        }
-        compctl -K _pip_completion %(prog)s
+        }}
+        compctl -K _pip_completion {prog}
     """,
     'fish': """
         function __fish_complete_pip
@@ -43,7 +43,7 @@
             set -lx PIP_AUTO_COMPLETE 1
             string split \\  -- (eval $COMP_WORDS[1])
         end
-        complete -fa "(__fish_complete_pip)" -c %(prog)s
+        complete -fa "(__fish_complete_pip)" -c {prog}
     """,
 }
 
@@ -85,11 +85,10 @@ def run(self, options, args):
         shell_options = ['--' + shell for shell in sorted(shells)]
         if options.shell in shells:
             script = textwrap.dedent(
-                COMPLETION_SCRIPTS.get(options.shell, '') % {
-                    'prog': get_prog(),
-                }
+                COMPLETION_SCRIPTS.get(options.shell, '').format(
+                    prog=get_prog())
             )
-            print(BASE_COMPLETION % {'script': script, 'shell': options.shell})
+            print(BASE_COMPLETION.format(script=script, shell=options.shell))
         else:
             sys.stderr.write(
                 'ERROR: You must pass {}\n' .format(' or '.join(shell_options))

src/pip/_internal/commands/search.py

@@ -121,8 +121,9 @@ def print_results(hits, name_column_width=None, terminal_width=None):
                 summary = textwrap.wrap(summary, target_width)
                 summary = ('\n' + ' ' * (name_column_width + 3)).join(summary)
 
-        line = '%-*s - %s' % (name_column_width,
-                              '%s (%s)' % (name, latest), summary)
+        line = '{name_latest:{name_column_width}} - {summary}'.format(
+            name_latest='{name} ({latest})'.format(**locals()),
+            **locals())
         try:
             write_output(line)
             if name in installed_packages:

src/pip/_internal/commands/uninstall.py

@@ -73,8 +73,8 @@ def run(self, options, args):
                     reqs_to_uninstall[canonicalize_name(req.name)] = req
         if not reqs_to_uninstall:
             raise InstallationError(
-                'You must give at least one requirement to %(name)s (see '
-                '"pip help %(name)s")' % dict(name=self.name)
+                'You must give at least one requirement to {self.name} (see '
+                '"pip help {self.name}")'.format(**locals())
             )
 
         protect_pip_from_modification_on_windows(