X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fsimafm.py;h=bd203f74f3330f1da06a0d7abd5d1f0c741e8a0b;hb=37dd60538984a3917354b794a5c96b0a025f8e95;hp=08fdbc3fe65e1655273a12cfe6d9d9874dbe7574;hpb=caff603bfa12a698d3063ea3489f333d9cafdbf0;p=mpd-sima.git diff --git a/sima/lib/simafm.py b/sima/lib/simafm.py index 08fdbc3..bd203f7 100644 --- a/sima/lib/simafm.py +++ b/sima/lib/simafm.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Jack Kaliko +# Copyright (c) 2009-2014 kaliko # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -18,92 +18,61 @@ # """ -Consume EchoNest web service +Consume Last.fm web service """ -__version__ = '0.5.0' +__version__ = '0.5.1' __author__ = 'Jack Kaliko' -from datetime import datetime, timedelta - -from requests import get, Request, Timeout, ConnectionError - from sima import LFM from sima.lib.meta import Artist -from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError -from sima.utils.utils import getws, Throttle, Cache, purge_cache +from sima.lib.track import Track + +from sima.lib.http import HttpClient +from sima.utils.utils import WSError, WSNotFound +from sima.utils.utils import getws if len(LFM.get('apikey')) == 43: # simple hack allowing imp.reload getws(LFM) -# Some definitions -WAIT_BETWEEN_REQUESTS = timedelta(0, 1) -SOCKET_TIMEOUT = 6 - -class SimaFM(): - """ +class SimaFM: + """Last.fm http client """ root_url = 'http://{host}/{version}/'.format(**LFM) - cache = {} - timestamp = datetime.utcnow() name = 'Last.fm' - ratelimit = None + cache = False + """HTTP cache to use, in memory or persitent. + + :param BaseCache cache: Set a cache, defaults to `False`. + """ + stats = {'etag': 0, + 'ccontrol': 0, + 'total': 0} - def __init__(self, cache=True): + def __init__(self): + self.http = HttpClient(cache=self.cache, stats=self.stats) self.artist = None - self._url = self.__class__.root_url - self.current_element = None - self.caching = cache - purge_cache(self.__class__) - - def _fetch(self, payload): - """Use cached elements or proceed http request""" - url = Request('GET', self._url, params=payload,).prepare().url - if url in SimaFM.cache: - self.current_element = SimaFM.cache.get(url).elem - return - try: - self._fetch_ws(payload) - except Timeout: - raise WSTimeout('Failed to reach server within {0}s'.format( - SOCKET_TIMEOUT)) - except ConnectionError as err: - raise WSError(err) - - @Throttle(WAIT_BETWEEN_REQUESTS) - def _fetch_ws(self, payload): - """fetch from web service""" - req = get(self._url, params=payload, - timeout=SOCKET_TIMEOUT) - #self.__class__.ratelimit = req.headers.get('x-ratelimit-remaining', None) - if req.status_code is not 200: - raise WSHTTPError(req.status_code) - self.current_element = req.json() - self._controls_answer() - if self.caching: - SimaFM.cache.update({req.url: - Cache(self.current_element)}) - - def _controls_answer(self): + + def _controls_answer(self, ans): """Controls answer. """ - if 'error' in self.current_element: - code = self.current_element.get('error') - mess = self.current_element.get('message') + if 'error' in ans: + code = ans.get('error') + mess = ans.get('message') if code == 6: raise WSNotFound('{0}: "{1}"'.format(mess, self.artist)) raise WSError(mess) return True def _forge_payload(self, artist, method='similar', track=None): + """Build payload """ - """ - payloads = dict({'similar': {'method':'artist.getsimilar',}, - 'top': {'method':'artist.gettoptracks',}, - 'track': {'method':'track.getsimilar',}, - 'info': {'method':'artist.getinfo',}, - }) + payloads = dict({'similar': {'method': 'artist.getsimilar',}, + 'top': {'method': 'artist.gettoptracks',}, + 'track': {'method': 'track.getsimilar',}, + 'info': {'method': 'artist.getinfo',}, + }) payload = payloads.get(method) payload.update(api_key=LFM.get('apikey'), format='json') if not isinstance(artist, Artist): @@ -112,21 +81,63 @@ class SimaFM(): if artist.mbid: payload.update(mbid='{0}'.format(artist.mbid)) else: - payload.update(artist=artist.name) + payload.update(artist=artist.name, + autocorrect=1) payload.update(results=100) if method == 'track': payload.update(track=track) - return payload + # > hashing the URL into a cache key + # return a sorted list of 2-tuple to have consistent cache + return sorted(payload.items(), key=lambda param: param[0]) - def get_similar(self, artist=None): - """ + def get_similar(self, artist): + """Fetch similar artists + + :param sima.lib.meta.Artist artist: `Artist` to fetch similar artists from + :returns: generator of :class:`sima.lib.meta.Artist` """ payload = self._forge_payload(artist) # Construct URL - self._fetch(payload) - for art in self.current_element.get('similarartists').get('artist'): + ans = self.http(self.root_url, payload) + try: + ans.json() + except ValueError: + # Corrupted/malformed cache? cf. gitlab issue #35 + raise WSError('Malformed json, try purging the cache: %s') + self._controls_answer(ans.json()) # pylint: disable=no-member + # Artist might be found but return no 'artist' list… + # cf. "Mulatu Astatqe" vs. "Mulatu Astatqé" with autocorrect=0 + # json format is broken IMHO, xml is more consistent IIRC + # Here what we got: + # >>> {"similarartists":{"#text":"\n","artist":"Mulatu Astatqe"}} + # autocorrect=1 should fix it, checking anyway. + simarts = ans.json().get('similarartists').get('artist') # pylint: disable=no-member + if not isinstance(simarts, list): + raise WSError('Artist found but no similarities returned') + for art in ans.json().get('similarartists').get('artist'): # pylint: disable=no-member yield Artist(name=art.get('name'), mbid=art.get('mbid', None)) + def get_toptrack(self, artist): + """Fetch artist top tracks + + :param sima.lib.meta.Artist artist: `Artist` to fetch top tracks from + :returns: generator of :class:`sima.lib.track.Track` + """ + payload = self._forge_payload(artist, method='top') + ans = self.http(self.root_url, payload) + self._controls_answer(ans.json()) # pylint: disable=no-member + tops = ans.json().get('toptracks').get('track') # pylint: disable=no-member + art = {'artist': artist.name, + 'musicbrainz_artistid': artist.mbid,} + for song in tops: + for key in ['artist', 'streamable', 'listeners', + 'url', 'image', '@attr']: + if key in song: + song.pop(key) + song.update(art) + song.update(title=song.pop('name')) + song.update(time=song.pop('duration', 0)) + yield Track(**song) # VIM MODLINE # vim: ai ts=4 sw=4 sts=4 expandtab