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