Merge pull request #9412 from jdufresne/kwargs

Use keyword-only arguments

Author: uranusjr

news/287c6463-d2a1-41f5-a2df-d11f8460551a.trivial.rst

@@ -52,19 +52,18 @@ class Command(CommandContextMixIn):
     def __init__(self, name, summary, isolated=False):
         # type: (str, str, bool) -> None
         super().__init__()
-        parser_kw = {
-            'usage': self.usage,
-            'prog': f'{get_prog()} {name}',
-            'formatter': UpdatingDefaultsHelpFormatter(),
-            'add_help_option': False,
-            'name': name,
-            'description': self.__doc__,
-            'isolated': isolated,
-        }
 
         self.name = name
         self.summary = summary
-        self.parser = ConfigOptionParser(**parser_kw)
+        self.parser = ConfigOptionParser(
+            usage=self.usage,
+            prog=f'{get_prog()} {name}',
+            formatter=UpdatingDefaultsHelpFormatter(),
+            add_help_option=False,
+            name=name,
+            description=self.__doc__,
+            isolated=isolated,
+        )
 
         self.tempdir_registry = None  # type: Optional[TempDirRegistry]
 

src/pip/_internal/cli/base_command.py

@@ -23,15 +23,13 @@ def create_main_parser():
     """Creates and returns the main parser for pip's CLI
     """
 
-    parser_kw = {
-        'usage': '\n%prog <command> [options]',
-        'add_help_option': False,
-        'formatter': UpdatingDefaultsHelpFormatter(),
-        'name': 'global',
-        'prog': get_prog(),
-    }
-
-    parser = ConfigOptionParser(**parser_kw)
+    parser = ConfigOptionParser(
+        usage='\n%prog <command> [options]',
+        add_help_option=False,
+        formatter=UpdatingDefaultsHelpFormatter(),
+        name='global',
+        prog=get_prog(),
+    )
     parser.disable_interspersed_args()
 
     parser.version = get_pip_version()

src/pip/_internal/cli/main_parser.py

@@ -14,6 +14,10 @@
 from pip._internal.cli.status_codes import UNKNOWN_ERROR
 from pip._internal.configuration import Configuration, ConfigurationError
 from pip._internal.utils.misc import redact_auth_from_url, strtobool
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Any
 
 logger = logging.getLogger(__name__)
 
@@ -154,10 +158,15 @@ class ConfigOptionParser(CustomOptionParser):
     """Custom option parser which updates its defaults by checking the
     configuration files and environmental variables"""
 
-    def __init__(self, *args, **kwargs):
-        self.name = kwargs.pop('name')
-
-        isolated = kwargs.pop("isolated", False)
+    def __init__(
+        self,
+        *args,  # type: Any
+        name,  # type: str
+        isolated=False,  # type: bool
+        **kwargs,  # type: Any
+    ):
+        # type: (...) -> None
+        self.name = name
         self.config = Configuration(isolated)
 
         assert self.name

src/pip/_internal/cli/parser.py

@@ -39,7 +39,7 @@
 from pip._internal.utils.urls import url_to_path
 
 if MYPY_CHECK_RUNNING:
-    from typing import Iterator, List, Optional, Tuple, Union
+    from typing import Any, Iterator, List, Optional, Sequence, Tuple, Union
 
     from pip._internal.models.link import Link
 
@@ -225,16 +225,20 @@ class PipSession(requests.Session):
 
     timeout = None  # type: Optional[int]
 
-    def __init__(self, *args, **kwargs):
+    def __init__(
+        self,
+        *args,  # type: Any
+        retries=0,  # type: int
+        cache=None,  # type: Optional[str]
+        trusted_hosts=(),  # type: Sequence[str]
+        index_urls=None,  # type: Optional[List[str]]
+        **kwargs,  # type: Any
+    ):
+        # type: (...) -> None
         """
         :param trusted_hosts: Domains not to emit warnings for when not using
             HTTPS.
         """
-        retries = kwargs.pop("retries", 0)
-        cache = kwargs.pop("cache", None)
-        trusted_hosts = kwargs.pop("trusted_hosts", [])  # type: List[str]
-        index_urls = kwargs.pop("index_urls", None)
-
         super().__init__(*args, **kwargs)
 
         # Namespace the attribute with "pip_" just in case to prevent

src/pip/_internal/network/session.py

@@ -12,6 +12,10 @@
 from pip._internal.utils.compat import WINDOWS
 from pip._internal.utils.deprecation import DEPRECATION_MSG_PREFIX
 from pip._internal.utils.misc import ensure_dir
+from pip._internal.utils.typing import MYPY_CHECK_RUNNING
+
+if MYPY_CHECK_RUNNING:
+    from typing import Any
 
 try:
     import threading
@@ -83,14 +87,20 @@ def get_indentation():
 class IndentingFormatter(logging.Formatter):
     default_time_format = "%Y-%m-%dT%H:%M:%S"
 
-    def __init__(self, *args, **kwargs):
+    def __init__(
+        self,
+        *args,  # type: Any
+        add_timestamp=False,  # type: bool
+        **kwargs,  # type: Any
+    ):
+        # type: (...) -> None
         """
         A logging.Formatter that obeys the indent_log() context manager.
 
         :param add_timestamp: A bool indicating output lines should be prefixed
             with their record's timestamp.
         """
-        self.add_timestamp = kwargs.pop("add_timestamp", False)
+        self.add_timestamp = add_timestamp
         super().__init__(*args, **kwargs)
 
     def get_message_start(self, formatted, levelno):

src/pip/_internal/utils/logging.py

@@ -454,16 +454,15 @@ class PipTestEnvironment(TestFileEnvironment):
     exe = sys.platform == 'win32' and '.exe' or ''
     verbose = False
 
-    def __init__(self, base_path, *args, **kwargs):
+    def __init__(self, base_path, *args, virtualenv, pip_expect_warning=None, **kwargs):
         # Make our base_path a test.lib.path.Path object
         base_path = Path(base_path)
 
         # Store paths related to the virtual environment
-        venv = kwargs.pop("virtualenv")
-        self.venv_path = venv.location
-        self.lib_path = venv.lib
-        self.site_packages_path = venv.site
-        self.bin_path = venv.bin
+        self.venv_path = virtualenv.location
+        self.lib_path = virtualenv.lib
+        self.site_packages_path = virtualenv.site
+        self.bin_path = virtualenv.bin
 
         self.user_base_path = self.venv_path.joinpath("user")
         self.user_site_path = self.venv_path.joinpath(
@@ -503,7 +502,7 @@ def __init__(self, base_path, *args, **kwargs):
 
         # Whether all pip invocations should expect stderr
         # (useful for Python version deprecation)
-        self.pip_expect_warning = kwargs.pop('pip_expect_warning', None)
+        self.pip_expect_warning = pip_expect_warning
 
         # Call the TestFileEnvironment __init__
         super().__init__(base_path, *args, **kwargs)
@@ -544,7 +543,16 @@ def _find_traverse(self, path, result):
         else:
             super()._find_traverse(path, result)
 
-    def run(self, *args, **kw):
+    def run(
+        self,
+        *args,
+        cwd=None,
+        run_from=None,
+        allow_stderr_error=None,
+        allow_stderr_warning=None,
+        allow_error=None,
+        **kw,
+    ):
         """
         :param allow_stderr_error: whether a logged error is allowed in
             stderr.  Passing True for this argument implies
@@ -567,20 +575,12 @@ def run(self, *args, **kw):
         if self.verbose:
             print('>> running {args} {kw}'.format(**locals()))
 
-        cwd = kw.pop('cwd', None)
-        run_from = kw.pop('run_from', None)
         assert not cwd or not run_from, "Don't use run_from; it's going away"
         cwd = cwd or run_from or self.cwd
         if sys.platform == 'win32':
             # Partial fix for ScriptTest.run using `shell=True` on Windows.
             args = [str(a).replace('^', '^^').replace('&', '^&') for a in args]
 
-        # Remove `allow_stderr_error`, `allow_stderr_warning` and
-        # `allow_error` before calling run() because PipTestEnvironment
-        # doesn't support them.
-        allow_stderr_error = kw.pop('allow_stderr_error', None)
-        allow_stderr_warning = kw.pop('allow_stderr_warning', None)
-        allow_error = kw.pop('allow_error', None)
         if allow_error:
             kw['expect_error'] = True
 
@@ -634,11 +634,11 @@ def run(self, *args, **kw):
 
         return TestPipResult(result, verbose=self.verbose)
 
-    def pip(self, *args, **kwargs):
+    def pip(self, *args, use_module=True, **kwargs):
         __tracebackhide__ = True
         if self.pip_expect_warning:
             kwargs['allow_stderr_warning'] = True
-        if kwargs.pop('use_module', True):
+        if use_module:
             exe = 'python'
             args = ('-m', 'pip') + args
         else: