]> kaliko git repositories - mpd-sima.git/blobdiff - sima/lib/simafm.py
Update copyright
[mpd-sima.git] / sima / lib / simafm.py
index 267a2f74840114fb3997d7fff795fa4cbf0ddc51..2d0ea38158d2294f0a727d9ee3c3455921426ff0 100644 (file)
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2014 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
@@ -43,6 +43,10 @@ class SimaFM:
     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}
@@ -87,8 +91,11 @@ 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
@@ -106,8 +113,11 @@ class SimaFM:
         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=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)
@@ -122,7 +132,7 @@ class SimaFM:
                     song.pop(key)
             song.update(art)
             song.update(title=song.pop('name'))
-            song.update(time=song.pop('duration'))
+            song.update(time=song.pop('duration', 0))
             yield Track(**song)
 
 # VIM MODLINE