metadata.py 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. """
  2. Tools for converting old- to new-style metadata.
  3. """
  4. import os.path
  5. import textwrap
  6. import pkg_resources
  7. from .pkginfo import read_pkg_info
  8. def requires_to_requires_dist(requirement):
  9. """Return the version specifier for a requirement in PEP 345/566 fashion."""
  10. if getattr(requirement, 'url', None):
  11. return " @ " + requirement.url
  12. requires_dist = []
  13. for op, ver in requirement.specs:
  14. requires_dist.append(op + ver)
  15. if not requires_dist:
  16. return ''
  17. return " (%s)" % ','.join(sorted(requires_dist))
  18. def convert_requirements(requirements):
  19. """Yield Requires-Dist: strings for parsed requirements strings."""
  20. for req in requirements:
  21. parsed_requirement = pkg_resources.Requirement.parse(req)
  22. spec = requires_to_requires_dist(parsed_requirement)
  23. extras = ",".join(sorted(parsed_requirement.extras))
  24. if extras:
  25. extras = "[%s]" % extras
  26. yield (parsed_requirement.project_name + extras + spec)
  27. def generate_requirements(extras_require):
  28. """
  29. Convert requirements from a setup()-style dictionary to ('Requires-Dist', 'requirement')
  30. and ('Provides-Extra', 'extra') tuples.
  31. extras_require is a dictionary of {extra: [requirements]} as passed to setup(),
  32. using the empty extra {'': [requirements]} to hold install_requires.
  33. """
  34. for extra, depends in extras_require.items():
  35. condition = ''
  36. extra = extra or ''
  37. if ':' in extra: # setuptools extra:condition syntax
  38. extra, condition = extra.split(':', 1)
  39. extra = pkg_resources.safe_extra(extra)
  40. if extra:
  41. yield 'Provides-Extra', extra
  42. if condition:
  43. condition = "(" + condition + ") and "
  44. condition += "extra == '%s'" % extra
  45. if condition:
  46. condition = ' ; ' + condition
  47. for new_req in convert_requirements(depends):
  48. yield 'Requires-Dist', new_req + condition
  49. def pkginfo_to_metadata(egg_info_path, pkginfo_path):
  50. """
  51. Convert .egg-info directory with PKG-INFO to the Metadata 2.1 format
  52. """
  53. pkg_info = read_pkg_info(pkginfo_path)
  54. pkg_info.replace_header('Metadata-Version', '2.1')
  55. # Those will be regenerated from `requires.txt`.
  56. del pkg_info['Provides-Extra']
  57. del pkg_info['Requires-Dist']
  58. requires_path = os.path.join(egg_info_path, 'requires.txt')
  59. if os.path.exists(requires_path):
  60. with open(requires_path) as requires_file:
  61. requires = requires_file.read()
  62. parsed_requirements = sorted(pkg_resources.split_sections(requires),
  63. key=lambda x: x[0] or '')
  64. for extra, reqs in parsed_requirements:
  65. for key, value in generate_requirements({extra: reqs}):
  66. if (key, value) not in pkg_info.items():
  67. pkg_info[key] = value
  68. description = pkg_info['Description']
  69. if description:
  70. pkg_info.set_payload(dedent_description(pkg_info))
  71. del pkg_info['Description']
  72. return pkg_info
  73. def pkginfo_unicode(pkg_info, field):
  74. """Hack to coax Unicode out of an email Message() - Python 3.3+"""
  75. text = pkg_info[field]
  76. field = field.lower()
  77. if not isinstance(text, str):
  78. for item in pkg_info.raw_items():
  79. if item[0].lower() == field:
  80. text = item[1].encode('ascii', 'surrogateescape') \
  81. .decode('utf-8')
  82. break
  83. return text
  84. def dedent_description(pkg_info):
  85. """
  86. Dedent and convert pkg_info['Description'] to Unicode.
  87. """
  88. description = pkg_info['Description']
  89. # Python 3 Unicode handling, sorta.
  90. surrogates = False
  91. if not isinstance(description, str):
  92. surrogates = True
  93. description = pkginfo_unicode(pkg_info, 'Description')
  94. description_lines = description.splitlines()
  95. description_dedent = '\n'.join(
  96. # if the first line of long_description is blank,
  97. # the first line here will be indented.
  98. (description_lines[0].lstrip(),
  99. textwrap.dedent('\n'.join(description_lines[1:])),
  100. '\n'))
  101. if surrogates:
  102. description_dedent = description_dedent \
  103. .encode("utf8") \
  104. .decode("ascii", "surrogateescape")
  105. return description_dedent