wheel.py 6.1 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.req.req_install import InstallRequirement
  12. from pip._internal.req.req_tracker import get_requirement_tracker
  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. Requirements: setuptools>=0.8, and wheel.
  24. 'pip wheel' uses the bdist_wheel setuptools extension from the wheel
  25. package to build individual wheels.
  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):
  34. # type: () -> None
  35. self.cmd_opts.add_option(
  36. '-w', '--wheel-dir',
  37. dest='wheel_dir',
  38. metavar='dir',
  39. default=os.curdir,
  40. help=("Build wheels into <dir>, where the default is the "
  41. "current working directory."),
  42. )
  43. self.cmd_opts.add_option(cmdoptions.no_binary())
  44. self.cmd_opts.add_option(cmdoptions.only_binary())
  45. self.cmd_opts.add_option(cmdoptions.prefer_binary())
  46. self.cmd_opts.add_option(cmdoptions.no_build_isolation())
  47. self.cmd_opts.add_option(cmdoptions.use_pep517())
  48. self.cmd_opts.add_option(cmdoptions.no_use_pep517())
  49. self.cmd_opts.add_option(cmdoptions.constraints())
  50. self.cmd_opts.add_option(cmdoptions.editable())
  51. self.cmd_opts.add_option(cmdoptions.requirements())
  52. self.cmd_opts.add_option(cmdoptions.src())
  53. self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
  54. self.cmd_opts.add_option(cmdoptions.no_deps())
  55. self.cmd_opts.add_option(cmdoptions.build_dir())
  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.build_options())
  65. self.cmd_opts.add_option(cmdoptions.global_options())
  66. self.cmd_opts.add_option(
  67. '--pre',
  68. action='store_true',
  69. default=False,
  70. help=("Include pre-release and development versions. By default, "
  71. "pip only finds stable versions."),
  72. )
  73. self.cmd_opts.add_option(cmdoptions.require_hashes())
  74. index_opts = cmdoptions.make_option_group(
  75. cmdoptions.index_group,
  76. self.parser,
  77. )
  78. self.parser.insert_option_group(0, index_opts)
  79. self.parser.insert_option_group(0, self.cmd_opts)
  80. @with_cleanup
  81. def run(self, options, args):
  82. # type: (Values, List[str]) -> int
  83. cmdoptions.check_install_build_global(options)
  84. session = self.get_default_session(options)
  85. finder = self._build_package_finder(options, session)
  86. wheel_cache = WheelCache(options.cache_dir, options.format_control)
  87. options.wheel_dir = normalize_path(options.wheel_dir)
  88. ensure_dir(options.wheel_dir)
  89. req_tracker = self.enter_context(get_requirement_tracker())
  90. directory = TempDirectory(
  91. delete=not options.no_clean,
  92. kind="wheel",
  93. globally_managed=True,
  94. )
  95. reqs = self.get_requirements(args, options, finder, session)
  96. preparer = self.make_requirement_preparer(
  97. temp_build_dir=directory,
  98. options=options,
  99. req_tracker=req_tracker,
  100. session=session,
  101. finder=finder,
  102. download_dir=options.wheel_dir,
  103. use_user_site=False,
  104. )
  105. resolver = self.make_resolver(
  106. preparer=preparer,
  107. finder=finder,
  108. options=options,
  109. wheel_cache=wheel_cache,
  110. ignore_requires_python=options.ignore_requires_python,
  111. use_pep517=options.use_pep517,
  112. )
  113. self.trace_basic_info(finder)
  114. requirement_set = resolver.resolve(
  115. reqs, check_supported_wheels=True
  116. )
  117. reqs_to_build = [] # type: List[InstallRequirement]
  118. for req in requirement_set.requirements.values():
  119. if req.is_wheel:
  120. preparer.save_linked_requirement(req)
  121. elif should_build_for_wheel_command(req):
  122. reqs_to_build.append(req)
  123. # build wheels
  124. build_successes, build_failures = build(
  125. reqs_to_build,
  126. wheel_cache=wheel_cache,
  127. verify=(not options.no_verify),
  128. build_options=options.build_options or [],
  129. global_options=options.global_options or [],
  130. )
  131. for req in build_successes:
  132. assert req.link and req.link.is_wheel
  133. assert req.local_file_path
  134. # copy from cache to target directory
  135. try:
  136. shutil.copy(req.local_file_path, options.wheel_dir)
  137. except OSError as e:
  138. logger.warning(
  139. "Building wheel for %s failed: %s",
  140. req.name, e,
  141. )
  142. build_failures.append(req)
  143. if len(build_failures) != 0:
  144. raise CommandError(
  145. "Failed to build one or more wheels"
  146. )
  147. return SUCCESS