X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fsimafm.py;h=cc70cf7bcac4d0989dbb992425be4c6c37ccc1f2;hb=df9f0f9dae0f8712f672b4eb7f4211e62f6c2e21;hp=d01567ea05435ea03c938fba99e64dabaccd3342;hpb=cdb998d12265ec4e1f64c87cff22a8657e2a93ea;p=mpd-sima.git diff --git a/sima/lib/simafm.py b/sima/lib/simafm.py index d01567e..cc70cf7 100644 --- a/sima/lib/simafm.py +++ b/sima/lib/simafm.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2014 Jack Kaliko +# Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Jack 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,65 +18,56 @@ # """ -Consume EchoNest web service +Consume Last.fm web service """ -__version__ = '0.0.1' +__version__ = '0.5.1' __author__ = 'Jack Kaliko' -from datetime import datetime, timedelta +from datetime import timedelta -from requests import get, Request, Timeout, ConnectionError +from requests import Session, Request, Timeout, ConnectionError from sima import LFM from sima.lib.meta import Artist -from sima.utils.utils import getws, Throttle, Cache, purge_cache + +from sima.lib.http import CacheController +from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError +from sima.utils.utils import getws, Throttle if len(LFM.get('apikey')) == 43: # simple hack allowing imp.reload getws(LFM) # Some definitions -WAIT_BETWEEN_REQUESTS = timedelta(0, 1) -SOCKET_TIMEOUT = 4 - - -class WSError(Exception): - pass - -class WSNotFound(WSError): - pass - -class WSTimeout(WSError): - pass - -class WSHTTPError(WSError): - pass +WAIT_BETWEEN_REQUESTS = timedelta(0, 2) +SOCKET_TIMEOUT = 6 - -class SimaFM(): - """ +class SimaFM: + """Last.fm http client """ root_url = 'http://{host}/{version}/'.format(**LFM) + ratelimit = None + name = 'Last.fm' cache = {} - timestamp = datetime.utcnow() - #ratelimit = None def __init__(self, cache=True): + self.controller = CacheController(self.cache) 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 + """ + Prepare http request + Use cached elements or proceed http request + """ + req = Request('GET', SimaFM.root_url, params=payload, + ).prepare() + if self.cache: + cached_response = self.controller.cached_request(req.url, req.headers) + if cached_response: + return cached_response.json() try: - self._fetch_ech(payload) + return self._fetch_ws(req) except Timeout: raise WSTimeout('Failed to reach server within {0}s'.format( SOCKET_TIMEOUT)) @@ -84,32 +75,32 @@ class SimaFM(): raise WSError(err) @Throttle(WAIT_BETWEEN_REQUESTS) - def _fetch_ech(self, payload): + def _fetch_ws(self, prepreq): """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): + sess = Session() + resp = sess.send(prepreq, timeout=SOCKET_TIMEOUT) + #self.__class__.ratelimit = resp.headers.get('x-ratelimit-remaining', None) + if resp.status_code is not 200: + raise WSHTTPError('{0.status_code}: {0.reason}'.format(resp)) + ans = resp.json() + self._controls_answer(ans) + if self.cache: + self.controller.cache_response(resp.request, resp) + return ans + + 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',}, @@ -124,22 +115,32 @@ 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): - """ + """Fetch similar artists """ payload = self._forge_payload(artist) # Construct URL - self._fetch(payload) - for art in self.current_element.get('similarartists').get('artist'): - match = 100 * float(art.get('match')) - yield Artist(mbid=art.get('mbid', None), - name=art.get('name')), match + ans = self._fetch(payload) + # Artist might be found be 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.get('similarartists').get('artist') + if not isinstance(simarts, list): + raise WSError('Artist found but no similarities returned') + for art in ans.get('similarartists').get('artist'): + yield Artist(name=art.get('name'), mbid=art.get('mbid', None)) # VIM MODLINE