243 lines
8.2 KiB
Python
243 lines
8.2 KiB
Python
#!/usr/bin/env python
|
|
|
|
__author__ = "Abhinav Sarkar <abhinav@abhinavsarkar.net>"
|
|
__version__ = "0.2"
|
|
__license__ = "GNU Lesser General Public License"
|
|
|
|
from lastfm.base import LastfmBase
|
|
from lastfm.mixins import Cacheable, Searchable, Taggable
|
|
|
|
class Album(LastfmBase, Cacheable, Searchable, Taggable):
|
|
"""A class representing an album."""
|
|
def init(self,
|
|
api,
|
|
name = None,
|
|
artist = None,
|
|
id = None,
|
|
mbid = None,
|
|
url = None,
|
|
release_date = None,
|
|
image = None,
|
|
stats = None,
|
|
top_tags = None,
|
|
streamable = None):
|
|
if not isinstance(api, Api):
|
|
raise InvalidParametersError("api reference must be supplied as an argument")
|
|
Taggable.init(self, api)
|
|
self._api = api
|
|
self._name = name
|
|
self._artist = artist
|
|
self._id = id
|
|
self._mbid = mbid
|
|
self._url = url
|
|
self._release_date = release_date
|
|
self._image = image
|
|
self._stats = stats and Stats(
|
|
subject = self,
|
|
listeners = stats.listeners,
|
|
playcount = stats.playcount,
|
|
match = stats.match,
|
|
rank = stats.rank
|
|
)
|
|
self._top_tags = top_tags
|
|
self._streamable = streamable
|
|
|
|
@property
|
|
def name(self):
|
|
"""name of the album"""
|
|
return self._name
|
|
|
|
@property
|
|
def artist(self):
|
|
"""artist of the album"""
|
|
return self._artist
|
|
|
|
@property
|
|
def id(self):
|
|
"""id of the album"""
|
|
if self._id is None:
|
|
self._fill_info()
|
|
return self._id
|
|
|
|
@property
|
|
def mbid(self):
|
|
"""mbid of the album"""
|
|
if self._mbid is None:
|
|
self._fill_info()
|
|
return self._mbid
|
|
|
|
@property
|
|
def url(self):
|
|
"""url of the album's page"""
|
|
if self._url is None:
|
|
self._fill_info()
|
|
return self._url
|
|
|
|
@property
|
|
def release_date(self):
|
|
"""release date of the album"""
|
|
if self._release_date is None:
|
|
self._fill_info()
|
|
return self._release_date
|
|
|
|
@property
|
|
def image(self):
|
|
"""cover images of the album"""
|
|
if self._image is None:
|
|
self._fill_info()
|
|
return self._image
|
|
|
|
@property
|
|
def stats(self):
|
|
"""stats related to the album"""
|
|
if self._stats is None:
|
|
self._fill_info()
|
|
return self._stats
|
|
|
|
@property
|
|
def streamable(self):
|
|
"""is the album streamable"""
|
|
return self._streamable
|
|
|
|
@LastfmBase.cached_property
|
|
def top_tags(self):
|
|
"""top tags for the album"""
|
|
params = {'method': 'album.getInfo'}
|
|
if self.artist and self.name:
|
|
params.update({'artist': self.artist.name, 'album': self.name})
|
|
elif self.mbid:
|
|
params.update({'mbid': self.mbid})
|
|
data = self._api._fetch_data(params).find('album')
|
|
return [
|
|
Tag(
|
|
self._api,
|
|
subject = self,
|
|
name = t.findtext('name'),
|
|
url = t.findtext('url')
|
|
)
|
|
for t in data.findall('toptags/tag')
|
|
]
|
|
|
|
@LastfmBase.top_property("top_tags")
|
|
def top_tag(self):
|
|
"""top tag for the album"""
|
|
pass
|
|
|
|
@LastfmBase.cached_property
|
|
def playlist(self):
|
|
return Playlist.fetch(self._api, "lastfm://playlist/album/%s" % self.id)
|
|
|
|
@staticmethod
|
|
def get_info(api,
|
|
artist = None,
|
|
album = None,
|
|
mbid = None):
|
|
data = Album._fetch_data(api, artist, album, mbid)
|
|
a = Album(
|
|
api,
|
|
name = data.findtext('name'),
|
|
artist = Artist(
|
|
api,
|
|
name = data.findtext('artist'),
|
|
),
|
|
)
|
|
a._fill_info()
|
|
return a
|
|
|
|
def _default_params(self, extra_params = {}):
|
|
if not (self.artist and self.name):
|
|
raise InvalidParametersError("artist and album have to be provided.")
|
|
params = {'artist': self.artist.name, 'album': self.name}
|
|
params.update(extra_params)
|
|
return params
|
|
|
|
@staticmethod
|
|
def _fetch_data(api,
|
|
artist = None,
|
|
album = None,
|
|
mbid = None):
|
|
params = {'method': 'album.getInfo'}
|
|
if not ((artist and album) or mbid):
|
|
raise InvalidParametersError("either (artist and album) or mbid has to be given as argument.")
|
|
if artist and album:
|
|
params.update({'artist': artist, 'album': album})
|
|
elif mbid:
|
|
params.update({'mbid': mbid})
|
|
return api._fetch_data(params).find('album')
|
|
|
|
def _fill_info(self):
|
|
data = Album._fetch_data(self._api, self.artist.name, self.name)
|
|
self._id = int(data.findtext('id'))
|
|
self._mbid = data.findtext('mbid')
|
|
self._url = data.findtext('url')
|
|
self._release_date = data.findtext('releasedate') and data.findtext('releasedate').strip() and \
|
|
datetime(*(time.strptime(data.findtext('releasedate').strip(), '%d %b %Y, 00:00')[0:6]))
|
|
self._image = dict([(i.get('size'), i.text) for i in data.findall('image')])
|
|
if not self._stats:
|
|
self._stats = Stats(
|
|
subject = self,
|
|
listeners = int(data.findtext('listeners')),
|
|
playcount = int(data.findtext('playcount')),
|
|
)
|
|
self._top_tags = [
|
|
Tag(
|
|
self._api,
|
|
subject = self,
|
|
name = t.findtext('name'),
|
|
url = t.findtext('url')
|
|
)
|
|
for t in data.findall('toptags/tag')
|
|
]
|
|
|
|
@staticmethod
|
|
def _search_yield_func(api, album):
|
|
return Album(
|
|
api,
|
|
name = album.findtext('name'),
|
|
artist = Artist(
|
|
api,
|
|
name = album.findtext('artist')
|
|
),
|
|
id = int(album.findtext('id')),
|
|
url = album.findtext('url'),
|
|
image = dict([(i.get('size'), i.text) for i in album.findall('image')]),
|
|
streamable = (album.findtext('streamable') == '1'),
|
|
)
|
|
|
|
@staticmethod
|
|
def _hash_func(*args, **kwds):
|
|
try:
|
|
return hash("%s%s" % (kwds['name'], hash(kwds['artist'])))
|
|
except KeyError:
|
|
raise InvalidParametersError("name and artist have to be provided for hashing")
|
|
|
|
def __hash__(self):
|
|
return self.__class__._hash_func(name = self.name, artist = self.artist)
|
|
|
|
def __eq__(self, other):
|
|
if self.id and other.id:
|
|
return self.id == other.id
|
|
if self.mbid and other.mbid:
|
|
return self.mbid == other.mbid
|
|
if self.url and other.url:
|
|
return self.url == other.url
|
|
if (self.name and self.artist) and (other.name and other.artist):
|
|
return (self.name == other.name) and (self.artist == other.artist)
|
|
return super(Album, self).__eq__(other)
|
|
|
|
def __lt__(self, other):
|
|
return self.name < other.name
|
|
|
|
def __repr__(self):
|
|
return "<lastfm.Album: '%s' by %s>" % (self.name, self.artist.name)
|
|
|
|
|
|
from datetime import datetime
|
|
import time
|
|
|
|
from lastfm.api import Api
|
|
from lastfm.artist import Artist
|
|
from lastfm.error import InvalidParametersError
|
|
from lastfm.playlist import Playlist
|
|
from lastfm.stats import Stats
|
|
from lastfm.tag import Tag |