python-lastfm/docs/lastfm.album.Album-class.html
Abhinav Sarkar 636e9073ec * refactored the decorators to decorators module from base module
* fixed a bug in authenticate decorator which gave the authenticated results for non-authenticated users
* added documentation for decorators module
* added authenticate decorator to the methods in taggable and sharable mixin modules
* added set_secret and set_session_key methods in Api class
2009-03-10 06:09:11 +00:00

1192 lines
48 KiB
HTML

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>lastfm.album.Album</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="lastfm-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://code.google.com/p/python-lastfm/">python-lastfm</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="lastfm-module.html">Package&nbsp;lastfm</a> ::
<a href="lastfm.album-module.html" onclick="show_private();">Module&nbsp;album</a> ::
Class&nbsp;Album
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="lastfm.album.Album-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Album</h1><p class="nomargin-top"><span class="codelink"><a href="lastfm.album-pysrc.html#Album">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="lastfm.base.LastfmBase-class.html">base.LastfmBase</a> --+
|
object --+ |
| |
<a href="lastfm.mixins.cacheable.Cacheable-class.html">mixins.cacheable.Cacheable</a> --+
|
object --+ |
| |
<a href="lastfm.mixins.searchable.Searchable-class.html">mixins.searchable.Searchable</a> --+
|
object --+ |
| |
<a href="lastfm.mixins.taggable.Taggable-class.html">mixins.taggable.Taggable</a> --+
|
<strong class="uidshort">Album</strong>
</pre>
<hr />
<p>A class representing an album.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#init" class="summary-sig-name">init</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">api</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">id</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">mbid</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">url</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">release_date</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">image</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">stats</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">top_tags</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">streamable</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">subject</span>=<span class="summary-sig-default">None</span>)</span><br />
Create an Album object by providing all the data related to it.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.init">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#_default_params" class="summary-sig-name" onclick="show_private();">_default_params</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">extra_params</span>=<span class="summary-sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album._default_params">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_fill_info"></a><span class="summary-sig-name">_fill_info</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album._fill_info">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#__hash__" class="summary-sig-name">__hash__</a>(<span class="summary-sig-arg">self</span>)</span><br />
hash(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.__hash__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.__eq__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__lt__"></a><span class="summary-sig-name">__lt__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.__lt__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
repr(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.__repr__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__init__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.base.LastfmBase-class.html">base.LastfmBase</a></th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__ge__"></a><span class="summary-sig-name">__ge__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.base-pysrc.html#LastfmBase.__ge__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__gt__"></a><span class="summary-sig-name">__gt__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.base-pysrc.html#LastfmBase.__gt__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__le__"></a><span class="summary-sig-name">__le__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.base-pysrc.html#LastfmBase.__le__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__ne__"></a><span class="summary-sig-name">__ne__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.base-pysrc.html#LastfmBase.__ne__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.mixins.taggable.Taggable-class.html">mixins.taggable.Taggable</a></th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.mixins.taggable.Taggable-class.html#add_tags" class="summary-sig-name">add_tags</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.decorators-pysrc.html">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.mixins.taggable.Taggable-class.html#remove_tag" class="summary-sig-name">remove_tag</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.decorators-pysrc.html">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.mixins.searchable.Searchable-class.html">mixins.searchable.Searchable</a></th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="search"></a><span class="summary-sig-name">search</span>(<span class="summary-sig-arg">cls</span>,
<span class="summary-sig-arg">api</span>,
<span class="summary-sig-arg">search_item</span>,
<span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwds</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.mixins.searchable-pysrc.html#Searchable.search">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="lastfm.album.Album-class.html" class="link">Album</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#get_info" class="summary-sig-name">get_info</a>(<span class="summary-sig-arg">api</span>,
<span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">album</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">mbid</span>=<span class="summary-sig-default">None</span>)</span><br />
Get the data for the album.</td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album.get_info">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_fetch_data"></a><span class="summary-sig-name">_fetch_data</span>(<span class="summary-sig-arg">api</span>,
<span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">album</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">mbid</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album._fetch_data">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.album.Album-class.html#_search_yield_func" class="summary-sig-name" onclick="show_private();">_search_yield_func</a>(<span class="summary-sig-arg">api</span>,
<span class="summary-sig-arg">album</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album._search_yield_func">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_hash_func"></a><span class="summary-sig-name">_hash_func</span>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwds</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.album-pysrc.html#Album._hash_func">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.mixins.cacheable.Cacheable-class.html">mixins.cacheable.Cacheable</a></th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">a new object with type S, a subtype of T</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lastfm.mixins.cacheable.Cacheable-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">cls</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwds</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.mixins.cacheable-pysrc.html#Cacheable.__new__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="register"></a><span class="summary-sig-name">register</span>(<span class="summary-sig-arg">ob</span>,
<span class="summary-sig-arg">key</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lastfm.mixins.cacheable-pysrc.html#Cacheable.register">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.mixins.cacheable.Cacheable-class.html">mixins.cacheable.Cacheable</a></th></tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="_lock"></a><span class="summary-name">_lock</span> = <code title="Lock()">Lock()</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="registry"></a><span class="summary-name">registry</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">str</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#name" class="summary-name">name</a><br />
name of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="lastfm.artist.Artist-class.html" class="link">Artist</a></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#artist" class="summary-name">artist</a><br />
artist of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">int</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#id" class="summary-name">id</a><br />
id of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">str</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#mbid" class="summary-name">mbid</a><br />
MBID of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">str</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#url" class="summary-name">url</a><br />
url of the album's page
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>datetime.datetime</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#release_date" class="summary-name">release_date</a><br />
release date of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">dict</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#image" class="summary-name">image</a><br />
cover images of the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="lastfm.stats.Stats-class.html" class="link">Stats</a></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#stats" class="summary-name">stats</a><br />
stats related to the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">bool</code></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#streamable" class="summary-name">streamable</a><br />
is the album streamable on last.fm
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code class="link">list</code> of <a href="lastfm.tag.Tag-class.html"
class="link">Tag</a></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#top_tags" class="summary-name">top_tags</a><br />
top tags for the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="lastfm.tag.Tag-class.html" class="link">Tag</a></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#top_tag" class="summary-name">top_tag</a><br />
top tag for the album
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="lastfm.playlist.Playlist-class.html"
class="link">Playlist</a></span>
</td><td class="summary">
<a href="lastfm.album.Album-class.html#playlist" class="summary-name">playlist</a><br />
playlist for the album
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
>&nbsp;&nbsp;&nbsp;&nbsp;Inherited from <a href="lastfm.mixins.taggable.Taggable-class.html">mixins.taggable.Taggable</a></th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="lastfm.mixins.taggable.Taggable-class.html#tags" class="summary-name">tags</a>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="init"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">init</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">api</span>,
<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">artist</span>=<span class="sig-default">None</span>,
<span class="sig-arg">id</span>=<span class="sig-default">None</span>,
<span class="sig-arg">mbid</span>=<span class="sig-default">None</span>,
<span class="sig-arg">url</span>=<span class="sig-default">None</span>,
<span class="sig-arg">release_date</span>=<span class="sig-default">None</span>,
<span class="sig-arg">image</span>=<span class="sig-default">None</span>,
<span class="sig-arg">stats</span>=<span class="sig-default">None</span>,
<span class="sig-arg">top_tags</span>=<span class="sig-default">None</span>,
<span class="sig-arg">streamable</span>=<span class="sig-default">None</span>,
<span class="sig-arg">subject</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album.init">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Create an Album object by providing all the data related to it.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>api</code></strong> (<a href="lastfm.api.Api-class.html" class="link">Api</a>) - an instance of <a href="lastfm.api.Api-class.html"
class="link">Api</a></li>
<li><strong class="pname"><code>name</code></strong> (<code class="link">str</code>) - the album name</li>
<li><strong class="pname"><code>artist</code></strong> (<a href="lastfm.artist.Artist-class.html" class="link">Artist</a>) - the album artist name</li>
<li><strong class="pname"><code>id</code></strong> (<code class="link">str</code>) - the album ID</li>
<li><strong class="pname"><code>mbid</code></strong> (<code class="link">str</code>) - MBID of the album</li>
<li><strong class="pname"><code>url</code></strong> (<code class="link">str</code>) - URL of the album on last.fm</li>
<li><strong class="pname"><code>release_date</code></strong> (<code>datetime.datetime</code>) - release date of the album</li>
<li><strong class="pname"><code>image</code></strong> (<code class="link">dict</code>) - the cover images of the album in various sizes</li>
<li><strong class="pname"><code>stats</code></strong> (<a href="lastfm.stats.Stats-class.html" class="link">Stats</a>) - the album statistics</li>
<li><strong class="pname"><code>top_tags</code></strong> (<code class="link">list</code> of <a
href="lastfm.tag.Tag-class.html" class="link">Tag</a>) - top tags for the album</li>
<li><strong class="pname"><code>streamable</code></strong> (<code class="link">bool</code>) - flag indicating if the album is streamable from last.fm</li>
<li><strong class="pname"><code>subject</code></strong> (<a href="lastfm.user.User-class.html" class="link">User</a> OR <a
href="lastfm.artist.Artist-class.html" class="link">Artist</a> OR
<a href="lastfm.tag.Tag-class.html" class="link">Tag</a> OR <a
href="lastfm.weeklychart.WeeklyChart-class.html"
class="link">WeeklyChart</a>) - the subject to which this instance belongs to</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="lastfm.error.InvalidParametersError-class.html">InvalidParametersError</a></strong></code> - If an instance of <a href="lastfm.api.Api-class.html"
class="link">Api</a> is not provided as the first parameter then an
Exception is raised.</li>
</ul></dd>
<dt>Overrides:
<a href="lastfm.mixins.taggable.Taggable-class.html#init">mixins.taggable.Taggable.init</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="get_info"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_info</span>(<span class="sig-arg">api</span>,
<span class="sig-arg">artist</span>=<span class="sig-default">None</span>,
<span class="sig-arg">album</span>=<span class="sig-default">None</span>,
<span class="sig-arg">mbid</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album.get_info">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Get the data for the album.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>api</code></strong> (<a href="lastfm.api.Api-class.html" class="link">Api</a>) - an instance of <a href="lastfm.api.Api-class.html"
class="link">Api</a></li>
<li><strong class="pname"><code>artist</code></strong> (<code class="link">str</code> OR <a
href="lastfm.artist.Artist-class.html" class="link">Artist</a>) - the album artist name</li>
<li><strong class="pname"><code>album</code></strong> (<code class="link">str</code>) - the album name</li>
<li><strong class="pname"><code>mbid</code></strong> (<code class="link">str</code>) - MBID of the album</li>
</ul></dd>
<dt>Returns: <a href="lastfm.album.Album-class.html" class="link">Album</a></dt>
<dd>an Album object corresponding the provided album name</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="lastfm.error.InvalidParametersError-class.html">lastfm.InvalidParametersError</a></strong></code> - Either album and artist parameters or mbid parameter has to be
provided. Otherwise exception is raised.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Note:</strong>
Use the <a href="lastfm.api.Api-class.html#get_album"
class="link">Api.get_album</a> method instead of using this method
directly.
</p>
</div></td></tr></table>
</div>
<a name="_default_params"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_default_params</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">extra_params</span>=<span class="sig-default"><code class="variable-group">{</code><code class="variable-group">}</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album._default_params">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="lastfm.mixins.taggable.Taggable-class.html#_default_params" onclick="show_private();">mixins.taggable.Taggable._default_params</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_search_yield_func"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_search_yield_func</span>(<span class="sig-arg">api</span>,
<span class="sig-arg">album</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album._search_yield_func">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="lastfm.mixins.searchable.Searchable-class.html#_search_yield_func" onclick="show_private();">mixins.searchable.Searchable._search_yield_func</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__hash__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__hash__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Hashing function)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album.__hash__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>hash(x)</p>
<dl class="fields">
<dt>Overrides:
object.__hash__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lastfm.album-pysrc.html#Album.__repr__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>repr(x)</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Property Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-PropertyDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">name</h3>
<p>name of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.name(<span class="summary-sig-arg">self</span>)</span>
- name of the album
</dd>
<dt>Type:</dt>
<dd><code class="link">str</code></dd>
</dl>
</td></tr></table>
</div>
<a name="artist"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">artist</h3>
<p>artist of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.artist(<span class="summary-sig-arg">self</span>)</span>
- artist of the album
</dd>
<dt>Type:</dt>
<dd><a href="lastfm.artist.Artist-class.html" class="link">Artist</a></dd>
</dl>
</td></tr></table>
</div>
<a name="id"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">id</h3>
<p>id of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.id(<span class="summary-sig-arg">self</span>)</span>
- id of the album
</dd>
<dt>Type:</dt>
<dd><code class="link">int</code></dd>
</dl>
</td></tr></table>
</div>
<a name="mbid"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">mbid</h3>
<p>MBID of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.mbid(<span class="summary-sig-arg">self</span>)</span>
- MBID of the album
</dd>
<dt>Type:</dt>
<dd><code class="link">str</code></dd>
</dl>
</td></tr></table>
</div>
<a name="url"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">url</h3>
<p>url of the album's page</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.url(<span class="summary-sig-arg">self</span>)</span>
- url of the album's page
</dd>
<dt>Type:</dt>
<dd><code class="link">str</code></dd>
</dl>
</td></tr></table>
</div>
<a name="release_date"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">release_date</h3>
<p>release date of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.release_date(<span class="summary-sig-arg">self</span>)</span>
- release date of the album
</dd>
<dt>Type:</dt>
<dd><code>datetime.datetime</code></dd>
</dl>
</td></tr></table>
</div>
<a name="image"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">image</h3>
<p>cover images of the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.image(<span class="summary-sig-arg">self</span>)</span>
- cover images of the album
</dd>
<dt>Type:</dt>
<dd><code class="link">dict</code></dd>
</dl>
</td></tr></table>
</div>
<a name="stats"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">stats</h3>
<p>stats related to the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.stats(<span class="summary-sig-arg">self</span>)</span>
- stats related to the album
</dd>
<dt>Type:</dt>
<dd><a href="lastfm.stats.Stats-class.html" class="link">Stats</a></dd>
</dl>
</td></tr></table>
</div>
<a name="streamable"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">streamable</h3>
<p>is the album streamable on last.fm</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.streamable(<span class="summary-sig-arg">self</span>)</span>
- is the album streamable on last.fm
</dd>
<dt>Type:</dt>
<dd><code class="link">bool</code></dd>
</dl>
</td></tr></table>
</div>
<a name="top_tags"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">top_tags</h3>
<p>top tags for the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.wrapper(<span class="summary-sig-arg">ob</span>)</span>
</dd>
<dt>Type:</dt>
<dd><code class="link">list</code> of <a href="lastfm.tag.Tag-class.html"
class="link">Tag</a></dd>
</dl>
</td></tr></table>
</div>
<a name="top_tag"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">top_tag</h3>
<p>top tag for the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.wrapper(<span class="summary-sig-arg">ob</span>)</span>
</dd>
<dt>Type:</dt>
<dd><a href="lastfm.tag.Tag-class.html" class="link">Tag</a></dd>
</dl>
</td></tr></table>
</div>
<a name="playlist"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">playlist</h3>
<p>playlist for the album</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.wrapper(<span class="summary-sig-arg">ob</span>)</span>
</dd>
<dt>Type:</dt>
<dd><a href="lastfm.playlist.Playlist-class.html"
class="link">Playlist</a></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="lastfm-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://code.google.com/p/python-lastfm/">python-lastfm</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Tue Mar 10 11:14:34 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>