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
|
# -*- coding: utf-8 -*-
# Copyright (c) 2009-2014, 2021 kaliko <kaliko@azylum.org>
#
# 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
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
#
"""
Consume Last.fm web service
"""
__version__ = '0.5.2'
__author__ = 'Jack Kaliko'
from sima import LFM
from sima.lib.meta import Artist
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)
class SimaFM:
"""Last.fm http client
"""
root_url = 'http://{host}/{version}/'.format(**LFM)
name = 'Last.fm'
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):
self.http = HttpClient(cache=self.cache, stats=self.stats)
self.artist = None
def _controls_answer(self, ans):
"""Controls answer.
"""
if 'error' in ans:
code = ans.get('error')
mess = ans.get('message')
if code == 6:
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',},
})
payload = payloads.get(method)
payload.update(api_key=LFM.get('apikey'), format='json')
if not isinstance(artist, Artist):
raise TypeError(f'"{artist!r}" not an Artist object')
self.artist = artist
if artist.mbid:
payload.update(mbid=f'{artist.mbid}')
else:
payload.update(artist=artist.name,
autocorrect=1)
payload.update(limit=100)
if method == 'track':
payload.update(track=track)
# > 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):
"""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.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.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
|
