Merge pull request #4700 from dstufft/make-internal

Author: dstufft

.landscape.yml

@@ -1,2 +1,2 @@
 ignore-paths:
-    - pip/_vendor/
+    - src/pip/_vendor/

.travis.yml

@@ -18,11 +18,6 @@ matrix:
       python: 2.7
     - env: TOXENV=py36
       python: 3.6
-    # Unvendored
-    - env: "TOXENV=py27 VENDOR=no WHEELS=yes"
-      python: 2.7
-    - env: "TOXENV=py36 VENDOR=no WHEELS=yes"
-      python: 3.6
     # All the other Py3 versions
     - env: TOXENV=py33
       python: 3.3

.travis/run.sh

@@ -2,44 +2,6 @@
 set -e
 set -x
 
-# We want to create the virtual environment here, but not actually run anything
-tox --notest
-
-# If we have a VENDOR=no then we want to reinstall pip into the virtual
-# environment without the vendor directory included as well as install the
-# dependencies we need installed.
-if [[ $VENDOR = "no" ]]; then
-    # Install our dependencies if we're not installing from wheels
-    if [[ $WHEELS != "yes" ]]; then
-        .tox/$TOXENV/bin/pip install -r pip/_vendor/vendor.txt --no-deps
-    fi
-
-    # Install our dependencies if we're installing from wheels
-    if [[ $WHEELS = "yes" ]]; then
-        mkdir -p /tmp/wheels
-        pip wheel --wheel-dir /tmp/wheels --no-deps -r pip/_vendor/vendor.txt
-        cp /tmp/wheels/* `echo .tox/$TOXENV/lib/python*/site-packages/pip/_vendor/`
-    fi
-
-    # Remove the vendored dependencies from within the installed pip inside of
-    # our installed copy of pip.
-    find .tox/$TOXENV/lib/python*/site-packages/pip/_vendor -d \
-        -not -regex '.*/pip/_vendor/__init__\.py$' \
-        -not -regex '.*/pip/_vendor$' \
-        -exec rm -rf {} \;
-
-    # Patch our installed pip/_vendor/__init__.py so that it knows to look for
-    # the vendored dependencies instead of only looking for the vendored.
-    sed -i 's/DEBUNDLED = False/DEBUNDLED = True/' \
-        .tox/$TOXENV/lib/python*/site-packages/pip/_vendor/__init__.py
-
-    # Test to make sure that we successfully installed without vendoring
-    if [ -f .tox/$TOXENV/lib/python*/site-packages/pip/_vendor/six.py ]; then
-        echo "Did not successfully unvendor"
-        exit 1
-    fi
-fi
-
 if [[ $TOXENV == py* ]]; then
     # Run unit tests
     tox -- -m unit

MANIFEST.in

@@ -3,19 +3,19 @@ include LICENSE.txt
 include NEWS.rst
 include README.rst
 include pyproject.toml
-include pip/_vendor/README.rst
-include pip/_vendor/vendor.txt
+include src/pip/_vendor/README.rst
+include src/pip/_vendor/vendor.txt
 
 exclude .coveragerc
 exclude .mailmap
 exclude .travis.yml
 exclude .landscape.yml
-exclude pip/_vendor/Makefile
+exclude src/pip/_vendor/Makefile
 exclude tox.ini
 exclude dev-requirements.txt
 exclude appveyor.yml
 
-recursive-include pip/_vendor *.pem
+recursive-include src/pip/_vendor *.pem
 recursive-include docs Makefile *.rst *.py *.bat
 
 prune .github

docs/pipext.py

@@ -6,9 +6,9 @@
 from docutils.parsers import rst
 from docutils.statemachine import ViewList
 from textwrap import dedent
-from pip.commands import commands_dict as commands
-from pip import cmdoptions
-from pip.utils import get_prog
+from pip._internal import cmdoptions
+from pip._internal.commands import commands_dict as commands
+from pip._internal.utils.misc import get_prog
 
 
 class PipCommandUsage(rst.Directive):

news/4696.removal

@@ -0,0 +1,2 @@
+Move all of pip's APIs into the pip._internal package, properly reflecting the
+fact that pip does not currently have any public APIs.

news/4700.removal

@@ -0,0 +1,2 @@
+Move all of pip's APIs into the pip._internal package, properly reflecting the
+fact that pip does not currently have any public APIs.

pip/models/__init__.py

@@ -15,7 +15,7 @@ exclude = .tox,.idea,*.egg,build,_vendor,data
 select = E,W,F
 
 [tool:pytest]
-addopts = --ignore pip/_vendor --ignore tests/tests_cache
+addopts = --ignore src/pip/_vendor --ignore tests/tests_cache
 
 [bdist_wheel]
 universal=1

setup.cfg

@@ -38,7 +38,7 @@ def find_version(*file_paths):
 
 setup(
     name="pip",
-    version=find_version("pip", "__init__.py"),
+    version=find_version("src", "pip", "__init__.py"),
     description="The PyPA recommended tool for installing Python packages.",
     long_description=long_description,
     classifiers=[
@@ -60,7 +60,11 @@ def find_version(*file_paths):
     author_email='[email protected]',
     url='https://pip.pypa.io/',
     license='MIT',
-    packages=find_packages(exclude=["contrib", "docs", "tests*", "tasks"]),
+    package_dir={"": "src"},
+    packages=find_packages(
+        where="src",
+        exclude=["contrib", "docs", "tests*", "tasks"],
+    ),
     package_data={
         "pip._vendor.certifi": ["*.pem"],
         "pip._vendor.requests": ["*.pem"],
@@ -69,9 +73,9 @@ def find_version(*file_paths):
     },
     entry_points={
         "console_scripts": [
-            "pip=pip:main",
-            "pip%s=pip:main" % sys.version[:1],
-            "pip%s=pip:main" % sys.version[:3],
+            "pip=pip._internal:main",
+            "pip%s=pip._internal:main" % sys.version[:1],
+            "pip%s=pip._internal:main" % sys.version[:3],
         ],
     },
     tests_require=tests_require,

setup.py

@@ -0,0 +1 @@
+__version__ = "10.0.0.dev0"

src/pip/__init__.py

@@ -13,7 +13,7 @@
     path = os.path.dirname(os.path.dirname(__file__))
     sys.path.insert(0, path)
 
-import pip  # noqa
+from pip._internal import main as _main  # noqa
 
 if __name__ == '__main__':
-    sys.exit(pip.main())
+    sys.exit(_main())

pip/__main__.py renamed to src/pip/__main__.py

@@ -40,13 +40,17 @@
         else:
             securetransport.inject_into_urllib3()
 
-from pip.exceptions import CommandError, PipError
-from pip.utils import get_installed_distributions, get_prog
-from pip.utils import deprecation
-from pip.vcs import git, mercurial, subversion, bazaar  # noqa
-from pip.baseparser import ConfigOptionParser, UpdatingDefaultsHelpFormatter
-from pip.commands import get_summaries, get_similar_commands
-from pip.commands import commands_dict
+from pip import __version__
+from pip._internal 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 (
+    ConfigOptionParser, UpdatingDefaultsHelpFormatter,
+)
+from pip._internal.commands import get_summaries, get_similar_commands
+from pip._internal.commands import commands_dict
 from pip._vendor.requests.packages.urllib3.exceptions import (
     InsecureRequestWarning,
 )
@@ -57,12 +61,8 @@
 # This fixes a peculiarity when importing via __import__ - as we are
 # initialising the pip module, "from pip import cmdoptions" is recursive
 # and appears not to work properly in that situation.
-import pip.cmdoptions
-cmdoptions = pip.cmdoptions
-
-# The version as used in the setup.py and the docs conf.py
-__version__ = "10.0.0.dev0"
-
+# import pip._internal.cmdoptions
+# cmdoptions = pip._internal.cmdoptions
 
 logger = logging.getLogger(__name__)
 
@@ -249,7 +249,3 @@ def main(args=None):
         logger.debug("Ignoring error %s when setting locale", e)
     command = commands_dict[cmd_name](isolated=check_isolated(cmd_args))
     return command.main(cmd_args)
-
-
-if __name__ == '__main__':
-    sys.exit(main())

pip/__init__.py renamed to src/pip/_internal/__init__.py

@@ -8,24 +8,27 @@
 import sys
 import warnings
 
-from pip import cmdoptions
-from pip.baseparser import ConfigOptionParser, UpdatingDefaultsHelpFormatter
-from pip.compat import WINDOWS
-from pip.download import PipSession
-from pip.exceptions import (
+from pip._internal import cmdoptions
+from pip._internal.baseparser import (
+    ConfigOptionParser, UpdatingDefaultsHelpFormatter
+)
+from pip._internal.compat import WINDOWS
+from pip._internal.download import PipSession
+from pip._internal.exceptions import (
     BadCommand, CommandError, InstallationError, PreviousBuildDirError,
     UninstallationError
 )
-from pip.index import PackageFinder
-from pip.locations import running_under_virtualenv
-from pip.req import InstallRequirement, parse_requirements
-from pip.status_codes import (
+from pip._internal.index import PackageFinder
+from pip._internal.locations import running_under_virtualenv
+from pip._internal.req import InstallRequirement, parse_requirements
+from pip._internal.status_codes import (
     ERROR, PREVIOUS_BUILD_DIR_ERROR, SUCCESS, UNKNOWN_ERROR,
     VIRTUALENV_NOT_FOUND
 )
-from pip.utils import deprecation, get_prog, normalize_path
-from pip.utils.logging import IndentingFormatter
-from pip.utils.outdated import pip_version_check
+from pip._internal.utils import deprecation
+from pip._internal.utils.logging import IndentingFormatter
+from pip._internal.utils.misc import get_prog, normalize_path
+from pip._internal.utils.outdated import pip_version_check
 
 __all__ = ['Command']
 
@@ -130,7 +133,7 @@ def main(self, args):
             "disable_existing_loggers": False,
             "filters": {
                 "exclude_warnings": {
-                    "()": "pip.utils.logging.MaxLevelFilter",
+                    "()": "pip._internal.utils.logging.MaxLevelFilter",
                     "level": logging.WARNING,
                 },
             },
@@ -143,20 +146,24 @@ def main(self, args):
             "handlers": {
                 "console": {
                     "level": level,
-                    "class": "pip.utils.logging.ColorizedStreamHandler",
+                    "class":
+                        "pip._internal.utils.logging.ColorizedStreamHandler",
                     "stream": self.log_streams[0],
                     "filters": ["exclude_warnings"],
                     "formatter": "indent",
                 },
                 "console_errors": {
                     "level": "WARNING",
-                    "class": "pip.utils.logging.ColorizedStreamHandler",
+                    "class":
+                        "pip._internal.utils.logging.ColorizedStreamHandler",
                     "stream": self.log_streams[1],
                     "formatter": "indent",
                 },
                 "user_log": {
                     "level": "DEBUG",
-                    "class": "pip.utils.logging.BetterRotatingFileHandler",
+                    "class":
+                        ("pip._internal.utils.logging"
+                         ".BetterRotatingFileHandler"),
                     "filename": options.log or "/dev/null",
                     "delay": True,
                     "formatter": "indent",

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

@@ -9,8 +9,8 @@
 
 from pip._vendor.six import string_types
 
-from pip.configuration import Configuration
-from pip.utils import get_terminal_size
+from pip._internal.configuration import Configuration
+from pip._internal.utils.misc import get_terminal_size
 
 logger = logging.getLogger(__name__)
 

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

@@ -8,10 +8,10 @@
 
 from pip._vendor.packaging.utils import canonicalize_name
 
-import pip.index
-from pip.compat import expanduser
-from pip.download import path_to_url
-from pip.wheel import InvalidWheelFilename, Wheel
+from pip._internal import index
+from pip._internal.compat import expanduser
+from pip._internal.download import path_to_url
+from pip._internal.wheel import InvalidWheelFilename, Wheel
 
 logger = logging.getLogger(__name__)
 
@@ -71,7 +71,7 @@ def _get_candidates(self, link, package_name):
             return []
 
         canonical_name = canonicalize_name(package_name)
-        formats = pip.index.fmt_ctl_formats(
+        formats = index.fmt_ctl_formats(
             self.format_control, canonical_name
         )
         if not self.allowed_formats.intersection(formats):
@@ -100,7 +100,7 @@ def _link_for_candidate(self, link, candidate):
         root = self.get_path_for_link(link)
         path = os.path.join(root, candidate)
 
-        return pip.index.Link(path_to_url(path))
+        return index.Link(path_to_url(path))
 
 
 class WheelCache(Cache):

pip/cache.py renamed to src/pip/_internal/cache.py

@@ -13,13 +13,13 @@
 from functools import partial
 from optparse import SUPPRESS_HELP, Option, OptionGroup
 
-from pip.index import (
+from pip._internal.index import (
     FormatControl, fmt_ctl_handle_mutual_exclude, fmt_ctl_no_binary
 )
-from pip.locations import USER_CACHE_DIR, src_prefix
-from pip.models import PyPI
-from pip.utils.hashes import STRONG_HASHES
-from pip.utils.ui import BAR_TYPES
+from pip._internal.locations import USER_CACHE_DIR, src_prefix
+from pip._internal.models import PyPI
+from pip._internal.utils.hashes import STRONG_HASHES
+from pip._internal.utils.ui import BAR_TYPES
 
 
 def make_option_group(group, parser):

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

@@ -3,19 +3,19 @@
 """
 from __future__ import absolute_import
 
-from pip.commands.completion import CompletionCommand
-from pip.commands.configuration import ConfigurationCommand
-from pip.commands.download import DownloadCommand
-from pip.commands.freeze import FreezeCommand
-from pip.commands.hash import HashCommand
-from pip.commands.help import HelpCommand
-from pip.commands.list import ListCommand
-from pip.commands.check import CheckCommand
-from pip.commands.search import SearchCommand
-from pip.commands.show import ShowCommand
-from pip.commands.install import InstallCommand
-from pip.commands.uninstall import UninstallCommand
-from pip.commands.wheel import WheelCommand
+from pip._internal.commands.completion import CompletionCommand
+from pip._internal.commands.configuration import ConfigurationCommand
+from pip._internal.commands.download import DownloadCommand
+from pip._internal.commands.freeze import FreezeCommand
+from pip._internal.commands.hash import HashCommand
+from pip._internal.commands.help import HelpCommand
+from pip._internal.commands.list import ListCommand
+from pip._internal.commands.check import CheckCommand
+from pip._internal.commands.search import SearchCommand
+from pip._internal.commands.show import ShowCommand
+from pip._internal.commands.install import InstallCommand
+from pip._internal.commands.uninstall import UninstallCommand
+from pip._internal.commands.wheel import WheelCommand
 
 commands_order = [
     InstallCommand,

pip/commands/__init__.py renamed to src/pip/_internal/commands/__init__.py

@@ -1,8 +1,8 @@
 import logging
 
-from pip.basecommand import Command
-from pip.operations.check import check_requirements
-from pip.utils import get_installed_distributions
+from pip._internal.basecommand import Command
+from pip._internal.operations.check import check_requirements
+from pip._internal.utils.misc import get_installed_distributions
 
 logger = logging.getLogger(__name__)