1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
import io
from email.parser import Parser
import warnings
def _must_decode(value):
if type(value) is bytes:
try:
return value.decode('utf-8')
except UnicodeDecodeError:
return value.decode('latin1')
return value
must_decode = _must_decode # deprecated compatibility alias FBO twine.
def parse(fp):
return Parser().parse(fp)
def get(msg, header):
return _collapse_leading_ws(header, msg.get(header))
def get_all(msg, header):
return [_collapse_leading_ws(header, x) for x in msg.get_all(header)]
def _collapse_leading_ws(header, txt):
"""
``Description`` header must preserve newlines; all others need not
"""
if header.lower() == 'description': # preserve newlines
return '\n'.join([x[8:] if x.startswith(' ' * 8) else x
for x in txt.strip().splitlines()])
else:
return ' '.join([x.strip() for x in txt.splitlines()])
HEADER_ATTRS_1_0 = ( # PEP 241
('Metadata-Version', 'metadata_version', False),
('Name', 'name', False),
('Version', 'version', False),
('Platform', 'platforms', True),
('Supported-Platform', 'supported_platforms', True),
('Summary', 'summary', False),
('Description', 'description', False),
('Keywords', 'keywords', False),
('Home-Page', 'home_page', False),
('Author', 'author', False),
('Author-email', 'author_email', False),
('License', 'license', False),
)
HEADER_ATTRS_1_1 = HEADER_ATTRS_1_0 + ( # PEP 314
('Classifier', 'classifiers', True),
('Download-URL', 'download_url', False),
('Requires', 'requires', True),
('Provides', 'provides', True),
('Obsoletes', 'obsoletes', True),
)
HEADER_ATTRS_1_2 = HEADER_ATTRS_1_1 + ( # PEP 345
('Maintainer', 'maintainer', False),
('Maintainer-email', 'maintainer_email', False),
('Requires-Python', 'requires_python', False),
('Requires-External', 'requires_external', True),
('Requires-Dist', 'requires_dist', True),
('Provides-Dist', 'provides_dist', True),
('Obsoletes-Dist', 'obsoletes_dist', True),
('Project-URL', 'project_urls', True),
)
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_2_2 = HEADER_ATTRS_2_1 + ( # PEP 643
('Dynamic', 'dynamic', True),
)
HEADER_ATTRS_2_3 = HEADER_ATTRS_2_2 # PEP 685
HEADER_ATTRS_2_4 = HEADER_ATTRS_2_3 + ( # PEP 639
('License-Expression', 'license_expression', False),
('License-File', 'license_file', True),
)
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,
'2.2': HEADER_ATTRS_2_2,
'2.3': HEADER_ATTRS_2_3,
'2.4': HEADER_ATTRS_2_4,
}
def _version_tuple(metadata_version):
if metadata_version is None:
return (0, 0)
return tuple(
[int(part) for part in metadata_version.split(".")]
)
METADATA_VERSIONS = [
_version_tuple(key) for key in HEADER_ATTRS
]
MAX_METADATA_VERSION = max(METADATA_VERSIONS)
# See: https://bugs.launchpad.net/bugs/2066340
MAX_METADATA_VERSION_STR = ".".join(
str(element) for element in MAX_METADATA_VERSION
)
class UnknownMetadataVersion(UserWarning):
def __init__(self, metadata_version):
self.metadata_version = metadata_version
super().__init__(f"Unknown metadata version: {metadata_version}")
class NewMetadataVersion(UserWarning):
def __init__(self, metadata_version):
self.metadata_version = metadata_version
super().__init__(
f"New metadata version ({metadata_version}) higher than "
f"latest supported version: parsing as {MAX_METADATA_VERSION_STR}"
)
class Distribution(object):
metadata_version = None
# version 1.0
name = None
version = None
platforms = ()
supported_platforms = ()
summary = None
description = None
keywords = None
home_page = None
download_url = None
author = None
author_email = None
license = None
# version 1.1
classifiers = ()
requires = ()
provides = ()
obsoletes = ()
# version 1.2
maintainer = None
maintainer_email = None
requires_python = None
requires_external = ()
requires_dist = ()
provides_dist = ()
obsoletes_dist = ()
project_urls = ()
# version 2.1
provides_extras = ()
description_content_type = None
# version 2.2
dynamic = ()
# version 2.4
license_expression = None
license_file = ()
def extractMetadata(self):
data = self.read()
self.parse(data)
def read(self):
raise NotImplementedError
def _getHeaderAttrs(self):
found = HEADER_ATTRS.get(self.metadata_version)
if found is None:
try:
v_tuple = _version_tuple(self.metadata_version)
except ValueError:
warnings.warn(UnknownMetadataVersion(self.metadata_version))
return ()
if v_tuple > MAX_METADATA_VERSION:
warnings.warn(NewMetadataVersion(self.metadata_version))
return HEADER_ATTRS[MAX_METADATA_VERSION_STR]
else:
warnings.warn(UnknownMetadataVersion(self.metadata_version))
return ()
return found
def parse(self, data):
fp = io.StringIO(_must_decode(data))
msg = parse(fp)
if 'Metadata-Version' in msg and self.metadata_version is None:
value = get(msg, 'Metadata-Version')
metadata_version = self.metadata_version = value
for header_name, attr_name, multiple in self._getHeaderAttrs():
if attr_name == 'metadata_version':
continue
if header_name in msg:
if multiple:
values = get_all(msg, header_name)
setattr(self, attr_name, values)
else:
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
iterkeys = __iter__
|
