PageRenderTime 42ms CodeModel.GetById 2ms app.highlight 23ms RepoModel.GetById 1ms app.codeStats 1ms

/apidocs/pyechonest.decorators.memoized-class.html

http://echo-nest-remix.googlecode.com/
HTML | 305 lines | 260 code | 23 blank | 22 comment | 0 complexity | 69bc6d48d092d7d1eaf1beea631eea47 MD5 | raw file
  1<?xml version="1.0" encoding="ascii"?>
  2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3          "DTD/xhtml1-transitional.dtd">
  4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5<head>
  6  <title>pyechonest.decorators.memoized</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
 43        <a href="pyechonest.decorators-module.html">Module&nbsp;decorators</a> ::
 44        Class&nbsp;memoized
 45      </span>
 46    </td>
 47    <td>
 48      <table cellpadding="0" cellspacing="0">
 49        <!-- hide/show private -->
 50        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 51    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 52        <tr><td align="right"><span class="options"
 53            >[<a href="frames.html" target="_top">frames</a
 54            >]&nbsp;|&nbsp;<a href="pyechonest.decorators.memoized-class.html"
 55            target="_top">no&nbsp;frames</a>]</span></td></tr>
 56      </table>
 57    </td>
 58  </tr>
 59</table>
 60<!-- ==================== CLASS DESCRIPTION ==================== -->
 61<h1 class="epydoc">Class memoized</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized">source&nbsp;code</a></span></p>
 62<center>
 63
 64</center>
 65<hr />
 66<pre class="literalblock">
 67Decorator that caches a function's return value each time it is called.
 68If called later with the same arguments, the cached value is returned, and
 69not re-evaluated.
 70
 71</pre>
 72
 73<!-- ==================== INSTANCE METHODS ==================== -->
 74<a name="section-InstanceMethods"></a>
 75<table class="summary" border="1" cellpadding="3"
 76       cellspacing="0" width="100%" bgcolor="white">
 77<tr bgcolor="#70b0f0" class="table-header">
 78  <td colspan="2" class="table-header">
 79    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 80      <tr valign="top">
 81        <td align="left"><span class="table-header">Instance Methods</span></td>
 82        <td align="right" valign="top"
 83         ><span class="options">[<a href="#section-InstanceMethods"
 84         class="privatelink" onclick="toggle_private();"
 85         >hide private</a>]</span></td>
 86      </tr>
 87    </table>
 88  </td>
 89</tr>
 90<tr>
 91    <td width="15%" align="right" valign="top" class="summary">
 92      <span class="summary-type">&nbsp;</span>
 93    </td><td class="summary">
 94      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 95        <tr>
 96          <td><span class="summary-sig"><a href="pyechonest.decorators.memoized-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 97        <span class="summary-sig-arg">func</span>)</span><br />
 98      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 99          <td align="right" valign="top">
100            <span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized.__init__">source&nbsp;code</a></span>
101            
102          </td>
103        </tr>
104      </table>
105      
106    </td>
107  </tr>
108<tr>
109    <td width="15%" align="right" valign="top" class="summary">
110      <span class="summary-type">&nbsp;</span>
111    </td><td class="summary">
112      <table width="100%" cellpadding="0" cellspacing="0" border="0">
113        <tr>
114          <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
115        <span class="summary-sig-arg">*args</span>)</span></td>
116          <td align="right" valign="top">
117            <span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized.__call__">source&nbsp;code</a></span>
118            
119          </td>
120        </tr>
121      </table>
122      
123    </td>
124  </tr>
125<tr>
126    <td width="15%" align="right" valign="top" class="summary">
127      <span class="summary-type">&nbsp;</span>
128    </td><td class="summary">
129      <table width="100%" cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td><span class="summary-sig"><a href="pyechonest.decorators.memoized-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
132      Return the function's docstring.</td>
133          <td align="right" valign="top">
134            <span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized.__repr__">source&nbsp;code</a></span>
135            
136          </td>
137        </tr>
138      </table>
139      
140    </td>
141  </tr>
142  <tr>
143    <td colspan="2" class="summary">
144    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
145      <code>__delattr__</code>,
146      <code>__format__</code>,
147      <code>__getattribute__</code>,
148      <code>__hash__</code>,
149      <code>__new__</code>,
150      <code>__reduce__</code>,
151      <code>__reduce_ex__</code>,
152      <code>__setattr__</code>,
153      <code>__sizeof__</code>,
154      <code>__str__</code>,
155      <code>__subclasshook__</code>
156      </p>
157    </td>
158  </tr>
159</table>
160<!-- ==================== PROPERTIES ==================== -->
161<a name="section-Properties"></a>
162<table class="summary" border="1" cellpadding="3"
163       cellspacing="0" width="100%" bgcolor="white">
164<tr bgcolor="#70b0f0" class="table-header">
165  <td colspan="2" class="table-header">
166    <table border="0" cellpadding="0" cellspacing="0" width="100%">
167      <tr valign="top">
168        <td align="left"><span class="table-header">Properties</span></td>
169        <td align="right" valign="top"
170         ><span class="options">[<a href="#section-Properties"
171         class="privatelink" onclick="toggle_private();"
172         >hide private</a>]</span></td>
173      </tr>
174    </table>
175  </td>
176</tr>
177  <tr>
178    <td colspan="2" class="summary">
179    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
180      <code>__class__</code>
181      </p>
182    </td>
183  </tr>
184</table>
185<!-- ==================== METHOD DETAILS ==================== -->
186<a name="section-MethodDetails"></a>
187<table class="details" border="1" cellpadding="3"
188       cellspacing="0" width="100%" bgcolor="white">
189<tr bgcolor="#70b0f0" class="table-header">
190  <td colspan="2" class="table-header">
191    <table border="0" cellpadding="0" cellspacing="0" width="100%">
192      <tr valign="top">
193        <td align="left"><span class="table-header">Method Details</span></td>
194        <td align="right" valign="top"
195         ><span class="options">[<a href="#section-MethodDetails"
196         class="privatelink" onclick="toggle_private();"
197         >hide private</a>]</span></td>
198      </tr>
199    </table>
200  </td>
201</tr>
202</table>
203<a name="__init__"></a>
204<div>
205<table class="details" border="1" cellpadding="3"
206       cellspacing="0" width="100%" bgcolor="white">
207<tr><td>
208  <table width="100%" cellpadding="0" cellspacing="0" border="0">
209  <tr valign="top"><td>
210  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
211        <span class="sig-arg">func</span>)</span>
212    <br /><em class="fname">(Constructor)</em>
213  </h3>
214  </td><td align="right" valign="top"
215    ><span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized.__init__">source&nbsp;code</a></span>&nbsp;
216    </td>
217  </tr></table>
218  
219  <pre class="literalblock">
220x.__init__(...) initializes x; see x.__class__.__doc__ for signature
221
222</pre>
223  <dl class="fields">
224    <dt>Overrides:
225        object.__init__
226        <dd><em class="note">(inherited documentation)</em></dd>
227    </dt>
228  </dl>
229</td></tr></table>
230</div>
231<a name="__repr__"></a>
232<div>
233<table class="details" border="1" cellpadding="3"
234       cellspacing="0" width="100%" bgcolor="white">
235<tr><td>
236  <table width="100%" cellpadding="0" cellspacing="0" border="0">
237  <tr valign="top"><td>
238  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
239    <br /><em class="fname">(Representation operator)</em>
240  </h3>
241  </td><td align="right" valign="top"
242    ><span class="codelink"><a href="pyechonest.decorators-pysrc.html#memoized.__repr__">source&nbsp;code</a></span>&nbsp;
243    </td>
244  </tr></table>
245  
246  <pre class="literalblock">
247Return the function's docstring.
248
249</pre>
250  <dl class="fields">
251    <dt>Overrides:
252        object.__repr__
253    </dt>
254  </dl>
255</td></tr></table>
256</div>
257<br />
258<!-- ==================== NAVIGATION BAR ==================== -->
259<table class="navbar" border="0" width="100%" cellpadding="0"
260       bgcolor="#a0c0ff" cellspacing="0">
261  <tr valign="middle">
262
263  <!-- Tree link -->
264      <th>&nbsp;&nbsp;&nbsp;<a
265        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
266
267  <!-- Index link -->
268      <th>&nbsp;&nbsp;&nbsp;<a
269        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
270
271  <!-- Help link -->
272      <th>&nbsp;&nbsp;&nbsp;<a
273        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
274
275  <!-- Project homepage -->
276      <th class="navbar" align="right" width="100%">
277        <table border="0" cellpadding="0" cellspacing="0">
278          <tr><th class="navbar" align="center"
279            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
280          </tr></table></th>
281  </tr>
282</table>
283<table border="0" cellpadding="0" cellspacing="0" width="100%%">
284  <tr>
285    <td align="left" class="footer">
286    Generated by Epydoc 3.0.1 on Wed May 26 12:18:01 2010
287    </td>
288    <td align="right" class="footer">
289      <a target="mainFrame" href="http://epydoc.sourceforge.net"
290        >http://epydoc.sourceforge.net</a>
291    </td>
292  </tr>
293</table>
294
295<script type="text/javascript">
296  <!--
297  // Private objects are initially displayed (because if
298  // javascript is turned off then we want them to be
299  // visible); but by default, we want to hide them.  So hide
300  // them unless we have a cookie that says to show them.
301  checkCookie();
302  // -->
303</script>
304</body>
305</html>