index.py 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. from __future__ import annotations
  2. import json
  3. import logging
  4. from collections.abc import Iterable
  5. from optparse import Values
  6. from typing import Any, Callable
  7. from pip._vendor.packaging.version import Version
  8. from pip._internal.cli import cmdoptions
  9. from pip._internal.cli.req_command import IndexGroupCommand
  10. from pip._internal.cli.status_codes import ERROR, SUCCESS
  11. from pip._internal.commands.search import (
  12. get_installed_distribution,
  13. print_dist_installation_info,
  14. )
  15. from pip._internal.exceptions import CommandError, DistributionNotFound, PipError
  16. from pip._internal.index.collector import LinkCollector
  17. from pip._internal.index.package_finder import PackageFinder
  18. from pip._internal.models.selection_prefs import SelectionPreferences
  19. from pip._internal.models.target_python import TargetPython
  20. from pip._internal.network.session import PipSession
  21. from pip._internal.utils.misc import write_output
  22. logger = logging.getLogger(__name__)
  23. class IndexCommand(IndexGroupCommand):
  24. """
  25. Inspect information available from package indexes.
  26. """
  27. ignore_require_venv = True
  28. usage = """
  29. %prog versions <package>
  30. """
  31. def add_options(self) -> None:
  32. cmdoptions.add_target_python_options(self.cmd_opts)
  33. self.cmd_opts.add_option(cmdoptions.ignore_requires_python())
  34. self.cmd_opts.add_option(cmdoptions.pre())
  35. self.cmd_opts.add_option(cmdoptions.json())
  36. self.cmd_opts.add_option(cmdoptions.no_binary())
  37. self.cmd_opts.add_option(cmdoptions.only_binary())
  38. index_opts = cmdoptions.make_option_group(
  39. cmdoptions.index_group,
  40. self.parser,
  41. )
  42. self.parser.insert_option_group(0, index_opts)
  43. self.parser.insert_option_group(0, self.cmd_opts)
  44. def handler_map(self) -> dict[str, Callable[[Values, list[str]], None]]:
  45. return {
  46. "versions": self.get_available_package_versions,
  47. }
  48. def run(self, options: Values, args: list[str]) -> int:
  49. handler_map = self.handler_map()
  50. # Determine action
  51. if not args or args[0] not in handler_map:
  52. logger.error(
  53. "Need an action (%s) to perform.",
  54. ", ".join(sorted(handler_map)),
  55. )
  56. return ERROR
  57. action = args[0]
  58. # Error handling happens here, not in the action-handlers.
  59. try:
  60. handler_map[action](options, args[1:])
  61. except PipError as e:
  62. logger.error(e.args[0])
  63. return ERROR
  64. return SUCCESS
  65. def _build_package_finder(
  66. self,
  67. options: Values,
  68. session: PipSession,
  69. target_python: TargetPython | None = None,
  70. ignore_requires_python: bool | None = None,
  71. ) -> PackageFinder:
  72. """
  73. Create a package finder appropriate to the index command.
  74. """
  75. link_collector = LinkCollector.create(session, options=options)
  76. # Pass allow_yanked=False to ignore yanked versions.
  77. selection_prefs = SelectionPreferences(
  78. allow_yanked=False,
  79. allow_all_prereleases=options.pre,
  80. ignore_requires_python=ignore_requires_python,
  81. )
  82. return PackageFinder.create(
  83. link_collector=link_collector,
  84. selection_prefs=selection_prefs,
  85. target_python=target_python,
  86. )
  87. def get_available_package_versions(self, options: Values, args: list[Any]) -> None:
  88. if len(args) != 1:
  89. raise CommandError("You need to specify exactly one argument")
  90. target_python = cmdoptions.make_target_python(options)
  91. query = args[0]
  92. with self._build_session(options) as session:
  93. finder = self._build_package_finder(
  94. options=options,
  95. session=session,
  96. target_python=target_python,
  97. ignore_requires_python=options.ignore_requires_python,
  98. )
  99. versions: Iterable[Version] = (
  100. candidate.version for candidate in finder.find_all_candidates(query)
  101. )
  102. if not options.pre:
  103. # Remove prereleases
  104. versions = (
  105. version for version in versions if not version.is_prerelease
  106. )
  107. versions = set(versions)
  108. if not versions:
  109. raise DistributionNotFound(
  110. f"No matching distribution found for {query}"
  111. )
  112. formatted_versions = [str(ver) for ver in sorted(versions, reverse=True)]
  113. latest = formatted_versions[0]
  114. dist = get_installed_distribution(query)
  115. if options.json:
  116. structured_output = {
  117. "name": query,
  118. "versions": formatted_versions,
  119. "latest": latest,
  120. }
  121. if dist is not None:
  122. structured_output["installed_version"] = str(dist.version)
  123. write_output(json.dumps(structured_output))
  124. else:
  125. write_output(f"{query} ({latest})")
  126. write_output("Available versions: {}".format(", ".join(formatted_versions)))
  127. print_dist_installation_info(latest, dist)