-
Notifications
You must be signed in to change notification settings - Fork 0
/
pytvdb.py
357 lines (280 loc) · 8.62 KB
/
pytvdb.py
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
import time
import requests
from zipfile import ZipFile
from tempfile import TemporaryFile
from bs4 import BeautifulSoup
def _filter_dict_value(value):
'''
'''
if '.jpg' in value:
return '%s/banners/%s' % (PyTVDB.mirror, value)
return value.encode('utf-8')
def _filter_dict_key(key):
'''
'''
search_for = (
'seriesid', 'seriesname', 'firstaired', 'airs_dayofweek', 'contentrating', 'networkid',
'ratingcount', 'addedby', 'lastupdated', 'combined_episodenumber', 'dvd_discid', 'dvd_episodenumber',
'epimgflag', 'episodename', 'episodenumber', 'gueststars', 'productioncode', 'seasonnumber',
'airsafter_season', 'airsbefore_episode', 'airsbefore_season', 'seasonid', 'sortorder',
'bannerpath', 'bannertype', 'bannertype2', 'thumbnailpath', 'vignettepath'
)
replace_by = (
'series_id', 'series_name', 'first_aired', 'airs_day_of_week', 'content_rating', 'network_id',
'rating_count', 'added_by', 'last_updated', 'combined_episode_number', 'dvd_disc_id', 'dvd_episode_number',
'ep_img_flag', 'episode_name', 'episode_number', 'guest_stars', 'production_code', 'season_number',
'airs_after_season', 'airs_before_episode', 'airsbefore_season', 'season_id', 'sort_order',
'banner_path', 'banner_type', 'banner_type_2', 'thumbnail_path', 'vignette_path'
)
if key in search_for:
return replace_by[search_for.index(key)]
return key
def _sanitize_returned_data(data):
'''
'''
result = {}
for item in data:
if item.name is not None and item.string is not None:
result[_filter_dict_key(item.name)] = _filter_dict_value(item.string)
return result
class SeriesPreview(object):
'''
'''
def __init__(self, data):
'''
'''
self.__dict__.update(_sanitize_returned_data(data))
def __repr__(self):
'''
'''
return '{SeriesPreview: %s}' % (self.__dict__)
class SeriesInfo(object):
'''
'''
def __init__(self, data):
'''
'''
self.__dict__.update(_sanitize_returned_data(data['info'].find('series')))
self.episodes = EpisodesList(data['info'].find_all('episode'))
self.actors = ActorsList(data['actors'].find_all('actor'))
self.graphics = GraphicsList(data['graphics'].find_all('banner'))
def __repr__(self):
'''
'''
return '{SeriesInfo: %s}' % (self.__dict__)
class EpisodesList(list):
'''
'''
def __init__(self, episodes):
'''
'''
self.include_unaired = False
self.include_specials = False
total_episodes = 0
for episode in episodes:
self.append(EpisodeInfo(episode))
total_episodes += 1
self.total_episodes = total_episodes
def __iter__(self):
'''
'''
return (self[i] for i in self._episodes_generator())
def __len__(self):
'''
'''
return len(list(self._episodes_generator()))
def _episodes_generator(self):
'''
'''
i = 0
while i < self.total_episodes:
if (self.include_unaired or not self[i].is_unaired) and \
(self.include_specials or not self[i].is_special):
yield i
i += 1
# TODO raise IndexError, TypeError
def get_season(self, season_number = 1):
'''Gets all episodes from a specified season.
Arguments:
season_number -- the series season number -- defaults to 1
Returns:
a list of EpisodeInfo instances for each episode on the season.
Raises:
KeyError: if season_number is < 1 or > then the total number of seasons.
TypeError: if season_number is not convertible to an integer
'''
return [episode for episode in self
if episode.season_number == str(season_number)]
# TODO raise IndexError, TypeError
def get_episode(self, season_number = 1, episode_number = 1):
'''Get an episode from a specified season and episode number
Arguments:
season_number -- the number of the season; defaults to 1
episode_number -- the number of the episode; defaults to 1
Returns:
an EpisodeInfo object or None if the episode is not found
Raises:
IndexError -- if season_number or episode_number is < 1 or > then the total number of seasons and episodes
TypeError -- if season_number or episode_number is not convertible to an integer
'''
return self.get_season(season_number)[episode_number - 1]
def get_unaired(self):
'''
returns a list with unaired espisodes
'''
return [self[i] for i in range(self.total_episodes)
if self[i].is_unaired]
def get_specials(self):
'''
returns a list with special objects (not conatined in any season)
'''
return [self[i] for i in range(self.total_episodes)
if self[i].is_special]
class EpisodeInfo(object):
'''
'''
def __init__(self, data):
'''
'''
self.__dict__.update(_sanitize_returned_data(data))
if (data.firstaired.string is not None):
air_date = time.strptime(self.first_aired, '%Y-%m-%d')
current_date = time.localtime(time.time())
self.is_unaired = (current_date < air_date)
else:
self.is_unaired = False
self.is_special = (self.season_number == '0')
def __repr__(self):
'''
'''
return '{EpisodeInfo: %s}' % (self.__dict__)
class ActorsList(list):
'''
'''
def __init__(self, actors):
'''
'''
for actor in actors:
self.append(ActorInfo(actor))
class ActorInfo(object):
'''
'''
def __init__(self, data):
'''
'''
self.__dict__.update(_sanitize_returned_data(data))
def __repr__(self):
'''
'''
return '{ActorInfo: %s}' % (self.__dict__)
class GraphicsList(list):
'''
'''
def __init__(self, graphics):
'''
'''
for graphic in graphics:
self.append(GraphicInfo(graphic))
def get_by_type(self, image_type):
'''
'''
return [graphic for graphic in self if graphic.banner_type == image_type]
class GraphicInfo(object):
'''
Represents a graphic (series poster, season poster, banner or fanart)
Instance Attributes:
id --
banner_path --
banner_type --
colors --
language --
rating --
rating_count --
series_name --
thumbnail_path --
vignette_path --
'''
TYPE_FANART = 'fanart'
TYPE_POSTER = 'poster'
TYPE_SEASON = 'season'
TYPE_SERIES = 'series'
def __init__(self, data):
'''
'''
self.__dict__.update(_sanitize_returned_data(data))
def __repr__(self):
return '{GraphicInfo: %s}' % (self.__dict__)
class PyTVDB(object):
'''Module to expose data from thetvdb.com API
Class Attributes:
version -- symver
mirror -- base domain path
Instance Attributes:
api_key -- API Key for use with the thetvdb.com API - must be obtained at thetvdb.com
language -- base language for data returned from thetvdb.com API - it defaults to 'en' (English)
'''
version = '0.0.1'
mirror = 'http://thetvdb.com'
# TODO - raise ValueError for language parameter
def __init__(self, api_key, language = 'en'):
'''PyTVDB Class constructor
Arguments:
api_key -- valid thetvdb.com API Key
language -- base language for data returned from thetvdb.com API - it defaults to 'en' (English)
'''
self.api_key = api_key
self.language = language
# TODO raise TypeError, IOException, BadZipFileException
def _get_data(self, series_id):
'''Get series data from thetvdb.com
Arguments:
series_id -- the id of the series from thetvdb.com
Returns:
a SeriesInfo instance or None if the series_id parameter was not found
Raises:
TypeError -- the parameter must be either a positive integer or a string
'''
series_id = str(series_id)
response = requests.get('%s/api/%s/series/%s/all/%s.zip' % (self.mirror, self.api_key, series_id, self.language))
if response.status_code != 200:
return None
with TemporaryFile() as tmp_file:
tmp_file.write(response.content)
with ZipFile(tmp_file, 'r') as zip_file:
data = {}
with zip_file.open('%s.xml' % (self.language)) as xml_info:
data['info'] = BeautifulSoup(xml_info.read())
with zip_file.open('actors.xml') as xml_actors:
data['actors'] = BeautifulSoup(xml_actors.read())
with zip_file.open('banners.xml') as xml_graphics:
data['graphics'] = BeautifulSoup(xml_graphics.read())
return data
# TODO - implement
def get_languages(self):
pass
def search(self, query):
'''Search the thetvdb.com database for series
Arguments:
query -- the search term (eg: 'Thrones')
Returns:
a list of SeriesPreview instances or None if no results were found
Raises:
TypeError -- the parameter query must be a string
'''
if not isinstance(query, str):
raise TypeError('Parameter query must be a string.')
response = requests.get('%s/api/GetSeries.php?seriesname=%s' % (self.mirror, query))
response.raise_for_status()
data = BeautifulSoup(response.text).find_all('series')
if len(data) > 1:
results = []
for series_data in data:
results.append(SeriesPreview(series_data))
return results
else:
return None
def get_series(self, series_id) :
'''
get series(tv show) info from thetvdb.com and return a SeriesInfo object
'''
return SeriesInfo(self._get_data(series_id))