Merge lp:~dustin-ingram/pkginfo/add-new-fields into lp:pkginfo

[dustingram]

Add 'Provides-Extra' and 'Description-Content-Type' fields

Add the 'Provides-Extra' and 'Description-Content-Type' fields, per https://packaging.python.org/specifications/.

[lp:~dustin-ingram/pkginfo/add-new-fields]

145. By dustingram on 2017-09-12

Add defaults for 'provides_extras' and 'description_content_type'

[Tres Seaver (tseaver)]

Looking at the branch, I'd like some guidance from the PyPA about what metadata version is supposed to define those fields. See my query on https://github.com/python/peps/issues/388

[lp:~dustin-ingram/pkginfo/add-new-fields]

146. By dustingram on 2018-03-03

Updates for PEP 566

[dustingram (dustin-ingram)]

> Looking at the branch, I'd like some guidance from the PyPA about what
> metadata version is supposed to define those fields. See my query on
> https://github.com/python/peps/issues/388

PEP 566 has now been accepted, I've updated this merge request accordingly.

[Tres Seaver (tseaver)]

Thanks for the patch! I will release a new version after reviewing open merge requests / issues.

=== modified file 'pkginfo/distribution.py'
--- pkginfo/distribution.py	2013-11-27 22:09:41 +0000
+++ pkginfo/distribution.py	2018-03-03 22:34:24 +0000
@@ -58,11 +58,17 @@
 
 HEADER_ATTRS_2_0 = HEADER_ATTRS_1_2  #XXX PEP 426?
 
+HEADER_ATTRS_2_1 = HEADER_ATTRS_1_2 + ( # PEP 566
+    ('Provides-Extra', 'provides_extras', True),
+    ('Description-Content-Type', 'description_content_type', False)
+)
+
 HEADER_ATTRS = {
     '1.0': HEADER_ATTRS_1_0,
     '1.1': HEADER_ATTRS_1_1,
     '1.2': HEADER_ATTRS_1_2,
     '2.0': HEADER_ATTRS_2_0,
+    '2.1': HEADER_ATTRS_2_1,
 }
 
 class Distribution(object):
@@ -94,6 +100,9 @@
     provides_dist = ()
     obsoletes_dist = ()
     project_urls = ()
+    # version 2.1
+    provides_extras = ()
+    description_content_type = None
 
     def extractMetadata(self):
         data = self.read()
@@ -126,7 +135,11 @@
                     value = get(msg, header_name)
                     if value != 'UNKNOWN':
                         setattr(self, attr_name, value)
-                        
+
+        body = msg.get_payload()
+        if body:
+            setattr(self, 'description', body)
+
     def __iter__(self):
         for header_name, attr_name, multiple in self._getHeaderAttrs():
             yield attr_name

=== modified file 'pkginfo/tests/test_distribution.py'
--- pkginfo/tests/test_distribution.py	2013-10-09 21:36:30 +0000
+++ pkginfo/tests/test_distribution.py	2018-03-03 22:34:24 +0000
@@ -74,6 +74,14 @@
         self.assertEqual(list(dist),
                          [x[1] for x in HEADER_ATTRS_1_2])
 
+    def test_parse_Metadata_Version_2_1(self):
+        from pkginfo.distribution import HEADER_ATTRS_2_1
+        dist = self._makeOne(None)
+        dist.parse('Metadata-Version: 2.1')
+        self.assertEqual(dist.metadata_version, '2.1')
+        self.assertEqual(list(dist),
+                         [x[1] for x in HEADER_ATTRS_2_1])
+
     def test_parse_Metadata_Version_unknown(self):
         dist = self._makeOne(None)
         dist.parse('Metadata-Version: 1.3')
@@ -138,6 +146,16 @@
                          'This package enables integration with\n'
                          'foo servers.')
 
+    def test_parse_Description_in_payload(self):
+        dist = self._makeOne()
+        dist.parse('Foo: Bar\n'
+                   '\n'
+                   'This package enables integration with\n'
+                   'foo servers.')
+        self.assertEqual(dist.description,
+                         'This package enables integration with\n'
+                         'foo servers.')
+
     def test_parse_Keywords(self):
         dist = self._makeOne()
         dist.parse('Keywords: bar foo qux')

=== modified file 'pkginfo/wheel.py'
--- pkginfo/wheel.py	2013-11-27 22:09:41 +0000
+++ pkginfo/wheel.py	2018-03-03 22:34:24 +0000
@@ -1,11 +1,8 @@
-from io import StringIO
 import os
 import zipfile
 
 
 from .distribution import Distribution
-from .distribution import must_decode
-from .distribution import parse
 
 
 class Wheel(Distribution):
@@ -41,9 +38,3 @@
             archive.close()
 
         raise ValueError('No METADATA in archive: %s' % fqn)
-
-    def parse(self, data):
-        super(Wheel, self).parse(data)
-        fp = StringIO(must_decode(data))
-        msg = parse(fp)
-        self.description = msg.get_payload()