wheel.py 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  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_build_isolation())
  46. self.cmd_opts.add_option(cmdoptions.use_pep517())
  47. self.cmd_opts.add_option(cmdoptions.check_build_deps())
  48. self.cmd_opts.add_option(cmdoptions.constraints())
  49. self.cmd_opts.add_option(cmdoptions.build_constraints())
  50. self.cmd_opts.add_option(cmdoptions.editable())
  51. self.cmd_opts.add_option(cmdoptions.requirements())
  52. self.cmd_opts.add_option(cmdoptions.requirements_from_scripts())
  53. self.cmd_opts.add_option(cmdoptions.src())
  54. self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
  55. self.cmd_opts.add_option(cmdoptions.no_deps())
  56. self.cmd_opts.add_option(cmdoptions.progress_bar())
  57. self.cmd_opts.add_option(
  58. "--no-verify",
  59. dest="no_verify",
  60. action="store_true",
  61. default=False,
  62. help="Don't verify if built wheel is valid.",
  63. )
  64. self.cmd_opts.add_option(cmdoptions.config_settings())
  65. self.cmd_opts.add_option(cmdoptions.require_hashes())
  66. index_opts = cmdoptions.make_option_group(
  67. cmdoptions.index_group,
  68. self.parser,
  69. )
  70. selection_opts = cmdoptions.make_option_group(
  71. cmdoptions.package_selection_group,
  72. self.parser,
  73. )
  74. self.parser.insert_option_group(0, index_opts)
  75. self.parser.insert_option_group(0, selection_opts)
  76. self.parser.insert_option_group(0, self.cmd_opts)
  77. @with_cleanup
  78. def run(self, options: Values, args: list[str]) -> int:
  79. cmdoptions.check_build_constraints(options)
  80. cmdoptions.check_release_control_exclusive(options)
  81. session = self.get_default_session(options)
  82. finder = self._build_package_finder(options, session)
  83. options.wheel_dir = normalize_path(options.wheel_dir)
  84. ensure_dir(options.wheel_dir)
  85. build_tracker = self.enter_context(get_build_tracker())
  86. directory = TempDirectory(
  87. delete=not options.no_clean,
  88. kind="wheel",
  89. globally_managed=True,
  90. )
  91. reqs = self.get_requirements(args, options, finder, session)
  92. wheel_cache = WheelCache(options.cache_dir)
  93. preparer = self.make_requirement_preparer(
  94. temp_build_dir=directory,
  95. options=options,
  96. build_tracker=build_tracker,
  97. session=session,
  98. finder=finder,
  99. download_dir=options.wheel_dir,
  100. use_user_site=False,
  101. verbosity=self.verbosity,
  102. )
  103. resolver = self.make_resolver(
  104. preparer=preparer,
  105. finder=finder,
  106. options=options,
  107. wheel_cache=wheel_cache,
  108. ignore_requires_python=options.ignore_requires_python,
  109. )
  110. self.trace_basic_info(finder)
  111. requirement_set = resolver.resolve(reqs, check_supported_wheels=True)
  112. preparer.prepare_linked_requirements_more(requirement_set.requirements.values())
  113. reqs_to_build: list[InstallRequirement] = []
  114. for req in requirement_set.requirements.values():
  115. if req.is_wheel:
  116. preparer.save_linked_requirement(req)
  117. else:
  118. reqs_to_build.append(req)
  119. # build wheels
  120. build_successes, build_failures = build(
  121. reqs_to_build,
  122. wheel_cache=wheel_cache,
  123. verify=(not options.no_verify),
  124. )
  125. for req in build_successes:
  126. assert req.link and req.link.is_wheel
  127. assert req.local_file_path
  128. # copy from cache to target directory
  129. try:
  130. shutil.copy(req.local_file_path, options.wheel_dir)
  131. except OSError as e:
  132. logger.warning(
  133. "Building wheel for %s failed: %s",
  134. req.name,
  135. e,
  136. )
  137. build_failures.append(req)
  138. if len(build_failures) != 0:
  139. raise CommandError("Failed to build one or more wheels")
  140. return SUCCESS