/src/pyechonest/doc/build/html/util.html

http://echo-nest-remix.googlecode.com/ · HTML · 198 lines · 177 code · 21 blank · 0 comment · 0 complexity · 5bef299b97e7937778e8e4fb9bfb8941 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>Util – utility functions &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="next" title="Config – configuration file" href="config.html" />
    25. 

  25.     <link rel="prev" title="Catalog – catalog methods" href="catalog.html" /> 
    26. 

  26.   </head>
    27. 

  27.   <body>
    28. 

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

  29.       <h3>Navigation</h3>
    30. 

  30.       <ul>
    31. 

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

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

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

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

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

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

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

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

  39.              accesskey="N">next</a> |</li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="catalog.html" title="Catalog – catalog methods"
    42. 

  42.              accesskey="P">previous</a> |</li>
    43. 

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

  44.       </ul>
    45. 

  45.     </div>  
    46. 

  46. 

  47.     <div class="document">
    48. 

  48.       <div class="documentwrapper">
    49. 

  49.         <div class="bodywrapper">
    50. 

  50.           <div class="body">
    51. 

  51.             
    52. 

  52.   <div class="section" id="module-pyechonest.util">
    53. 

  53. <span id="util-utility-functions"></span><h1>Util &#8211; utility functions<a class="headerlink" href="#module-pyechonest.util" title="Permalink to this headline">ś</a></h1>
    54. 

  54. <p>Copyright (c) 2010 The Echo Nest. All rights reserved.
    55. 

  55. Created by Tyler Williams on 2010-04-25.</p>
    56. 

  56. <p>Utility functions to support the Echo Nest web API interface.</p>
    57. 

  57. <dl class="exception">
    58. 

  58. <dt id="pyechonest.util.EchoNestAPIError">
    59. 

  59. <em class="property">exception </em><tt class="descclassname">pyechonest.util.</tt><tt class="descname">EchoNestAPIError</tt><big>(</big><em>code</em>, <em>message</em><big>)</big><a class="headerlink" href="#pyechonest.util.EchoNestAPIError" title="Permalink to this definition">ś</a></dt>
    60. 

  60. <dd><p>Generic API errors.</p>
    61. 

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

  62. <dt id="pyechonest.util.EchoNestAPIError.__init__">
    63. 

  63. <tt class="descname">__init__</tt><big>(</big><em>code</em>, <em>message</em><big>)</big><a class="headerlink" href="#pyechonest.util.EchoNestAPIError.__init__" title="Permalink to this definition">ś</a></dt>
    64. 

  64. <dd></dd></dl>
    65. 

  65. 

  66. </dd></dl>
    67. 

  67. 

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

  69. <dt id="pyechonest.util.MyBaseHandler">
    70. 

  70. <em class="property">class </em><tt class="descclassname">pyechonest.util.</tt><tt class="descname">MyBaseHandler</tt><a class="headerlink" href="#pyechonest.util.MyBaseHandler" title="Permalink to this definition">ś</a></dt>
    71. 

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

  72. <dt id="pyechonest.util.MyBaseHandler.default_open">
    73. 

  73. <tt class="descname">default_open</tt><big>(</big><em>request</em><big>)</big><a class="headerlink" href="#pyechonest.util.MyBaseHandler.default_open" title="Permalink to this definition">ś</a></dt>
    74. 

  74. <dd></dd></dl>
    75. 

  75. 

  76. </dd></dl>
    77. 

  77. 

  78. <dl class="class">
    79. 

  79. <dt id="pyechonest.util.MyErrorProcessor">
    80. 

  80. <em class="property">class </em><tt class="descclassname">pyechonest.util.</tt><tt class="descname">MyErrorProcessor</tt><a class="headerlink" href="#pyechonest.util.MyErrorProcessor" title="Permalink to this definition">ś</a></dt>
    81. 

  81. <dd><dl class="method">
    82. 

  82. <dt id="pyechonest.util.MyErrorProcessor.http_response">
    83. 

  83. <tt class="descname">http_response</tt><big>(</big><em>request</em>, <em>response</em><big>)</big><a class="headerlink" href="#pyechonest.util.MyErrorProcessor.http_response" title="Permalink to this definition">ś</a></dt>
    84. 

  84. <dd></dd></dl>
    85. 

  85. 

  86. </dd></dl>
    87. 

  87. 

  88. <dl class="function">
    89. 

  89. <dt id="pyechonest.util.callm">
    90. 

  90. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">callm</tt><big>(</big><em>method</em>, <em>param_dict</em>, <em>POST=False</em>, <em>socket_timeout=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#pyechonest.util.callm" title="Permalink to this definition">ś</a></dt>
    91. 

  91. <dd><p>Call the api! 
    92. 

  92. Param_dict is a <em>regular</em> <em>python</em> <em>dictionary</em> so if you want to have multi-valued params
    93. 

  93. put them in a list.</p>
    94. 

  94. <p>** note, if we require 2.6, we can get rid of this timeout munging.</p>
    95. 

  95. </dd></dl>
    96. 

  96. 

  97. <dl class="function">
    98. 

  98. <dt id="pyechonest.util.codegen">
    99. 

  99. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">codegen</tt><big>(</big><em>filename</em>, <em>start=0</em>, <em>duration=30</em><big>)</big><a class="headerlink" href="#pyechonest.util.codegen" title="Permalink to this definition">ś</a></dt>
    100. 

  100. <dd></dd></dl>
    101. 

  101. 

  102. <dl class="function">
    103. 

  103. <dt id="pyechonest.util.fix">
    104. 

  104. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">fix</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#pyechonest.util.fix" title="Permalink to this definition">ś</a></dt>
    105. 

  105. <dd></dd></dl>
    106. 

  106. 

  107. <dl class="function">
    108. 

  108. <dt id="pyechonest.util.get_successful_response">
    109. 

  109. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">get_successful_response</tt><big>(</big><em>raw_json</em><big>)</big><a class="headerlink" href="#pyechonest.util.get_successful_response" title="Permalink to this definition">ś</a></dt>
    110. 

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

  111. 

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

  113. <dt id="pyechonest.util.postChunked">
    114. 

  114. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">postChunked</tt><big>(</big><em>host</em>, <em>selector</em>, <em>fields</em>, <em>files</em><big>)</big><a class="headerlink" href="#pyechonest.util.postChunked" title="Permalink to this definition">ś</a></dt>
    115. 

  115. <dd><p>Attempt to replace postMultipart() with nearly-identical interface.
    116. 

  116. (The files tuple no longer requires the filename, and we only return
    117. 

  117. the response body.) 
    118. 

  118. Uses the urllib2_file.py originally from 
    119. 

  119. <a class="reference external" href="http://fabien.seisen.org">http://fabien.seisen.org</a> which was also drawn heavily from 
    120. 

  120. <a class="reference external" href="http://code.activestate.com/recipes/146306/">http://code.activestate.com/recipes/146306/</a> .</p>
    121. 

  121. <p>This urllib2_file.py is more desirable because of the chunked 
    122. 

  122. uploading from a file pointer (no need to read entire file into 
    123. 

  123. memory) and the ability to work from behind a proxy (due to its 
    124. 

  124. basis on urllib2).</p>
    125. 

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

  126. 

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

  128. <dt id="pyechonest.util.reallyUTF8">
    129. 

  129. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">reallyUTF8</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#pyechonest.util.reallyUTF8" title="Permalink to this definition">ś</a></dt>
    130. 

  130. <dd></dd></dl>
    131. 

  131. 

  132. <dl class="function">
    133. 

  133. <dt id="pyechonest.util.reallyunicode">
    134. 

  134. <tt class="descclassname">pyechonest.util.</tt><tt class="descname">reallyunicode</tt><big>(</big><em>s</em>, <em>encoding='utf-8'</em><big>)</big><a class="headerlink" href="#pyechonest.util.reallyunicode" title="Permalink to this definition">ś</a></dt>
    135. 

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

  136. 

  137. </div>
    138. 

  138. 

  139. 

  140.           </div>
    141. 

  141.         </div>
    142. 

  142.       </div>
    143. 

  143.       <div class="sphinxsidebar">
    144. 

  144.         <div class="sphinxsidebarwrapper">
    145. 

  145.   <h4>Previous topic</h4>
    146. 

  146.   <p class="topless"><a href="catalog.html"
    147. 

  147.                         title="previous chapter">Catalog &#8211; catalog methods</a></p>
    148. 

  148.   <h4>Next topic</h4>
    149. 

  149.   <p class="topless"><a href="config.html"
    150. 

  150.                         title="next chapter">Config &#8211; configuration file</a></p>
    151. 

  151.   <h3>This Page</h3>
    152. 

  152.   <ul class="this-page-menu">
    153. 

  153.     <li><a href="_sources/util.txt"
    154. 

  154.            rel="nofollow">Show Source</a></li>
    155. 

  155.   </ul>
    156. 

  156. <div id="searchbox" style="display: none">
    157. 

  157.   <h3>Quick search</h3>
    158. 

  158.     <form class="search" action="search.html" method="get">
    159. 

  159.       <input type="text" name="q" size="18" />
    160. 

  160.       <input type="submit" value="Go" />
    161. 

  161.       <input type="hidden" name="check_keywords" value="yes" />
    162. 

  162.       <input type="hidden" name="area" value="default" />
    163. 

  163.     </form>
    164. 

  164.     <p class="searchtip" style="font-size: 90%">
    165. 

  165.     Enter search terms or a module, class or function name.
    166. 

  166.     </p>
    167. 

  167. </div>
    168. 

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

  169.         </div>
    170. 

  170.       </div>
    171. 

  171.       <div class="clearer"></div>
    172. 

  172.     </div>
    173. 

  173.     <div class="related">
    174. 

  174.       <h3>Navigation</h3>
    175. 

  175.       <ul>
    176. 

  176.         <li class="right" style="margin-right: 10px">
    177. 

  177.           <a href="genindex.html" title="General Index"
    178. 

  178.              >index</a></li>
    179. 

  179.         <li class="right" >
    180. 

  180.           <a href="py-modindex.html" title="Python Module Index"
    181. 

  181.              >modules</a> |</li>
    182. 

  182.         <li class="right" >
    183. 

  183.           <a href="config.html" title="Config – configuration file"
    184. 

  184.              >next</a> |</li>
    185. 

  185.         <li class="right" >
    186. 

  186.           <a href="catalog.html" title="Catalog – catalog methods"
    187. 

  187.              >previous</a> |</li>
    188. 

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

  189.       </ul>
    190. 

  190.     </div>
    191. 

  191.     <div class="footer">
    192. 

  192.         &copy; Copyright 2010, The Echo Nest.
    193. 

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

  194.     </div>
    195. 

  195.   </body>
    196. 

  196. </html>
    197.