requirements.py 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. # This file is dual licensed under the terms of the Apache License, Version
  2. # 2.0, and the BSD License. See the LICENSE file in the root of this repository
  3. # for complete details.
  4. from __future__ import absolute_import, division, print_function
  5. import string
  6. import re
  7. from setuptools.extern.pyparsing import stringStart, stringEnd, originalTextFor, ParseException
  8. from setuptools.extern.pyparsing import ZeroOrMore, Word, Optional, Regex, Combine
  9. from setuptools.extern.pyparsing import Literal as L # noqa
  10. from setuptools.extern.six.moves.urllib import parse as urlparse
  11. from .markers import MARKER_EXPR, Marker
  12. from .specifiers import LegacySpecifier, Specifier, SpecifierSet
  13. class InvalidRequirement(ValueError):
  14. """
  15. An invalid requirement was found, users should refer to PEP 508.
  16. """
  17. ALPHANUM = Word(string.ascii_letters + string.digits)
  18. LBRACKET = L("[").suppress()
  19. RBRACKET = L("]").suppress()
  20. LPAREN = L("(").suppress()
  21. RPAREN = L(")").suppress()
  22. COMMA = L(",").suppress()
  23. SEMICOLON = L(";").suppress()
  24. AT = L("@").suppress()
  25. PUNCTUATION = Word("-_.")
  26. IDENTIFIER_END = ALPHANUM | (ZeroOrMore(PUNCTUATION) + ALPHANUM)
  27. IDENTIFIER = Combine(ALPHANUM + ZeroOrMore(IDENTIFIER_END))
  28. NAME = IDENTIFIER("name")
  29. EXTRA = IDENTIFIER
  30. URI = Regex(r"[^ ]+")("url")
  31. URL = AT + URI
  32. EXTRAS_LIST = EXTRA + ZeroOrMore(COMMA + EXTRA)
  33. EXTRAS = (LBRACKET + Optional(EXTRAS_LIST) + RBRACKET)("extras")
  34. VERSION_PEP440 = Regex(Specifier._regex_str, re.VERBOSE | re.IGNORECASE)
  35. VERSION_LEGACY = Regex(LegacySpecifier._regex_str, re.VERBOSE | re.IGNORECASE)
  36. VERSION_ONE = VERSION_PEP440 ^ VERSION_LEGACY
  37. VERSION_MANY = Combine(
  38. VERSION_ONE + ZeroOrMore(COMMA + VERSION_ONE), joinString=",", adjacent=False
  39. )("_raw_spec")
  40. _VERSION_SPEC = Optional(((LPAREN + VERSION_MANY + RPAREN) | VERSION_MANY))
  41. _VERSION_SPEC.setParseAction(lambda s, l, t: t._raw_spec or "")
  42. VERSION_SPEC = originalTextFor(_VERSION_SPEC)("specifier")
  43. VERSION_SPEC.setParseAction(lambda s, l, t: t[1])
  44. MARKER_EXPR = originalTextFor(MARKER_EXPR())("marker")
  45. MARKER_EXPR.setParseAction(
  46. lambda s, l, t: Marker(s[t._original_start : t._original_end])
  47. )
  48. MARKER_SEPARATOR = SEMICOLON
  49. MARKER = MARKER_SEPARATOR + MARKER_EXPR
  50. VERSION_AND_MARKER = VERSION_SPEC + Optional(MARKER)
  51. URL_AND_MARKER = URL + Optional(MARKER)
  52. NAMED_REQUIREMENT = NAME + Optional(EXTRAS) + (URL_AND_MARKER | VERSION_AND_MARKER)
  53. REQUIREMENT = stringStart + NAMED_REQUIREMENT + stringEnd
  54. # setuptools.extern.pyparsing isn't thread safe during initialization, so we do it eagerly, see
  55. # issue #104
  56. REQUIREMENT.parseString("x[]")
  57. class Requirement(object):
  58. """Parse a requirement.
  59. Parse a given requirement string into its parts, such as name, specifier,
  60. URL, and extras. Raises InvalidRequirement on a badly-formed requirement
  61. string.
  62. """
  63. # TODO: Can we test whether something is contained within a requirement?
  64. # If so how do we do that? Do we need to test against the _name_ of
  65. # the thing as well as the version? What about the markers?
  66. # TODO: Can we normalize the name and extra name?
  67. def __init__(self, requirement_string):
  68. try:
  69. req = REQUIREMENT.parseString(requirement_string)
  70. except ParseException as e:
  71. raise InvalidRequirement(
  72. 'Parse error at "{0!r}": {1}'.format(
  73. requirement_string[e.loc : e.loc + 8], e.msg
  74. )
  75. )
  76. self.name = req.name
  77. if req.url:
  78. parsed_url = urlparse.urlparse(req.url)
  79. if parsed_url.scheme == "file":
  80. if urlparse.urlunparse(parsed_url) != req.url:
  81. raise InvalidRequirement("Invalid URL given")
  82. elif not (parsed_url.scheme and parsed_url.netloc) or (
  83. not parsed_url.scheme and not parsed_url.netloc
  84. ):
  85. raise InvalidRequirement("Invalid URL: {0}".format(req.url))
  86. self.url = req.url
  87. else:
  88. self.url = None
  89. self.extras = set(req.extras.asList() if req.extras else [])
  90. self.specifier = SpecifierSet(req.specifier)
  91. self.marker = req.marker if req.marker else None
  92. def __str__(self):
  93. parts = [self.name]
  94. if self.extras:
  95. parts.append("[{0}]".format(",".join(sorted(self.extras))))
  96. if self.specifier:
  97. parts.append(str(self.specifier))
  98. if self.url:
  99. parts.append("@ {0}".format(self.url))
  100. if self.marker:
  101. parts.append(" ")
  102. if self.marker:
  103. parts.append("; {0}".format(self.marker))
  104. return "".join(parts)
  105. def __repr__(self):
  106. return "<Requirement({0!r})>".format(str(self))