wheel.py 5.9 KB

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