download.py 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. import logging
  2. import os
  3. from optparse import Values
  4. from pip._internal.cli import cmdoptions
  5. from pip._internal.cli.cmdoptions import make_target_python
  6. from pip._internal.cli.req_command import RequirementCommand, with_cleanup
  7. from pip._internal.cli.status_codes import SUCCESS
  8. from pip._internal.operations.build.build_tracker import get_build_tracker
  9. from pip._internal.req.req_install import check_legacy_setup_py_options
  10. from pip._internal.utils.misc import ensure_dir, normalize_path, write_output
  11. from pip._internal.utils.temp_dir import TempDirectory
  12. logger = logging.getLogger(__name__)
  13. class DownloadCommand(RequirementCommand):
  14. """
  15. Download packages from:
  16. - PyPI (and other indexes) using requirement specifiers.
  17. - VCS project urls.
  18. - Local project directories.
  19. - Local or remote source archives.
  20. pip also supports downloading from "requirements files", which provide
  21. an easy way to specify a whole environment to be downloaded.
  22. """
  23. usage = """
  24. %prog [options] <requirement specifier> [package-index-options] ...
  25. %prog [options] -r <requirements file> [package-index-options] ...
  26. %prog [options] <vcs project url> ...
  27. %prog [options] <local project path> ...
  28. %prog [options] <archive url/path> ..."""
  29. def add_options(self) -> None:
  30. self.cmd_opts.add_option(cmdoptions.constraints())
  31. self.cmd_opts.add_option(cmdoptions.requirements())
  32. self.cmd_opts.add_option(cmdoptions.no_deps())
  33. self.cmd_opts.add_option(cmdoptions.global_options())
  34. self.cmd_opts.add_option(cmdoptions.no_binary())
  35. self.cmd_opts.add_option(cmdoptions.only_binary())
  36. self.cmd_opts.add_option(cmdoptions.prefer_binary())
  37. self.cmd_opts.add_option(cmdoptions.src())
  38. self.cmd_opts.add_option(cmdoptions.pre())
  39. self.cmd_opts.add_option(cmdoptions.require_hashes())
  40. self.cmd_opts.add_option(cmdoptions.progress_bar())
  41. self.cmd_opts.add_option(cmdoptions.no_build_isolation())
  42. self.cmd_opts.add_option(cmdoptions.use_pep517())
  43. self.cmd_opts.add_option(cmdoptions.no_use_pep517())
  44. self.cmd_opts.add_option(cmdoptions.check_build_deps())
  45. self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
  46. self.cmd_opts.add_option(
  47. "-d",
  48. "--dest",
  49. "--destination-dir",
  50. "--destination-directory",
  51. dest="download_dir",
  52. metavar="dir",
  53. default=os.curdir,
  54. help="Download packages into <dir>.",
  55. )
  56. cmdoptions.add_target_python_options(self.cmd_opts)
  57. index_opts = cmdoptions.make_option_group(
  58. cmdoptions.index_group,
  59. self.parser,
  60. )
  61. self.parser.insert_option_group(0, index_opts)
  62. self.parser.insert_option_group(0, self.cmd_opts)
  63. @with_cleanup
  64. def run(self, options: Values, args: list[str]) -> int:
  65. options.ignore_installed = True
  66. # editable doesn't really make sense for `pip download`, but the bowels
  67. # of the RequirementSet code require that property.
  68. options.editables = []
  69. cmdoptions.check_dist_restriction(options)
  70. options.download_dir = normalize_path(options.download_dir)
  71. ensure_dir(options.download_dir)
  72. session = self.get_default_session(options)
  73. target_python = make_target_python(options)
  74. finder = self._build_package_finder(
  75. options=options,
  76. session=session,
  77. target_python=target_python,
  78. ignore_requires_python=options.ignore_requires_python,
  79. )
  80. build_tracker = self.enter_context(get_build_tracker())
  81. directory = TempDirectory(
  82. delete=not options.no_clean,
  83. kind="download",
  84. globally_managed=True,
  85. )
  86. reqs = self.get_requirements(args, options, finder, session)
  87. check_legacy_setup_py_options(options, reqs)
  88. preparer = self.make_requirement_preparer(
  89. temp_build_dir=directory,
  90. options=options,
  91. build_tracker=build_tracker,
  92. session=session,
  93. finder=finder,
  94. download_dir=options.download_dir,
  95. use_user_site=False,
  96. verbosity=self.verbosity,
  97. )
  98. resolver = self.make_resolver(
  99. preparer=preparer,
  100. finder=finder,
  101. options=options,
  102. ignore_requires_python=options.ignore_requires_python,
  103. use_pep517=options.use_pep517,
  104. py_version_info=options.python_version,
  105. )
  106. self.trace_basic_info(finder)
  107. requirement_set = resolver.resolve(reqs, check_supported_wheels=True)
  108. downloaded: list[str] = []
  109. for req in requirement_set.requirements.values():
  110. if req.satisfied_by is None:
  111. assert req.name is not None
  112. preparer.save_linked_requirement(req)
  113. downloaded.append(req.name)
  114. preparer.prepare_linked_requirements_more(requirement_set.requirements.values())
  115. if downloaded:
  116. write_output("Successfully downloaded %s", " ".join(downloaded))
  117. return SUCCESS