req_set.py 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. import logging
  2. from collections import OrderedDict
  3. from pip._vendor.packaging.utils import canonicalize_name
  4. from pip._internal.req.req_install import InstallRequirement
  5. logger = logging.getLogger(__name__)
  6. class RequirementSet:
  7. def __init__(self, check_supported_wheels: bool = True) -> None:
  8. """Create a RequirementSet."""
  9. self.requirements: dict[str, InstallRequirement] = OrderedDict()
  10. self.check_supported_wheels = check_supported_wheels
  11. self.unnamed_requirements: list[InstallRequirement] = []
  12. def __str__(self) -> str:
  13. requirements = sorted(
  14. (req for req in self.requirements.values() if not req.comes_from),
  15. key=lambda req: canonicalize_name(req.name or ""),
  16. )
  17. return " ".join(str(req.req) for req in requirements)
  18. def __repr__(self) -> str:
  19. requirements = sorted(
  20. self.requirements.values(),
  21. key=lambda req: canonicalize_name(req.name or ""),
  22. )
  23. format_string = "<{classname} object; {count} requirement(s): {reqs}>"
  24. return format_string.format(
  25. classname=self.__class__.__name__,
  26. count=len(requirements),
  27. reqs=", ".join(str(req.req) for req in requirements),
  28. )
  29. def add_unnamed_requirement(self, install_req: InstallRequirement) -> None:
  30. assert not install_req.name
  31. self.unnamed_requirements.append(install_req)
  32. def add_named_requirement(self, install_req: InstallRequirement) -> None:
  33. assert install_req.name
  34. project_name = canonicalize_name(install_req.name)
  35. self.requirements[project_name] = install_req
  36. def has_requirement(self, name: str) -> bool:
  37. project_name = canonicalize_name(name)
  38. return (
  39. project_name in self.requirements
  40. and not self.requirements[project_name].constraint
  41. )
  42. def get_requirement(self, name: str) -> InstallRequirement:
  43. project_name = canonicalize_name(name)
  44. if project_name in self.requirements:
  45. return self.requirements[project_name]
  46. raise KeyError(f"No project with the name {name!r}")
  47. @property
  48. def all_requirements(self) -> list[InstallRequirement]:
  49. return self.unnamed_requirements + list(self.requirements.values())
  50. @property
  51. def requirements_to_install(self) -> list[InstallRequirement]:
  52. """Return the list of requirements that need to be installed.
  53. TODO remove this property together with the legacy resolver, since the new
  54. resolver only returns requirements that need to be installed.
  55. """
  56. return [
  57. install_req
  58. for install_req in self.all_requirements
  59. if not install_req.constraint and not install_req.satisfied_by
  60. ]