wheel.py 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. import logging
  2. import os
  3. import shutil
  4. from optparse import Values
  5. from typing import List
  6. from pip._internal.cache import WheelCache
  7. from pip._internal.cli import cmdoptions
  8. from pip._internal.cli.req_command import RequirementCommand, with_cleanup
  9. from pip._internal.cli.status_codes import SUCCESS
  10. from pip._internal.exceptions import CommandError
  11. from pip._internal.operations.build.build_tracker import get_build_tracker
  12. from pip._internal.req.req_install import InstallRequirement
  13. from pip._internal.utils.misc import ensure_dir, normalize_path
  14. from pip._internal.utils.temp_dir import TempDirectory
  15. from pip._internal.wheel_builder import build, should_build_for_wheel_command
  16. logger = logging.getLogger(__name__)
  17. class WheelCommand(RequirementCommand):
  18. """
  19. Build Wheel archives for your requirements and dependencies.
  20. Wheel is a built-package format, and offers the advantage of not
  21. recompiling your software during every install. For more details, see the
  22. wheel docs: https://wheel.readthedocs.io/en/latest/
  23. 'pip wheel' uses the build system interface as described here:
  24. https://pip.pypa.io/en/stable/reference/build-system/
  25. """
  26. usage = """
  27. %prog [options] <requirement specifier> ...
  28. %prog [options] -r <requirements file> ...
  29. %prog [options] [-e] <vcs project url> ...
  30. %prog [options] [-e] <local project path> ...
  31. %prog [options] <archive url/path> ..."""
  32. def add_options(self) -> None:
  33. self.cmd_opts.add_option(
  34. "-w",
  35. "--wheel-dir",
  36. dest="wheel_dir",
  37. metavar="dir",
  38. default=os.curdir,
  39. help=(
  40. "Build wheels into <dir>, where the default is the "
  41. "current working directory."
  42. ),
  43. )
  44. self.cmd_opts.add_option(cmdoptions.no_binary())
  45. self.cmd_opts.add_option(cmdoptions.only_binary())
  46. self.cmd_opts.add_option(cmdoptions.prefer_binary())
  47. self.cmd_opts.add_option(cmdoptions.no_build_isolation())
  48. self.cmd_opts.add_option(cmdoptions.use_pep517())
  49. self.cmd_opts.add_option(cmdoptions.no_use_pep517())
  50. self.cmd_opts.add_option(cmdoptions.check_build_deps())
  51. self.cmd_opts.add_option(cmdoptions.constraints())
  52. self.cmd_opts.add_option(cmdoptions.editable())
  53. self.cmd_opts.add_option(cmdoptions.requirements())
  54. self.cmd_opts.add_option(cmdoptions.src())
  55. self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
  56. self.cmd_opts.add_option(cmdoptions.no_deps())
  57. self.cmd_opts.add_option(cmdoptions.progress_bar())
  58. self.cmd_opts.add_option(
  59. "--no-verify",
  60. dest="no_verify",
  61. action="store_true",
  62. default=False,
  63. help="Don't verify if built wheel is valid.",
  64. )
  65. self.cmd_opts.add_option(cmdoptions.config_settings())
  66. self.cmd_opts.add_option(cmdoptions.build_options())
  67. self.cmd_opts.add_option(cmdoptions.global_options())
  68. self.cmd_opts.add_option(
  69. "--pre",
  70. action="store_true",
  71. default=False,
  72. help=(
  73. "Include pre-release and development versions. By default, "
  74. "pip only finds stable versions."
  75. ),
  76. )
  77. self.cmd_opts.add_option(cmdoptions.require_hashes())
  78. index_opts = cmdoptions.make_option_group(
  79. cmdoptions.index_group,
  80. self.parser,
  81. )
  82. self.parser.insert_option_group(0, index_opts)
  83. self.parser.insert_option_group(0, self.cmd_opts)
  84. @with_cleanup
  85. def run(self, options: Values, args: List[str]) -> int:
  86. cmdoptions.check_install_build_global(options)
  87. session = self.get_default_session(options)
  88. finder = self._build_package_finder(options, session)
  89. wheel_cache = WheelCache(options.cache_dir, options.format_control)
  90. options.wheel_dir = normalize_path(options.wheel_dir)
  91. ensure_dir(options.wheel_dir)
  92. build_tracker = self.enter_context(get_build_tracker())
  93. directory = TempDirectory(
  94. delete=not options.no_clean,
  95. kind="wheel",
  96. globally_managed=True,
  97. )
  98. reqs = self.get_requirements(args, options, finder, session)
  99. preparer = self.make_requirement_preparer(
  100. temp_build_dir=directory,
  101. options=options,
  102. build_tracker=build_tracker,
  103. session=session,
  104. finder=finder,
  105. download_dir=options.wheel_dir,
  106. use_user_site=False,
  107. verbosity=self.verbosity,
  108. )
  109. resolver = self.make_resolver(
  110. preparer=preparer,
  111. finder=finder,
  112. options=options,
  113. wheel_cache=wheel_cache,
  114. ignore_requires_python=options.ignore_requires_python,
  115. use_pep517=options.use_pep517,
  116. )
  117. self.trace_basic_info(finder)
  118. requirement_set = resolver.resolve(reqs, check_supported_wheels=True)
  119. reqs_to_build: List[InstallRequirement] = []
  120. for req in requirement_set.requirements.values():
  121. if req.is_wheel:
  122. preparer.save_linked_requirement(req)
  123. elif should_build_for_wheel_command(req):
  124. reqs_to_build.append(req)
  125. # build wheels
  126. build_successes, build_failures = build(
  127. reqs_to_build,
  128. wheel_cache=wheel_cache,
  129. verify=(not options.no_verify),
  130. build_options=options.build_options or [],
  131. global_options=options.global_options or [],
  132. )
  133. for req in build_successes:
  134. assert req.link and req.link.is_wheel
  135. assert req.local_file_path
  136. # copy from cache to target directory
  137. try:
  138. shutil.copy(req.local_file_path, options.wheel_dir)
  139. except OSError as e:
  140. logger.warning(
  141. "Building wheel for %s failed: %s",
  142. req.name,
  143. e,
  144. )
  145. build_failures.append(req)
  146. if len(build_failures) != 0:
  147. raise CommandError("Failed to build one or more wheels")
  148. return SUCCESS