wheel.py 6.2 KB

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