/src/pyechonest/doc/build/html/proxies.html

http://echo-nest-remix.googlecode.com/ · HTML · 220 lines · 190 code · 30 blank · 0 comment · 0 complexity · d4a8957755da5b5b068c27079b018701 MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml">
    5. 

  5.   <head>
    6. 

  6.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.     
    8. 

  8.     <title>Proxies – object proxies &mdash; pyechonest v4 documentation</title>
    9. 

  9.     <link rel="stylesheet" href="_static/default.css" type="text/css" />
    10. 

  10.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    11. 

  11.     <script type="text/javascript">
    12. 

  12.       var DOCUMENTATION_OPTIONS = {
    13. 

  13.         URL_ROOT:    '',
    14. 

  14.         VERSION:     '4',
    15. 

  15.         COLLAPSE_INDEX: false,
    16. 

  16.         FILE_SUFFIX: '.html',
    17. 

  17.         HAS_SOURCE:  true
    18. 

  18.       };
    19. 

  19.     </script>
    20. 

  20.     <script type="text/javascript" src="_static/jquery.js"></script>
    21. 

  21.     <script type="text/javascript" src="_static/underscore.js"></script>
    22. 

  22.     <script type="text/javascript" src="_static/doctools.js"></script>
    23. 

  23.     <link rel="top" title="pyechonest v4 documentation" href="index.html" />
    24. 

  24.     <link rel="prev" title="Config – configuration file" href="config.html" /> 
    25. 

  25.   </head>
    26. 

  26.   <body>
    27. 

  27.     <div class="related">
    28. 

  28.       <h3>Navigation</h3>
    29. 

  29.       <ul>
    30. 

  30.         <li class="right" style="margin-right: 10px">
    31. 

  31.           <a href="genindex.html" title="General Index"
    32. 

  32.              accesskey="I">index</a></li>
    33. 

  33.         <li class="right" >
    34. 

  34.           <a href="py-modindex.html" title="Python Module Index"
    35. 

  35.              >modules</a> |</li>
    36. 

  36.         <li class="right" >
    37. 

  37.           <a href="config.html" title="Config – configuration file"
    38. 

  38.              accesskey="P">previous</a> |</li>
    39. 

  39.         <li><a href="index.html">pyechonest v4 documentation</a> &raquo;</li> 
    40. 

  40.       </ul>
    41. 

  41.     </div>  
    42. 

  42. 

  43.     <div class="document">
    44. 

  44.       <div class="documentwrapper">
    45. 

  45.         <div class="bodywrapper">
    46. 

  46.           <div class="body">
    47. 

  47.             
    48. 

  48.   <div class="section" id="module-pyechonest.proxies">
    49. 

  49. <span id="proxies-object-proxies"></span><h1>Proxies &#8211; object proxies<a class="headerlink" href="#module-pyechonest.proxies" title="Permalink to this headline">ś</a></h1>
    50. 

  50. <p>Copyright (c) 2010 The Echo Nest. All rights reserved.
    51. 

  51. Created by Tyler Williams on 2010-04-25.</p>
    52. 

  52. <dl class="class">
    53. 

  53. <dt id="pyechonest.proxies.ArtistProxy">
    54. 

  54. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">ArtistProxy</tt><big>(</big><em>identifier</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.ArtistProxy" title="Permalink to this definition">ś</a></dt>
    55. 

  55. <dd><dl class="method">
    56. 

  56. <dt id="pyechonest.proxies.ArtistProxy.__init__">
    57. 

  57. <tt class="descname">__init__</tt><big>(</big><em>identifier</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.ArtistProxy.__init__" title="Permalink to this definition">ś</a></dt>
    58. 

  58. <dd></dd></dl>
    59. 

  59. 

  60. <dl class="method">
    61. 

  61. <dt id="pyechonest.proxies.ArtistProxy.get_attribute">
    62. 

  62. <tt class="descname">get_attribute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.ArtistProxy.get_attribute" title="Permalink to this definition">ś</a></dt>
    63. 

  63. <dd></dd></dl>
    64. 

  64. 

  65. </dd></dl>
    66. 

  66. 

  67. <dl class="class">
    68. 

  68. <dt id="pyechonest.proxies.CatalogProxy">
    69. 

  69. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">CatalogProxy</tt><big>(</big><em>identifier</em>, <em>type</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.CatalogProxy" title="Permalink to this definition">ś</a></dt>
    70. 

  70. <dd><dl class="method">
    71. 

  71. <dt id="pyechonest.proxies.CatalogProxy.__init__">
    72. 

  72. <tt class="descname">__init__</tt><big>(</big><em>identifier</em>, <em>type</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.CatalogProxy.__init__" title="Permalink to this definition">ś</a></dt>
    73. 

  73. <dd></dd></dl>
    74. 

  74. 

  75. <dl class="method">
    76. 

  76. <dt id="pyechonest.proxies.CatalogProxy.get_attribute">
    77. 

  77. <tt class="descname">get_attribute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.CatalogProxy.get_attribute" title="Permalink to this definition">ś</a></dt>
    78. 

  78. <dd></dd></dl>
    79. 

  79. 

  80. <dl class="method">
    81. 

  81. <dt id="pyechonest.proxies.CatalogProxy.get_attribute_simple">
    82. 

  82. <tt class="descname">get_attribute_simple</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.CatalogProxy.get_attribute_simple" title="Permalink to this definition">ś</a></dt>
    83. 

  83. <dd></dd></dl>
    84. 

  84. 

  85. <dl class="method">
    86. 

  86. <dt id="pyechonest.proxies.CatalogProxy.post_attribute">
    87. 

  87. <tt class="descname">post_attribute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.CatalogProxy.post_attribute" title="Permalink to this definition">ś</a></dt>
    88. 

  88. <dd></dd></dl>
    89. 

  89. 

  90. </dd></dl>
    91. 

  91. 

  92. <dl class="class">
    93. 

  93. <dt id="pyechonest.proxies.GenericProxy">
    94. 

  94. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">GenericProxy</tt><a class="headerlink" href="#pyechonest.proxies.GenericProxy" title="Permalink to this definition">ś</a></dt>
    95. 

  95. <dd><dl class="method">
    96. 

  96. <dt id="pyechonest.proxies.GenericProxy.__init__">
    97. 

  97. <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#pyechonest.proxies.GenericProxy.__init__" title="Permalink to this definition">ś</a></dt>
    98. 

  98. <dd></dd></dl>
    99. 

  99. 

  100. <dl class="method">
    101. 

  101. <dt id="pyechonest.proxies.GenericProxy.get_attribute">
    102. 

  102. <tt class="descname">get_attribute</tt><big>(</big><em>method_name</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.GenericProxy.get_attribute" title="Permalink to this definition">ś</a></dt>
    103. 

  103. <dd></dd></dl>
    104. 

  104. 

  105. <dl class="method">
    106. 

  106. <dt id="pyechonest.proxies.GenericProxy.post_attribute">
    107. 

  107. <tt class="descname">post_attribute</tt><big>(</big><em>method_name</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.GenericProxy.post_attribute" title="Permalink to this definition">ś</a></dt>
    108. 

  108. <dd></dd></dl>
    109. 

  109. 

  110. </dd></dl>
    111. 

  111. 

  112. <dl class="class">
    113. 

  113. <dt id="pyechonest.proxies.PlaylistProxy">
    114. 

  114. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">PlaylistProxy</tt><big>(</big><em>session_id</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.PlaylistProxy" title="Permalink to this definition">ś</a></dt>
    115. 

  115. <dd><dl class="method">
    116. 

  116. <dt id="pyechonest.proxies.PlaylistProxy.__init__">
    117. 

  117. <tt class="descname">__init__</tt><big>(</big><em>session_id</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.PlaylistProxy.__init__" title="Permalink to this definition">ś</a></dt>
    118. 

  118. <dd></dd></dl>
    119. 

  119. 

  120. <dl class="method">
    121. 

  121. <dt id="pyechonest.proxies.PlaylistProxy.get_attribute">
    122. 

  122. <tt class="descname">get_attribute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.PlaylistProxy.get_attribute" title="Permalink to this definition">ś</a></dt>
    123. 

  123. <dd></dd></dl>
    124. 

  124. 

  125. </dd></dl>
    126. 

  126. 

  127. <dl class="class">
    128. 

  128. <dt id="pyechonest.proxies.ResultList">
    129. 

  129. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">ResultList</tt><big>(</big><em>li</em>, <em>start=0</em>, <em>total=0</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.ResultList" title="Permalink to this definition">ś</a></dt>
    130. 

  130. <dd><dl class="method">
    131. 

  131. <dt id="pyechonest.proxies.ResultList.__init__">
    132. 

  132. <tt class="descname">__init__</tt><big>(</big><em>li</em>, <em>start=0</em>, <em>total=0</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.ResultList.__init__" title="Permalink to this definition">ś</a></dt>
    133. 

  133. <dd></dd></dl>
    134. 

  134. 

  135. </dd></dl>
    136. 

  136. 

  137. <dl class="class">
    138. 

  138. <dt id="pyechonest.proxies.SongProxy">
    139. 

  139. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">SongProxy</tt><big>(</big><em>identifier</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.SongProxy" title="Permalink to this definition">ś</a></dt>
    140. 

  140. <dd><dl class="method">
    141. 

  141. <dt id="pyechonest.proxies.SongProxy.__init__">
    142. 

  142. <tt class="descname">__init__</tt><big>(</big><em>identifier</em>, <em>buckets=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.SongProxy.__init__" title="Permalink to this definition">ś</a></dt>
    143. 

  143. <dd></dd></dl>
    144. 

  144. 

  145. <dl class="method">
    146. 

  146. <dt id="pyechonest.proxies.SongProxy.get_attribute">
    147. 

  147. <tt class="descname">get_attribute</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.SongProxy.get_attribute" title="Permalink to this definition">ś</a></dt>
    148. 

  148. <dd></dd></dl>
    149. 

  149. 

  150. </dd></dl>
    151. 

  151. 

  152. <dl class="class">
    153. 

  153. <dt id="pyechonest.proxies.TrackProxy">
    154. 

  154. <em class="property">class </em><tt class="descclassname">pyechonest.proxies.</tt><tt class="descname">TrackProxy</tt><big>(</big><em>identifier</em>, <em>md5</em>, <em>properties</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.TrackProxy" title="Permalink to this definition">ś</a></dt>
    155. 

  155. <dd><dl class="method">
    156. 

  156. <dt id="pyechonest.proxies.TrackProxy.__init__">
    157. 

  157. <tt class="descname">__init__</tt><big>(</big><em>identifier</em>, <em>md5</em>, <em>properties</em><big>)</big><a class="headerlink" href="#pyechonest.proxies.TrackProxy.__init__" title="Permalink to this definition">ś</a></dt>
    158. 

  158. <dd><p>You should not call this constructor directly, rather use the convenience functions
    159. 

  159. that are in track.py. For example, call track.track_from_filename
    160. 

  160. Let&#8217;s always get the bucket <cite>audio_summary</cite></p>
    161. 

  161. </dd></dl>
    162. 

  162. 

  163. </dd></dl>
    164. 

  164. 

  165. </div>
    166. 

  166. 

  167. 

  168.           </div>
    169. 

  169.         </div>
    170. 

  170.       </div>
    171. 

  171.       <div class="sphinxsidebar">
    172. 

  172.         <div class="sphinxsidebarwrapper">
    173. 

  173.   <h4>Previous topic</h4>
    174. 

  174.   <p class="topless"><a href="config.html"
    175. 

  175.                         title="previous chapter">Config &#8211; configuration file</a></p>
    176. 

  176.   <h3>This Page</h3>
    177. 

  177.   <ul class="this-page-menu">
    178. 

  178.     <li><a href="_sources/proxies.txt"
    179. 

  179.            rel="nofollow">Show Source</a></li>
    180. 

  180.   </ul>
    181. 

  181. <div id="searchbox" style="display: none">
    182. 

  182.   <h3>Quick search</h3>
    183. 

  183.     <form class="search" action="search.html" method="get">
    184. 

  184.       <input type="text" name="q" size="18" />
    185. 

  185.       <input type="submit" value="Go" />
    186. 

  186.       <input type="hidden" name="check_keywords" value="yes" />
    187. 

  187.       <input type="hidden" name="area" value="default" />
    188. 

  188.     </form>
    189. 

  189.     <p class="searchtip" style="font-size: 90%">
    190. 

  190.     Enter search terms or a module, class or function name.
    191. 

  191.     </p>
    192. 

  192. </div>
    193. 

  193. <script type="text/javascript">$('#searchbox').show(0);</script>
    194. 

  194.         </div>
    195. 

  195.       </div>
    196. 

  196.       <div class="clearer"></div>
    197. 

  197.     </div>
    198. 

  198.     <div class="related">
    199. 

  199.       <h3>Navigation</h3>
    200. 

  200.       <ul>
    201. 

  201.         <li class="right" style="margin-right: 10px">
    202. 

  202.           <a href="genindex.html" title="General Index"
    203. 

  203.              >index</a></li>
    204. 

  204.         <li class="right" >
    205. 

  205.           <a href="py-modindex.html" title="Python Module Index"
    206. 

  206.              >modules</a> |</li>
    207. 

  207.         <li class="right" >
    208. 

  208.           <a href="config.html" title="Config – configuration file"
    209. 

  209.              >previous</a> |</li>
    210. 

  210.         <li><a href="index.html">pyechonest v4 documentation</a> &raquo;</li> 
    211. 

  211.       </ul>
    212. 

  212.     </div>
    213. 

  213.     <div class="footer">
    214. 

  214.         &copy; Copyright 2010, The Echo Nest.
    215. 

  215.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.5.
    216. 

  216.     </div>
    217. 

  217.   </body>
    218. 

  218. </html>
    219.