Merge pull request #5668 from pradyunsg/refactor/pip-cli-subpackage

Add a pip._internal.cli subpackage and move some CLI related modules into it

Author: pradyunsg

src/pip/_internal/__init__.py

@@ -39,12 +39,12 @@
             securetransport.inject_into_urllib3()
 
 from pip import __version__
-from pip._internal import cmdoptions
+from pip._internal.cli import cmdoptions
 from pip._internal.exceptions import CommandError, PipError
 from pip._internal.utils.misc import get_installed_distributions, get_prog
 from pip._internal.utils import deprecation
 from pip._internal.vcs import git, mercurial, subversion, bazaar  # noqa
-from pip._internal.baseparser import (
+from pip._internal.cli.parser import (
     ConfigOptionParser, UpdatingDefaultsHelpFormatter,
 )
 from pip._internal.commands import get_summaries, get_similar_commands

src/pip/_internal/cli/__init__.py

@@ -0,0 +1,4 @@
+"""Subpackage containing all of pip's command line interface related code
+"""
+
+# This file intentionally does not import submodules

src/pip/_internal/basecommand.py renamed to src/pip/_internal/cli/base_command.py

@@ -7,10 +7,14 @@
 import os
 import sys
 
-from pip._internal import cmdoptions
-from pip._internal.baseparser import (
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.parser import (
     ConfigOptionParser, UpdatingDefaultsHelpFormatter,
 )
+from pip._internal.cli.status_codes import (
+    ERROR, PREVIOUS_BUILD_DIR_ERROR, SUCCESS, UNKNOWN_ERROR,
+    VIRTUALENV_NOT_FOUND,
+)
 from pip._internal.download import PipSession
 from pip._internal.exceptions import (
     BadCommand, CommandError, InstallationError, PreviousBuildDirError,
@@ -20,10 +24,6 @@
 from pip._internal.locations import running_under_virtualenv
 from pip._internal.req.req_file import parse_requirements
 from pip._internal.req.req_install import InstallRequirement
-from pip._internal.status_codes import (
-    ERROR, PREVIOUS_BUILD_DIR_ERROR, SUCCESS, UNKNOWN_ERROR,
-    VIRTUALENV_NOT_FOUND,
-)
 from pip._internal.utils.logging import setup_logging
 from pip._internal.utils.misc import get_prog, normalize_path
 from pip._internal.utils.outdated import pip_version_check

src/pip/_internal/cmdoptions.py renamed to src/pip/_internal/cli/cmdoptions.py

@@ -21,7 +21,7 @@
 
 if MYPY_CHECK_RUNNING:
     from typing import List, Type  # noqa: F401
-    from pip._internal.basecommand import Command  # noqa: F401
+    from pip._internal.cli.base_command import Command  # noqa: F401
 
 commands_order = [
     InstallCommand,

src/pip/_internal/baseparser.py renamed to src/pip/_internal/cli/parser.py

@@ -1,6 +1,6 @@
 import logging
 
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 from pip._internal.operations.check import (
     check_package_set, create_package_set_from_installed,
 )

src/pip/_internal/status_codes.py renamed to src/pip/_internal/cli/status_codes.py

@@ -3,7 +3,7 @@
 import sys
 import textwrap
 
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 from pip._internal.utils.misc import get_prog
 
 BASE_COMPLETION = """

src/pip/_internal/commands/__init__.py

@@ -2,11 +2,11 @@
 import os
 import subprocess
 
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
+from pip._internal.cli.status_codes import ERROR, SUCCESS
 from pip._internal.configuration import Configuration, kinds
 from pip._internal.exceptions import PipError
 from pip._internal.locations import venv_config_file
-from pip._internal.status_codes import ERROR, SUCCESS
 from pip._internal.utils.misc import get_prog
 
 logger = logging.getLogger(__name__)

src/pip/_internal/commands/check.py

@@ -3,8 +3,8 @@
 import logging
 import os
 
-from pip._internal import cmdoptions
-from pip._internal.basecommand import RequirementCommand
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.base_command import RequirementCommand
 from pip._internal.exceptions import CommandError
 from pip._internal.index import FormatControl
 from pip._internal.operations.prepare import RequirementPreparer

src/pip/_internal/commands/completion.py

@@ -3,8 +3,8 @@
 import sys
 
 from pip._internal import index
-from pip._internal.basecommand import Command
 from pip._internal.cache import WheelCache
+from pip._internal.cli.base_command import Command
 from pip._internal.operations.freeze import freeze
 from pip._internal.utils.compat import stdlib_pkgs
 

src/pip/_internal/commands/configuration.py

@@ -4,8 +4,8 @@
 import logging
 import sys
 
-from pip._internal.basecommand import Command
-from pip._internal.status_codes import ERROR
+from pip._internal.cli.base_command import Command
+from pip._internal.cli.status_codes import ERROR
 from pip._internal.utils.hashes import FAVORITE_HASH, STRONG_HASHES
 from pip._internal.utils.misc import read_chunks
 

src/pip/_internal/commands/download.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
-from pip._internal.basecommand import SUCCESS, Command
+from pip._internal.cli.base_command import Command
+from pip._internal.cli.status_codes import SUCCESS
 from pip._internal.exceptions import CommandError
 
 

src/pip/_internal/commands/freeze.py

@@ -9,9 +9,10 @@
 
 from pip._vendor import pkg_resources
 
-from pip._internal import cmdoptions
-from pip._internal.basecommand import RequirementCommand
 from pip._internal.cache import WheelCache
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.base_command import RequirementCommand
+from pip._internal.cli.status_codes import ERROR
 from pip._internal.exceptions import (
     CommandError, InstallationError, PreviousBuildDirError,
 )
@@ -21,7 +22,6 @@
 from pip._internal.req import RequirementSet, install_given_reqs
 from pip._internal.req.req_tracker import RequirementTracker
 from pip._internal.resolve import Resolver
-from pip._internal.status_codes import ERROR
 from pip._internal.utils.filesystem import check_path_owner
 from pip._internal.utils.misc import (
     ensure_dir, get_installed_version,

src/pip/_internal/commands/hash.py

@@ -6,8 +6,8 @@
 from pip._vendor import six
 from pip._vendor.six.moves import zip_longest
 
-from pip._internal.basecommand import Command
-from pip._internal.cmdoptions import index_group, make_option_group
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.base_command import Command
 from pip._internal.exceptions import CommandError
 from pip._internal.index import PackageFinder
 from pip._internal.utils.misc import (
@@ -102,7 +102,9 @@ def __init__(self, *args, **kw):
             help='Include editable package from output.',
             default=True,
         )
-        index_opts = make_option_group(index_group, self.parser)
+        index_opts = cmdoptions.make_option_group(
+            cmdoptions.index_group, self.parser
+        )
 
         self.parser.insert_option_group(0, index_opts)
         self.parser.insert_option_group(0, cmd_opts)

src/pip/_internal/commands/help.py

@@ -11,11 +11,11 @@
 #       why we ignore the type on this import
 from pip._vendor.six.moves import xmlrpc_client  # type: ignore
 
-from pip._internal.basecommand import SUCCESS, Command
+from pip._internal.cli.base_command import Command
+from pip._internal.cli.status_codes import NO_MATCHES_FOUND, SUCCESS
 from pip._internal.download import PipXmlrpcTransport
 from pip._internal.exceptions import CommandError
 from pip._internal.models.index import PyPI
-from pip._internal.status_codes import NO_MATCHES_FOUND
 from pip._internal.utils.compat import get_terminal_size
 from pip._internal.utils.logging import indent_log
 

src/pip/_internal/commands/install.py

@@ -7,8 +7,8 @@
 from pip._vendor import pkg_resources
 from pip._vendor.packaging.utils import canonicalize_name
 
-from pip._internal.basecommand import Command
-from pip._internal.status_codes import ERROR, SUCCESS
+from pip._internal.cli.base_command import Command
+from pip._internal.cli.status_codes import ERROR, SUCCESS
 
 logger = logging.getLogger(__name__)
 

src/pip/_internal/commands/list.py

@@ -2,7 +2,7 @@
 
 from pip._vendor.packaging.utils import canonicalize_name
 
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 from pip._internal.exceptions import InstallationError
 from pip._internal.req import InstallRequirement, parse_requirements
 from pip._internal.utils.misc import protect_pip_from_modification_on_windows

src/pip/_internal/commands/search.py

@@ -4,9 +4,9 @@
 import logging
 import os
 
-from pip._internal import cmdoptions
-from pip._internal.basecommand import RequirementCommand
 from pip._internal.cache import WheelCache
+from pip._internal.cli import cmdoptions
+from pip._internal.cli.base_command import RequirementCommand
 from pip._internal.exceptions import CommandError, PreviousBuildDirError
 from pip._internal.operations.prepare import RequirementPreparer
 from pip._internal.req import RequirementSet

src/pip/_internal/commands/show.py

@@ -13,7 +13,7 @@
 from pip._vendor.six.moves import filterfalse
 from pip._vendor.six.moves.urllib import parse as urllib_parse
 
-from pip._internal import cmdoptions
+from pip._internal.cli import cmdoptions
 from pip._internal.download import get_file_content
 from pip._internal.exceptions import RequirementsFileParseError
 from pip._internal.req.req_install import InstallRequirement

src/pip/_internal/commands/uninstall.py

@@ -17,7 +17,7 @@
 
 if MYPY_CHECK_RUNNING:
     from typing import Dict, Optional, Tuple  # noqa: F401
-    from pip._internal.basecommand import Command  # noqa: F401
+    from pip._internal.cli.base_command import Command  # noqa: F401
 
 __all__ = ['vcs', 'get_src_requirement']
 

src/pip/_internal/commands/wheel.py

@@ -5,7 +5,7 @@
 
 import pytest
 
-from pip._internal.status_codes import ERROR
+from pip._internal.cli.status_codes import ERROR
 from tests.lib.configuration_helpers import ConfigurationMixin, kinds
 
 

src/pip/_internal/req/req_file.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from pip._internal.status_codes import ERROR
+from pip._internal.cli.status_codes import ERROR
 from tests.lib.path import Path
 
 

src/pip/_internal/vcs/__init__.py

@@ -1,7 +1,7 @@
 import pytest
 from mock import Mock
 
-from pip._internal.basecommand import ERROR, SUCCESS
+from pip._internal.cli.base_command import ERROR, SUCCESS
 from pip._internal.commands import commands_dict as commands
 from pip._internal.commands.help import HelpCommand
 from pip._internal.exceptions import CommandError

tests/functional/test_configuration.py

@@ -8,8 +8,8 @@
 import pytest
 
 from pip._internal import pep425tags
+from pip._internal.cli.status_codes import ERROR
 from pip._internal.models.index import PyPI, TestPyPI
-from pip._internal.status_codes import ERROR
 from pip._internal.utils.misc import rmtree
 from tests.lib import (
     _create_svn_repo, _create_test_package, create_test_package_with_setup,

tests/functional/test_download.py

@@ -3,8 +3,8 @@
 
 import pytest
 
+from pip._internal.cli.status_codes import PREVIOUS_BUILD_DIR_ERROR
 from pip._internal.locations import write_delete_marker_file
-from pip._internal.status_codes import PREVIOUS_BUILD_DIR_ERROR
 from tests.lib import need_mercurial
 from tests.lib.local_repos import local_checkout
 

tests/functional/test_help.py

@@ -2,10 +2,10 @@
 
 import pytest
 
+from pip._internal.cli.status_codes import NO_MATCHES_FOUND, SUCCESS
 from pip._internal.commands.search import (
     SearchCommand, highest_version, print_results, transform_hits,
 )
-from pip._internal.status_codes import NO_MATCHES_FOUND, SUCCESS
 from tests.lib import pyversion
 
 if pyversion >= '3':

tests/functional/test_install.py

@@ -4,8 +4,8 @@
 
 import pytest
 
+from pip._internal.cli.status_codes import ERROR, PREVIOUS_BUILD_DIR_ERROR
 from pip._internal.locations import write_delete_marker_file
-from pip._internal.status_codes import ERROR, PREVIOUS_BUILD_DIR_ERROR
 from tests.lib import pyversion
 
 

tests/functional/test_install_cleanup.py

@@ -4,7 +4,7 @@
 import os
 
 from pip._internal import cmdoptions
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 from pip._internal.commands import commands_dict
 
 

tests/functional/test_search.py

@@ -1,6 +1,6 @@
 import logging
 
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 
 
 class FakeCommand(Command):
@@ -32,9 +32,9 @@ def run(self, options, args):
         )
 
 
-class Test_basecommand_logging(object):
+class Test_base_command_logging(object):
     """
-    Test `pip.basecommand.Command` setting up logging consumers based on
+    Test `pip.base_command.Command` setting up logging consumers based on
     options
     """
 

tests/functional/test_wheel.py

@@ -1,5 +1,5 @@
 from pip._internal import cmdoptions, index
-from pip._internal.basecommand import Command
+from pip._internal.cli.base_command import Command
 
 
 class SimpleCommand(Command):