diff --git a/docs/api-objects.txt b/docs/api-objects.txt index 78fee03..5c252d3 100644 --- a/docs/api-objects.txt +++ b/docs/api-objects.txt @@ -670,6 +670,7 @@ lastfm.user.User.Playlist lastfm.user.User.Playlist-class.html lastfm.base.LastfmBase.__ne__ lastfm.base.LastfmBase-class.html#__ne__ lastfm.user.User.library lastfm.user.User-class.html#library lastfm.user.User.top_album lastfm.user.User-class.html#top_album +lastfm.user.User.get_info lastfm.user.User-class.html#get_info lastfm.user.User.get_weekly_album_chart lastfm.user.User-class.html#get_weekly_album_chart lastfm.user.User.top_tag lastfm.user.User-class.html#top_tag lastfm.user.User.get_top_tracks lastfm.user.User-class.html#get_top_tracks diff --git a/docs/class-tree.html b/docs/class-tree.html index 4012e41..8438e85 100644 --- a/docs/class-tree.html +++ b/docs/class-tree.html @@ -360,7 +360,7 @@ @@ -1847,7 +1848,7 @@
- Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:24 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:40 2009 - + - + - + + + + + + - + - + - + - + - + - + - @@ -443,39 +451,39 @@ (in User) - + - + - + - + - @@ -483,20 +491,13 @@ (in lastfm) - + - - - - -
- Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:24 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:40 2009 (in User) get_info()
(in Artist)		get_top_tracks()
-(in Geo)		get_top_tracks()
+(in Country)
geo
(in lastfm)		 get_info()
(in Event)		get_top_tracks()
-(in User)		get_top_tracks()
+(in Geo)
Geo
(in lastfm.geo)		 get_info()
(in Track)		get_track()
-(in Api)		get_top_tracks()
+(in User)
Get()
(in FileCache)		get_info()
+(in User)		get_track()
+(in Api)
get_album()
+(in Api)		 get_location()
(in Api)		 get_tracks()
(in Library)
get_album()
-(in Api)		get_albums()
+(in Library)		 get_neighbours()
(in User)		 get_user()
(in Api)
get_albums()
-(in Library)		get_artist()
+(in Api)		 get_past_events()
(in User)		 get_venue()
(in Api)
get_artist()
-(in Api)		get_artists()
+(in Library)		 get_past_events()
(in Venue)		 get_weekly_album_chart()
(in Group)
get_artists()
-(in Library)		get_authenticated_user()
+(in Api)		 get_playlist()
(in Api)		 get_weekly_album_chart()
(in User)
get_authenticated_user()
-(in Api)		get_authenticated_user()
+(in User)		 get_recent_tracks()
(in User)		 get_weekly_artist_chart()
(in Group)
get_authenticated_user()
-(in User)		get_country()
+(in Api)		 get_recommended_events()
(in User)		 get_weekly_artist_chart()
(in Tag)
get_country()
+		get_event()
(in Api)		 get_similar()
(in Artist)
get_event()
-(in Api)		get_events()
+(in Geo)		 get_tag()
(in Api)		 get_weekly_tag_chart()
(in User)
get_events()
-(in Geo)		get_events()
+(in Location)		 get_top_albums()
(in User)		 get_weekly_track_chart()
(in Group)
get_events()
-(in Location)		get_friends()
+(in User)		 get_top_artists()
(in Geo)		 get_weekly_track_chart()
(in User)
get_friends()
-(in User)		get_global_top_tags()
+(in Api)		 get_top_artists()
(in User)		 GetCachedTime()
(in FileCache)
get_global_top_tags()
+		get_group()
(in Api)		 get_top_tags()
(in Tag)
get_group()
-(in Api)		get_info()
+(in Album)		 get_top_tags()
(in User)		 Group
(in lastfm.group)
get_info()
-(in Album)		get_top_tracks()
-(in Country)		 

H

- Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:24 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:40 2009
  • lastfm.album: Module for calling Album related last.fm web services API methods
  • lastfm.api: The last.fm web service API access functionalities
    • -
  • lastfm.artist
    • +
  • lastfm.artist: Module for calling Artist related last.fm web services API methods
  • lastfm.base
  • lastfm.error
  • lastfm.event
    • @@ -320,7 +320,7 @@
    - Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:24 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:40 2009
    - Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:28 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:43 2009
    - Generated by Epydoc 3.0.1 on Thu Mar 05 10:03:24 2009 + Generated by Epydoc 3.0.1 on Mon Mar 09 17:56:40 2009 43 @type image: L{dict} 44 @param stats: the album statistics 45 @type stats: L{Stats} - 46 @param top_tags: top tags of the album + 46 @param top_tags: top tags for the album 47 @type top_tags: L{list} of L{Tag} - 48 @param streamable: flag indicating if the album is streamable + 48 @param streamable: flag indicating if the album is streamable from last.fm 49 @type streamable: L{bool} 50 51 @raise InvalidParametersError: If an instance of L{Api} is not provided as the first @@ -255,7 +255,7 @@ lastfm.track.Track._fill_info" class="py-name" href="#" onclick="return doclink( 101 @property
    102 - def mbid(self):
    103 """ -104 mbid of the album +104 MBID of the album 105 @rtype: L{str} 106 """ 107 if self._mbid is None: @@ -315,7 +315,7 @@ lastfm.track.Track._fill_info" class="py-name" href="#" onclick="return doclink( 151 @property
    152 - def streamable(self):
    153 """ -154 is the album streamable +154 is the album streamable on last.fm 155 @rtype: L{bool} 156 """ 157 return self._streamable @@ -412,32 +412,29 @@ lastfm.user.User.Playlist.id lastfm.venue.Venue.id" class="py-name" href="#" onclick="return doclink('link-64', 'id', 'link-17');">id)
    196 197 @staticmethod -
    198 - def get_info(api, -199 artist = None, -200 album = None, -201 mbid = None): -
    202 """ -203 Get the data for the album. -204 -205 @param api: an instance of L{Api} -206 @type api: L{Api} -207 @param artist: the album artist name -208 @type artist: L{str} OR L{Artist} -209 @param album: the album name -210 @type album: L{str} -211 @param mbid: MBID of the album -212 @type mbid: L{str} +
    198 - def get_info(api, artist = None, album = None, mbid = None): +
    199 """ +200 Get the data for the album. +201 +202 @param api: an instance of L{Api} +203 @type api: L{Api} +204 @param artist: the album artist name +205 @type artist: L{str} OR L{Artist} +206 @param album: the album name +207 @type album: L{str} +208 @param mbid: MBID of the album +209 @type mbid: L{str} +210 +211 @return: an Album object corresponding the provided album name +212 @rtype: L{Album} 213 -214 @return: an Album object corresponding the provided album name -215 @rtype: L{Album} -216 -217 @raise lastfm.InvalidParametersError: Either album and artist parameters or -218 mbid parameter has to be provided. -219 Otherwise exception is raised. -220 -221 @note: Use the L{Api.get_album} method instead of using this method directly. -222 """ -223 data = Album.214 @raise lastfm.InvalidParametersError: Either album and artist parameters or +215 mbid parameter has to be provided. +216 Otherwise exception is raised. +217 +218 @note: Use the L{Api.get_album} method instead of using this method directly. +219 """ +220 data = Album._fetch_data(api, album, mbid) -224 a = Album( -225 api, -226 221 a = Album( +222 api, +223 name = data.findtext('name'), -227 224 artist = Artist( -228 api, -229 225 api, +226 name = data.findtext('artist'), -230 ), -231 ) -232 a.227 ), +228 ) +229 a._fill_info() -233 return a -
    234 -
    235 - def _default_params(self, extra_params = {}): -
    236 if not (self.230 return a +
    231 +
    232 - def _default_params(self, extra_params = {}): +
    233 if not (self.artist and self.name): -237 raise InvalidParametersError("artist and album have to be provided.") -238 params = {'artist': self.234 raise InvalidParametersError("artist and album have to be provided.") +235 params = {'artist': self.artist.name} -239 params.update(extra_params) -240 return params -
    241 -242 @staticmethod -
    243 - def _fetch_data(api, -244 artist = None, -245 album = None, -246 mbid = None): -
    247 params = {'method': 'album.getInfo'} -248 if not ((236 params.update(extra_params) +237 return params +
    238 +239 @staticmethod +
    240 - def _fetch_data(api, +241 artist = None, +242 album = None, +243 mbid = None): +
    244 params = {'method': 'album.getInfo'} +245 if not ((artist and album) or mbid): -249 raise InvalidParametersError("either (artist and album) or mbid has to be given as argument.") -250 if 246 raise InvalidParametersError("either (artist and album) or mbid has to be given as argument.") +247 if artist and album: -251 params.update({'artist': 248 params.update({'artist': artist, 'album': album}) -252 elif 249 elif mbid: -253 params.update({'mbid': 250 params.update({'mbid': mbid}) -254 return api.251 return api._fetch_data(params).find('album') -
    255 -
    256 - def _fill_info(self): -
    257 data = Album.252 +
    253 - def _fill_info(self): +
    254 data = Album._fetch_data(self._api, self.name) -258 self._id = int(data.findtext('id')) -259 self._mbid = data.findtext('mbid') -260 self._url = data.findtext('url') -261 self._release_date = data.findtext('releasedate') and data.findtext('releasedate').strip() and \ -262 datetime(*(time.strptime(data.findtext('releasedate').strip(), '%d %b %Y, 00:00')[0:6])) -263 self._image = dict([(i.get('size'), i.text) for i in data.findall('image')]) -264 if not self._stats: -265 self._stats = Stats( -266 255 self._id = int(data.findtext('id')) +256 self._mbid = data.findtext('mbid') +257 self._url = data.findtext('url') +258 self._release_date = data.findtext('releasedate') and data.findtext('releasedate').strip() and \ +259 datetime(*(time.strptime(data.findtext('releasedate').strip(), '%d %b %Y, 00:00')[0:6])) +260 self._image = dict([(i.get('size'), i.text) for i in data.findall('image')]) +261 if not self._stats: +262 self._stats = Stats( +263 subject = self, -267 listeners = int(data.findtext('listeners')), -268 playcount = int(data.findtext('playcount')), -269 ) -270 self._top_tags = [ -271 Tag( -272 self._api, -273 264 listeners = int(data.findtext('listeners')), +265 playcount = int(data.findtext('playcount')), +266 ) +267 self._top_tags = [ +268 Tag( +269 self._api, +270 subject = self, -274 271 name = t.findtext('name'), -275 272 url = t.findtext('url') -276 ) -277 for t in data.findall('toptags/tag') -278 ] -
    279 -280 @staticmethod -
    281 - def _search_yield_func(api, album): -
    282 return Album( -283 api, -284 273 ) +274 for t in data.findall('toptags/tag') +275 ] +
    276 +277 @staticmethod +
    278 - def _search_yield_func(api, album): +
    279 return Album( +280 api, +281 name = album.findtext('name'), -285 282 artist = Artist( -286 api, -287 283 api, +284 name = album.findtext('artist') -288 ), -289 285 ), +286 id = int(album.findtext('id')), -290 287 url = album.findtext('url'), -291 288 image = dict([(i.get('size'), i.text) for i in album.findall('image')]), -292 289 streamable = (album.findtext('streamable') == '1'), -293 ) -
    294 -295 @staticmethod -
    296 - def _hash_func(*args, **kwds): -
    297 try: -298 return hash("%s%s" % (kwds['name'], hash(kwds['artist']))) -299 except KeyError: -300 raise InvalidParametersError("name and artist have to be provided for hashing") -
    301 -
    302 - def __hash__(self): -
    303 return self.__class__.290 ) +
    291 +292 @staticmethod +
    293 - def _hash_func(*args, **kwds): +
    294 try: +295 return hash("%s%s" % (kwds['name'], hash(kwds['artist']))) +296 except KeyError: +297 raise InvalidParametersError("name and artist have to be provided for hashing") +
    298 +
    299 - def __hash__(self): +
    300 return self.__class__.artist = self.artist) -
    304 -
    305 - def __eq__(self, other): -
    306 if self.301 +
    302 - def __eq__(self, other): +
    303 if self.id: -307 return self.304 return self.id -308 if self.305 if self.mbid and other.mbid: -309 return self.306 return self.mbid == other.mbid -310 if self.307 if self.url: -311 return self.308 return self.url -312 if (self.309 if (self.name and other.artist): -313 return (self.310 return (self.artist == other.artist) -314 return super(Album, self).311 return super(Album, self).__eq__(other) -
    315 -
    316 - def __lt__(self, other): -
    317 return self.312 +
    313 - def __lt__(self, other): +
    314 return self.name -
    318 -
    319 - def __repr__(self): -
    320 return "<lastfm.Album: '%s' by %s>" % (self.315 +
    316 - def __repr__(self): +
    317 return "<lastfm.Album: '%s' by %s>" % (self.name) -
    321 -322 -323 from datetime import datetime -324 import time -325 -326 from lastfm.api import Api -327 from lastfm.318 +319 +320 from datetime import datetime +321 import time +322 +323 from lastfm.api import Api +324 from lastfm.artist import Artist -328 from lastfm.error import InvalidParametersError -329 from lastfm.325 from lastfm.error import InvalidParametersError +326 from lastfm.playlist import Playlist -330 from lastfm.327 from lastfm.stats import Stats -331 from lastfm.328 from lastfm.tag import Tag -332