347 lines
13 KiB
Python
347 lines
13 KiB
Python
|
"""Base Command class, and related routines"""
|
||
|
|
from __future__ import absolute_import, print_function
|
||
|
|
|
||
|
|
import logging
|
||
|
|
import logging.config
|
||
|
|
import optparse
|
||
|
|
import os
|
||
|
|
import platform
|
||
|
|
import sys
|
||
|
|
import traceback
|
||
|
|
|
||
|
|
from pip._internal.cli import cmdoptions
|
||
|
|
from pip._internal.cli.cmdoptions import make_search_scope
|
||
|
|
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,
|
||
|
|
UninstallationError,
|
||
|
|
)
|
||
|
|
from pip._internal.index import PackageFinder
|
||
|
|
from pip._internal.models.selection_prefs import SelectionPreferences
|
||
|
|
from pip._internal.models.target_python import TargetPython
|
||
|
|
from pip._internal.req.constructors import (
|
||
|
|
install_req_from_editable, install_req_from_line,
|
||
|
|
)
|
||
|
|
from pip._internal.req.req_file import parse_requirements
|
||
|
|
from pip._internal.utils.deprecation import deprecated
|
||
|
|
from pip._internal.utils.logging import BrokenStdoutLoggingError, setup_logging
|
||
|
|
from pip._internal.utils.misc import get_prog, normalize_path
|
||
|
|
from pip._internal.utils.outdated import pip_version_check
|
||
|
|
from pip._internal.utils.typing import MYPY_CHECK_RUNNING
|
||
|
|
from pip._internal.utils.virtualenv import running_under_virtualenv
|
||
|
|
|
||
|
|
if MYPY_CHECK_RUNNING:
|
||
|
|
from typing import Optional, List, Tuple, Any
|
||
|
|
from optparse import Values
|
||
|
|
from pip._internal.cache import WheelCache
|
||
|
|
from pip._internal.req.req_set import RequirementSet
|
||
|
|
|
||
|
|
__all__ = ['Command']
|
||
|
|
|
||
|
|
logger = logging.getLogger(__name__)
|
||
|
|
|
||
|
|
|
||
|
|
class Command(object):
|
||
|
|
name = None # type: Optional[str]
|
||
|
|
usage = None # type: Optional[str]
|
||
|
|
ignore_require_venv = False # type: bool
|
||
|
|
|
||
|
|
def __init__(self, isolated=False):
|
||
|
|
# type: (bool) -> None
|
||
|
|
parser_kw = {
|
||
|
|
'usage': self.usage,
|
||
|
|
'prog': '%s %s' % (get_prog(), self.name),
|
||
|
|
'formatter': UpdatingDefaultsHelpFormatter(),
|
||
|
|
'add_help_option': False,
|
||
|
|
'name': self.name,
|
||
|
|
'description': self.__doc__,
|
||
|
|
'isolated': isolated,
|
||
|
|
}
|
||
|
|
|
||
|
|
self.parser = ConfigOptionParser(**parser_kw)
|
||
|
|
|
||
|
|
# Commands should add options to this option group
|
||
|
|
optgroup_name = '%s Options' % self.name.capitalize()
|
||
|
|
self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name)
|
||
|
|
|
||
|
|
# Add the general options
|
||
|
|
gen_opts = cmdoptions.make_option_group(
|
||
|
|
cmdoptions.general_group,
|
||
|
|
self.parser,
|
||
|
|
)
|
||
|
|
self.parser.add_option_group(gen_opts)
|
||
|
|
|
||
|
|
def run(self, options, args):
|
||
|
|
# type: (Values, List[Any]) -> Any
|
||
|
|
raise NotImplementedError
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def _get_index_urls(cls, options):
|
||
|
|
"""Return a list of index urls from user-provided options."""
|
||
|
|
index_urls = []
|
||
|
|
if not getattr(options, "no_index", False):
|
||
|
|
url = getattr(options, "index_url", None)
|
||
|
|
if url:
|
||
|
|
index_urls.append(url)
|
||
|
|
urls = getattr(options, "extra_index_urls", None)
|
||
|
|
if urls:
|
||
|
|
index_urls.extend(urls)
|
||
|
|
# Return None rather than an empty list
|
||
|
|
return index_urls or None
|
||
|
|
|
||
|
|
def _build_session(self, options, retries=None, timeout=None):
|
||
|
|
# type: (Values, Optional[int], Optional[int]) -> PipSession
|
||
|
|
session = PipSession(
|
||
|
|
cache=(
|
||
|
|
normalize_path(os.path.join(options.cache_dir, "http"))
|
||
|
|
if options.cache_dir else None
|
||
|
|
),
|
||
|
|
retries=retries if retries is not None else options.retries,
|
||
|
|
insecure_hosts=options.trusted_hosts,
|
||
|
|
index_urls=self._get_index_urls(options),
|
||
|
|
)
|
||
|
|
|
||
|
|
# Handle custom ca-bundles from the user
|
||
|
|
if options.cert:
|
||
|
|
session.verify = options.cert
|
||
|
|
|
||
|
|
# Handle SSL client certificate
|
||
|
|
if options.client_cert:
|
||
|
|
session.cert = options.client_cert
|
||
|
|
|
||
|
|
# Handle timeouts
|
||
|
|
if options.timeout or timeout:
|
||
|
|
session.timeout = (
|
||
|
|
timeout if timeout is not None else options.timeout
|
||
|
|
)
|
||
|
|
|
||
|
|
# Handle configured proxies
|
||
|
|
if options.proxy:
|
||
|
|
session.proxies = {
|
||
|
|
"http": options.proxy,
|
||
|
|
"https": options.proxy,
|
||
|
|
}
|
||
|
|
|
||
|
|
# Determine if we can prompt the user for authentication or not
|
||
|
|
session.auth.prompting = not options.no_input
|
||
|
|
|
||
|
|
return session
|
||
|
|
|
||
|
|
def parse_args(self, args):
|
||
|
|
# type: (List[str]) -> Tuple
|
||
|
|
# factored out for testability
|
||
|
|
return self.parser.parse_args(args)
|
||
|
|
|
||
|
|
def main(self, args):
|
||
|
|
# type: (List[str]) -> int
|
||
|
|
options, args = self.parse_args(args)
|
||
|
|
|
||
|
|
# Set verbosity so that it can be used elsewhere.
|
||
|
|
self.verbosity = options.verbose - options.quiet
|
||
|
|
|
||
|
|
level_number = setup_logging(
|
||
|
|
verbosity=self.verbosity,
|
||
|
|
no_color=options.no_color,
|
||
|
|
user_log_file=options.log,
|
||
|
|
)
|
||
|
|
|
||
|
|
if sys.version_info[:2] == (2, 7):
|
||
|
|
message = (
|
||
|
|
"A future version of pip will drop support for Python 2.7. "
|
||
|
|
"More details about Python 2 support in pip, can be found at "
|
||
|
|
"https://pip.pypa.io/en/latest/development/release-process/#python-2-support" # noqa
|
||
|
|
)
|
||
|
|
if platform.python_implementation() == "CPython":
|
||
|
|
message = (
|
||
|
|
"Python 2.7 will reach the end of its life on January "
|
||
|
|
"1st, 2020. Please upgrade your Python as Python 2.7 "
|
||
|
|
"won't be maintained after that date. "
|
||
|
|
) + message
|
||
|
|
deprecated(message, replacement=None, gone_in=None)
|
||
|
|
|
||
|
|
# TODO: Try to get these passing down from the command?
|
||
|
|
# without resorting to os.environ to hold these.
|
||
|
|
# This also affects isolated builds and it should.
|
||
|
|
|
||
|
|
if options.no_input:
|
||
|
|
os.environ['PIP_NO_INPUT'] = '1'
|
||
|
|
|
||
|
|
if options.exists_action:
|
||
|
|
os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action)
|
||
|
|
|
||
|
|
if options.require_venv and not self.ignore_require_venv:
|
||
|
|
# If a venv is required check if it can really be found
|
||
|
|
if not running_under_virtualenv():
|
||
|
|
logger.critical(
|
||
|
|
'Could not find an activated virtualenv (required).'
|
||
|
|
)
|
||
|
|
sys.exit(VIRTUALENV_NOT_FOUND)
|
||
|
|
|
||
|
|
try:
|
||
|
|
status = self.run(options, args)
|
||
|
|
# FIXME: all commands should return an exit status
|
||
|
|
# and when it is done, isinstance is not needed anymore
|
||
|
|
if isinstance(status, int):
|
||
|
|
return status
|
||
|
|
except PreviousBuildDirError as exc:
|
||
|
|
logger.critical(str(exc))
|
||
|
|
logger.debug('Exception information:', exc_info=True)
|
||
|
|
|
||
|
|
return PREVIOUS_BUILD_DIR_ERROR
|
||
|
|
except (InstallationError, UninstallationError, BadCommand) as exc:
|
||
|
|
logger.critical(str(exc))
|
||
|
|
logger.debug('Exception information:', exc_info=True)
|
||
|
|
|
||
|
|
return ERROR
|
||
|
|
except CommandError as exc:
|
||
|
|
logger.critical('%s', exc)
|
||
|
|
logger.debug('Exception information:', exc_info=True)
|
||
|
|
|
||
|
|
return ERROR
|
||
|
|
except BrokenStdoutLoggingError:
|
||
|
|
# Bypass our logger and write any remaining messages to stderr
|
||
|
|
# because stdout no longer works.
|
||
|
|
print('ERROR: Pipe to stdout was broken', file=sys.stderr)
|
||
|
|
if level_number <= logging.DEBUG:
|
||
|
|
traceback.print_exc(file=sys.stderr)
|
||
|
|
|
||
|
|
return ERROR
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
logger.critical('Operation cancelled by user')
|
||
|
|
logger.debug('Exception information:', exc_info=True)
|
||
|
|
|
||
|
|
return ERROR
|
||
|
|
except BaseException:
|
||
|
|
logger.critical('Exception:', exc_info=True)
|
||
|
|
|
||
|
|
return UNKNOWN_ERROR
|
||
|
|
finally:
|
||
|
|
allow_version_check = (
|
||
|
|
# Does this command have the index_group options?
|
||
|
|
hasattr(options, "no_index") and
|
||
|
|
# Is this command allowed to perform this check?
|
||
|
|
not (options.disable_pip_version_check or options.no_index)
|
||
|
|
)
|
||
|
|
# Check if we're using the latest version of pip available
|
||
|
|
if allow_version_check:
|
||
|
|
session = self._build_session(
|
||
|
|
options,
|
||
|
|
retries=0,
|
||
|
|
timeout=min(5, options.timeout)
|
||
|
|
)
|
||
|
|
with session:
|
||
|
|
pip_version_check(session, options)
|
||
|
|
|
||
|
|
# Shutdown the logging module
|
||
|
|
logging.shutdown()
|
||
|
|
|
||
|
|
return SUCCESS
|
||
|
|
|
||
|
|
|
||
|
|
class RequirementCommand(Command):
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def populate_requirement_set(requirement_set, # type: RequirementSet
|
||
|
|
args, # type: List[str]
|
||
|
|
options, # type: Values
|
||
|
|
finder, # type: PackageFinder
|
||
|
|
session, # type: PipSession
|
||
|
|
name, # type: str
|
||
|
|
wheel_cache # type: Optional[WheelCache]
|
||
|
|
):
|
||
|
|
# type: (...) -> None
|
||
|
|
"""
|
||
|
|
Marshal cmd line args into a requirement set.
|
||
|
|
"""
|
||
|
|
# NOTE: As a side-effect, options.require_hashes and
|
||
|
|
# requirement_set.require_hashes may be updated
|
||
|
|
|
||
|
|
for filename in options.constraints:
|
||
|
|
for req_to_add in parse_requirements(
|
||
|
|
filename,
|
||
|
|
constraint=True, finder=finder, options=options,
|
||
|
|
session=session, wheel_cache=wheel_cache):
|
||
|
|
req_to_add.is_direct = True
|
||
|
|
requirement_set.add_requirement(req_to_add)
|
||
|
|
|
||
|
|
for req in args:
|
||
|
|
req_to_add = install_req_from_line(
|
||
|
|
req, None, isolated=options.isolated_mode,
|
||
|
|
use_pep517=options.use_pep517,
|
||
|
|
wheel_cache=wheel_cache
|
||
|
|
)
|
||
|
|
req_to_add.is_direct = True
|
||
|
|
requirement_set.add_requirement(req_to_add)
|
||
|
|
|
||
|
|
for req in options.editables:
|
||
|
|
req_to_add = install_req_from_editable(
|
||
|
|
req,
|
||
|
|
isolated=options.isolated_mode,
|
||
|
|
use_pep517=options.use_pep517,
|
||
|
|
wheel_cache=wheel_cache
|
||
|
|
)
|
||
|
|
req_to_add.is_direct = True
|
||
|
|
requirement_set.add_requirement(req_to_add)
|
||
|
|
|
||
|
|
for filename in options.requirements:
|
||
|
|
for req_to_add in parse_requirements(
|
||
|
|
filename,
|
||
|
|
finder=finder, options=options, session=session,
|
||
|
|
wheel_cache=wheel_cache,
|
||
|
|
use_pep517=options.use_pep517):
|
||
|
|
req_to_add.is_direct = True
|
||
|
|
requirement_set.add_requirement(req_to_add)
|
||
|
|
# If --require-hashes was a line in a requirements file, tell
|
||
|
|
# RequirementSet about it:
|
||
|
|
requirement_set.require_hashes = options.require_hashes
|
||
|
|
|
||
|
|
if not (args or options.editables or options.requirements):
|
||
|
|
opts = {'name': 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)))
|
||
|
|
else:
|
||
|
|
raise CommandError(
|
||
|
|
'You must give at least one requirement to %(name)s '
|
||
|
|
'(see "pip help %(name)s")' % opts)
|
||
|
|
|
||
|
|
def _build_package_finder(
|
||
|
|
self,
|
||
|
|
options, # type: Values
|
||
|
|
session, # type: PipSession
|
||
|
|
target_python=None, # type: Optional[TargetPython]
|
||
|
|
ignore_requires_python=None, # type: Optional[bool]
|
||
|
|
):
|
||
|
|
# type: (...) -> PackageFinder
|
||
|
|
"""
|
||
|
|
Create a package finder appropriate to this requirement command.
|
||
|
|
|
||
|
|
:param ignore_requires_python: Whether to ignore incompatible
|
||
|
|
"Requires-Python" values in links. Defaults to False.
|
||
|
|
"""
|
||
|
|
search_scope = make_search_scope(options)
|
||
|
|
selection_prefs = SelectionPreferences(
|
||
|
|
allow_yanked=True,
|
||
|
|
format_control=options.format_control,
|
||
|
|
allow_all_prereleases=options.pre,
|
||
|
|
prefer_binary=options.prefer_binary,
|
||
|
|
ignore_requires_python=ignore_requires_python,
|
||
|
|
)
|
||
|
|
|
||
|
|
return PackageFinder.create(
|
||
|
|
search_scope=search_scope,
|
||
|
|
selection_prefs=selection_prefs,
|
||
|
|
trusted_hosts=options.trusted_hosts,
|
||
|
|
session=session,
|
||
|
|
target_python=target_python,
|
||
|
|
)
|