X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fsimafm.py;h=5103aceac9455a9ac5d8a39e8fc10f5812151b3f;hb=a260ebea93f23d72aa6e0178744b0f64c469b7ba;hp=cc70cf7bcac4d0989dbb992425be4c6c37ccc1f2;hpb=df9f0f9dae0f8712f672b4eb7f4211e62f6c2e21;p=mpd-sima.git diff --git a/sima/lib/simafm.py b/sima/lib/simafm.py index cc70cf7..5103ace 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, 2021 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 @@ -25,68 +25,34 @@ __version__ = '0.5.1' __author__ = 'Jack Kaliko' -from datetime import timedelta - -from requests import Session, Request, Timeout, ConnectionError - from sima import LFM from sima.lib.meta import Artist +from sima.lib.track import Track -from sima.lib.http import CacheController -from sima.utils.utils import WSError, WSNotFound, WSTimeout, WSHTTPError -from sima.utils.utils import getws, Throttle +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, 2) -SOCKET_TIMEOUT = 6 - class SimaFM: """Last.fm http client """ root_url = 'http://{host}/{version}/'.format(**LFM) - ratelimit = None name = 'Last.fm' - cache = {} + cache = False + """HTTP cache to use, in memory or persitent. - def __init__(self, cache=True): - self.controller = CacheController(self.cache) - self.artist = None + :param BaseCache cache: Set a cache, defaults to `False`. + """ + stats = {'etag': 0, + 'ccontrol': 0, + 'total': 0} - def _fetch(self, payload): - """ - 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: - return self._fetch_ws(req) - 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, prepreq): - """fetch from web service""" - 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 __init__(self): + self.http = HttpClient(cache=self.cache, stats=self.stats) + self.artist = None def _controls_answer(self, ans): """Controls answer. @@ -95,25 +61,25 @@ class SimaFM: code = ans.get('error') mess = ans.get('message') if code == 6: - raise WSNotFound('{0}: "{1}"'.format(mess, self.artist)) + raise WSNotFound(f'{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): - raise TypeError('"{0!r}" not an Artist object'.format(artist)) + raise TypeError(f'"{artist!r}" not an Artist object') self.artist = artist if artist.mbid: - payload.update(mbid='{0}'.format(artist.mbid)) + payload.update(mbid=f'{artist.mbid}') else: payload.update(artist=artist.name, autocorrect=1) @@ -124,24 +90,54 @@ class SimaFM: # 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 - ans = self._fetch(payload) - # Artist might be found be return no 'artist' list… + ans = self.http(self.root_url, payload) + try: + ans.json() + except ValueError as err: + # Corrupted/malformed cache? cf. gitlab issue #35 + raise WSError('Malformed json, try purging the cache: %s') from err + 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.get('similarartists').get('artist') + 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.get('similarartists').get('artist'): + 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