Debian Codegraph @

yarg/package.py

raw
1 # -*- coding: utf-8 -*-
2
3 # (The MIT License)
4 #
5 # Copyright (c) 2014 Kura
6 #
7 # Permission is hereby granted, free of charge, to any person obtaining a copy
8 # of this software and associated documentation files (the 'Software'), to deal
9 # in the Software without restriction, including without limitation the rights
10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 # copies of the Software, and to permit persons to whom the Software is
12 # furnished to do so, subject to the following conditions:
13 #
14 # The above copyright notice and this permission notice shall be included in
15 # all copies or substantial portions of the Software.
16 #
17 # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 # SOFTWARE.
24
25
26 try:
27 import simplejson as json
28 except ImportError:
29 import json
30 from collections import namedtuple
31 import re
32
33 from .release import Release
34
35
36 class Package(object):
37 """
38 A PyPI package.
39
40 :param pypi_dict: A dictionary retrieved from the PyPI server.
41 """
42
43 def __init__(self, pypi_dict):
44 self._package = pypi_dict['info']
45 self._releases = pypi_dict['releases']
46
47 def __repr__(self):
48 return "<Package {0}>".format(self.name)
49
50 @property
51 def name(self):
52 """
53 >>> package = yarg.get('yarg')
54 >>> package.name
55 'yarg'
56 """
57 return self._package['name']
58
59 @property
60 def pypi_url(self):
61 """
62 >>> package = yarg.get('yarg')
63 >>> package.url
64 'https://pypi.python.org/pypi/yarg'
65 """
66 return self._package['package_url']
67
68 @property
69 def summary(self):
70 """
71 >>> package = yarg.get('yarg')
72 >>> package.summary
73 'Some random summary stuff'
74 """
75 return self._package['summary']
76
77 @property
78 def description(self):
79 """
80 >>> package = yarg.get('yarg')
81 >>> package.description
82 'A super long description, usually uploaded from the README'
83 """
84 return self._package['description']
85
86 @property
87 def homepage(self):
88 """
89 >>> package = yarg.get('yarg')
90 >>> package.homepage
91 'https://kura.io/yarg/'
92 """
93 if ('home_page' not in self._package or
94 self._package['home_page'] == ""):
95 return None
96 return self._package['home_page']
97
98 @property
99 def bugtracker(self):
100 """
101 >>> package = yarg.get('yarg')
102 >>> package.bugtracker
103 'https://github.com/kura/yarg/issues'
104 """
105 if ('bugtrack_url' not in self._package or
106 self._package['bugtrack_url'] == ""):
107 return None
108 return self._package['bugtrack_url']
109
110 @property
111 def docs(self):
112 """
113 >>> package = yarg.get('yarg')
114 >>> package.docs
115 'https://yarg.readthedocs.org/en/latest'
116 """
117 if ('docs_url' not in self._package or
118 self._package['docs_url'] == ""):
119 return None
120 return self._package['docs_url']
121
122 @property
123 def author(self):
124 """
125 >>> package = yarg.get('yarg')
126 >>> package.author
127 Author(name='Kura', email='[email protected]')
128 """
129 author = namedtuple('Author', 'name email')
130 return author(name=self._package['author'],
131 email=self._package['author_email'])
132
133 @property
134 def maintainer(self):
135 """
136 >>> package = yarg.get('yarg')
137 >>> package.maintainer
138 Maintainer(name='Kura', email='[email protected]')
139 """
140 maintainer = namedtuple('Maintainer', 'name email')
141 return maintainer(name=self._package['maintainer'],
142 email=self._package['maintainer_email'])
143
144 @property
145 def license(self):
146 """
147 >>> package = yarg.get('yarg')
148 >>> package.license
149 'MIT'
150 """
151 return self._package['license']
152
153 @property
154 def license_from_classifiers(self):
155 """
156 >>> package = yarg.get('yarg')
157 >>> package.license_from_classifiers
158 'MIT License'
159 """
160 if len(self.classifiers) > 0:
161 for c in self.classifiers:
162 if c.startswith("License"):
163 return c.split(" :: ")[-1]
164
165 @property
166 def downloads(self):
167 """
168 >>> package = yarg.get('yarg')
169 >>> package.downloads
170 Downloads(day=50100, week=367941, month=1601938) # I wish
171 """
172 _downloads = self._package['downloads']
173 downloads = namedtuple('Downloads', 'day week month')
174 return downloads(day=_downloads['last_day'],
175 week=_downloads['last_week'],
176 month=_downloads['last_month'])
177
178 @property
179 def classifiers(self):
180 """
181 >>> package = yarg.get('yarg')
182 >>> package.classifiers
183 ['License :: OSI Approved :: MIT License',
184 'Programming Language :: Python :: 2.7',
185 'Programming Language :: Python :: 3.4']
186 """
187 return self._package['classifiers']
188
189 @property
190 def python_versions(self):
191 """
192 Returns a list of Python version strings that
193 the package has listed in :attr:`yarg.Release.classifiers`.
194
195 >>> package = yarg.get('yarg')
196 >>> package.python_versions
197 ['2.6', '2.7', '3.3', '3.4']
198 """
199 version_re = re.compile(r"""Programming Language \:\: """
200 """Python \:\: \d\.\d""")
201 return [c.split(' :: ')[-1] for c in self.classifiers
202 if version_re.match(c)]
203
204 @property
205 def python_implementations(self):
206 """
207 Returns a list of Python implementation strings that
208 the package has listed in :attr:`yarg.Release.classifiers`.
209
210 >>> package = yarg.get('yarg')
211 >>> package.python_implementations
212 ['CPython', 'PyPy']
213 """
214 return [c.split(' :: ')[-1] for c in self.classifiers
215 if c.startswith("""Programming Language :: """
216 """Python :: Implementation""")]
217
218 @property
219 def latest_release_id(self):
220 """
221 >>> package = yarg.get('yarg')
222 >>> package.latest_release_id
223 '0.1.0'
224 """
225 return self._package['version']
226
227 @property
228 def latest_release(self):
229 """
230 A list of :class:`yarg.release.Release` objects for each file in the
231 latest release.
232
233 >>> package = yarg.get('yarg')
234 >>> package.latest_release
235 [<Release 0.1.0>, <Release 0.1.0>]
236 """
237 release_id = self.latest_release_id
238 return self.release(release_id)
239
240 @property
241 def has_wheel(self):
242 """
243 Returns `True` if one of the :class:`yarg.release.Release` objects
244 in the latest set of release files is `wheel` format. Returns
245 `False` if not.
246
247 >>> package = yarg.get('yarg')
248 >>> package.has_wheel
249 True
250 """
251 for release in self.latest_release:
252 if release.package_type in ('wheel', 'bdist_wheel'):
253 return True
254 return False
255
256 @property
257 def has_egg(self):
258 """
259 Returns `True` if one of the :class:`yarg.release.Release` objects
260 in the latest set of release files is `egg` format. Returns
261 `False` if not.
262
263 >>> package = yarg.get('yarg')
264 >>> package.has_egg
265 False
266 """
267 for release in self.latest_release:
268 if release.package_type in ('egg', 'bdist_egg'):
269 return True
270 return False
271
272 @property
273 def has_source(self):
274 """
275 Returns `True` if one of the :class:`yarg.release.Release` objects
276 in the latest set of release files is `source` format. Returns
277 `False` if not.
278
279 >>> package = yarg.get('yarg')
280 >>> package.has_source
281 True
282 """
283 for release in self.latest_release:
284 if release.package_type in ('source', 'sdist'):
285 return True
286 return False
287
288 @property
289 def release_ids(self):
290 """
291 >>> package = yarg.get('yarg')
292 >>> package.release_ids
293 ['0.0.1', '0.0.5', '0.1.0']
294 """
295 r = [(k, self._releases[k][0]['upload_time'])
296 for k in self._releases.keys()
297 if len(self._releases[k]) > 0]
298 return [k[0] for k in sorted(r, key=lambda k: k[1])]
299
300 def release(self, release_id):
301 """
302 A list of :class:`yarg.release.Release` objects for each file in a
303 release.
304
305 :param release_id: A pypi release id.
306
307 >>> package = yarg.get('yarg')
308 >>> last_release = yarg.releases[-1]
309 >>> package.release(last_release)
310 [<Release 0.1.0>, <Release 0.1.0>]
311 """
312 if release_id not in self.release_ids:
313 return None
314 return [Release(release_id, r) for r in self._releases[release_id]]
315
316
317 def json2package(json_content):
318 """
319 Returns a :class:`yarg.release.Release` object from JSON content from the
320 PyPI server.
321
322 :param json_content: JSON encoded content from the PyPI server.
323 """
324 return Package(json.loads(json_content))