Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
sintonia/python_apps/soundcloud-api/docs/api/scapi-pysrc.html

1264 lines
248 KiB
HTML
Raw Blame History

<?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>scapi</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 bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&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"
>SoundCloud API</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package&nbsp;scapi
</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="scapi-pysrc.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="scapi-module.html">Package scapi</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">## SouncCloudAPI implements a Python wrapper around the SoundCloud RESTful</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## API</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Copyright (C) 2008 Diez B. Roggisch</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Contact mailto:deets@soundcloud.com</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## This library is free software; you can redistribute it and/or</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## modify it under the terms of the GNU Lesser General Public</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## License as published by the Free Software Foundation; either</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## version 2.1 of the License, or (at your option) any later version.</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## This library is distributed in the hope that it will be useful,</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Lesser General Public License for more details.</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## You should have received a copy of the GNU Lesser General Public</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## License along with this library; if not, write to the Free Software</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib2</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">simplejson</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">cgi</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package scapi=scapi-module.html"><a title="scapi" class="py-name" href="#" onclick="return doclink('link-0', 'scapi', 'link-0');">scapi</a></tt><tt class="py-op">.</tt><tt class="py-name">MultipartPostHandler</tt> <tt class="py-keyword">import</tt> <tt class="py-name">MultipartPostHandler</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">inspect</tt> <tt class="py-keyword">import</tt> <tt class="py-name">isclass</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urlparse</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name"><a title="scapi" class="py-name" href="#" onclick="return doclink('link-1', 'scapi', 'link-0');">scapi</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module scapi.authentication=scapi.authentication-module.html"><a title="scapi.authentication" class="py-name" href="#" onclick="return doclink('link-2', 'authentication', 'link-2');">authentication</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Class scapi.authentication.BasicAuthenticator=scapi.authentication.BasicAuthenticator-class.html"><a title="scapi.authentication.BasicAuthenticator" class="py-name" href="#" onclick="return doclink('link-3', 'BasicAuthenticator', 'link-3');">BasicAuthenticator</a></tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-4" class="py-name"><a title="scapi" class="py-name" href="#" onclick="return doclink('link-4', 'scapi', 'link-0');">scapi</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Module scapi.util=scapi.util-module.html"><a title="scapi.util" class="py-name" href="#" onclick="return doclink('link-5', 'util', 'link-5');">util</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">(</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt id="link-6" class="py-name" targets="Function scapi.util.escape()=scapi.util-module.html#escape"><a title="scapi.util.escape" class="py-name" href="#" onclick="return doclink('link-6', 'escape', 'link-6');">escape</a></tt><tt class="py-op">,</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt id="link-7" class="py-name" targets="Class scapi.util.MultiDict=scapi.util.MultiDict-class.html"><a title="scapi.util.MultiDict" class="py-name" href="#" onclick="return doclink('link-7', 'MultiDict', 'link-7');">MultiDict</a></tt><tt class="py-op">,</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">basicConfig</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt id="link-8" class="py-name" targets="Variable scapi.authentication.logger=scapi.authentication-module.html#logger,Variable scapi.logger=scapi-module.html#logger,Variable scapi.tests.scapi_tests.logger=scapi.tests.scapi_tests-module.html#logger,Variable scapi.tests.test_connect.logger=scapi.tests.test_connect-module.html#logger,Variable scapi.tests.test_oauth.logger=scapi.tests.test_oauth-module.html#logger"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-8', 'logger', 'link-8');">logger</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt id="link-9" class="py-name" targets="Variable scapi.USE_PROXY=scapi-module.html#USE_PROXY"><a title="scapi.USE_PROXY" class="py-name" href="#" onclick="return doclink('link-9', 'USE_PROXY', 'link-9');">USE_PROXY</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-string">Something like http://127.0.0.1:10000/</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt id="link-10" class="py-name" targets="Variable scapi.PROXY=scapi-module.html#PROXY"><a title="scapi.PROXY" class="py-name" href="#" onclick="return doclink('link-10', 'PROXY', 'link-10');">PROXY</a></tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-string">The url Soundcould offers to obtain request-tokens</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable scapi.REQUEST_TOKEN_URL=scapi-module.html#REQUEST_TOKEN_URL"><a title="scapi.REQUEST_TOKEN_URL" class="py-name" href="#" onclick="return doclink('link-11', 'REQUEST_TOKEN_URL', 'link-11');">REQUEST_TOKEN_URL</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'http://api.soundcloud.com/oauth/request_token'</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-string">The url Soundcould offers to exchange access-tokens for request-tokens.</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable scapi.ACCESS_TOKEN_URL=scapi-module.html#ACCESS_TOKEN_URL"><a title="scapi.ACCESS_TOKEN_URL" class="py-name" href="#" onclick="return doclink('link-12', 'ACCESS_TOKEN_URL', 'link-12');">ACCESS_TOKEN_URL</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'http://api.soundcloud.com/oauth/access_token'</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-string">The url Soundcould offers to make users authorize a concrete request token.</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-string">"""</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt id="link-13" class="py-name" targets="Variable scapi.AUTHORIZATION_URL=scapi-module.html#AUTHORIZATION_URL"><a title="scapi.AUTHORIZATION_URL" class="py-name" href="#" onclick="return doclink('link-13', 'AUTHORIZATION_URL', 'link-13');">AUTHORIZATION_URL</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'http://api.soundcloud.com/oauth/authorize'</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-name">__all__</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'SoundCloudAPI'</tt><tt class="py-op">,</tt> <tt class="py-string">'USE_PROXY'</tt><tt class="py-op">,</tt> <tt class="py-string">'PROXY'</tt><tt class="py-op">,</tt> <tt class="py-string">'REQUEST_TOKEN_URL'</tt><tt class="py-op">,</tt> <tt class="py-string">'ACCESS_TOKEN_URL'</tt><tt class="py-op">,</tt> <tt class="py-string">'AUTHORIZATION_URL'</tt><tt class="py-op">]</tt> </tt>
<a name="NoResultFromRequest"></a><div id="NoResultFromRequest-def"><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <a class="py-toggle" href="#" id="NoResultFromRequest-toggle" onclick="return toggle('NoResultFromRequest');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.NoResultFromRequest-class.html">NoResultFromRequest</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="NoResultFromRequest-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="NoResultFromRequest-expanded"><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
<a name="InvalidMethodException"></a><div id="InvalidMethodException-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="InvalidMethodException-toggle" onclick="return toggle('InvalidMethodException');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.InvalidMethodException-class.html">InvalidMethodException</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InvalidMethodException-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidMethodException-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> </tt>
<a name="InvalidMethodException.__init__"></a><div id="InvalidMethodException.__init__-def"><a name="L68"></a><tt class="py-lineno"> 68</tt> <a class="py-toggle" href="#" id="InvalidMethodException.__init__-toggle" onclick="return toggle('InvalidMethodException.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.InvalidMethodException-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InvalidMethodException.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InvalidMethodException.__init__-expanded"><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt> <tt class="py-op">=</tt> <tt class="py-name">message</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method scapi.ApiConnector.__init__()=scapi.ApiConnector-class.html#__init__,Method scapi.InvalidMethodException.__init__()=scapi.InvalidMethodException-class.html#__init__,Method scapi.RESTBase.__init__()=scapi.RESTBase-class.html#__init__,Method scapi.Scope.__init__()=scapi.Scope-class.html#__init__,Method scapi.UnknownContentType.__init__()=scapi.UnknownContentType-class.html#__init__,Method scapi.authentication.BasicAuthenticator.__init__()=scapi.authentication.BasicAuthenticator-class.html#__init__,Method scapi.authentication.OAuthAuthenticator.__init__()=scapi.authentication.OAuthAuthenticator-class.html#__init__,Method scapi.json._StringGenerator.__init__()=scapi.json._StringGenerator-class.html#__init__"><a title="scapi.ApiConnector.__init__
scapi.InvalidMethodException.__init__
scapi.RESTBase.__init__
scapi.Scope.__init__
scapi.UnknownContentType.__init__
scapi.authentication.BasicAuthenticator.__init__
scapi.authentication.OAuthAuthenticator.__init__
scapi.json._StringGenerator.__init__" class="py-name" href="#" onclick="return doclink('link-14', '__init__', 'link-14');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt>
<a name="InvalidMethodException.__repr__"></a><div id="InvalidMethodException.__repr__-def"><a name="L72"></a><tt class="py-lineno"> 72</tt> <a class="py-toggle" href="#" id="InvalidMethodException.__repr__-toggle" onclick="return toggle('InvalidMethodException.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.InvalidMethodException-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="InvalidMethodException.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="InvalidMethodException.__repr__-expanded"><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Method scapi.InvalidMethodException.__repr__()=scapi.InvalidMethodException-class.html#__repr__,Method scapi.RESTBase.__repr__()=scapi.RESTBase-class.html#__repr__,Method scapi.Scope.__repr__()=scapi.Scope-class.html#__repr__,Method scapi.UnknownContentType.__repr__()=scapi.UnknownContentType-class.html#__repr__"><a title="scapi.InvalidMethodException.__repr__
scapi.RESTBase.__repr__
scapi.Scope.__repr__
scapi.UnknownContentType.__repr__" class="py-name" href="#" onclick="return doclink('link-15', '__repr__', 'link-15');">__repr__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">+=</tt> <tt class="py-string">"\n"</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">+=</tt> <tt class="py-string">"-"</tt> <tt class="py-op">*</tt> <tt class="py-number">10</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">+=</tt> <tt class="py-string">"\nmessage:\n\n"</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_message</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
</div></div><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt>
<a name="UnknownContentType"></a><div id="UnknownContentType-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <a class="py-toggle" href="#" id="UnknownContentType-toggle" onclick="return toggle('UnknownContentType');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.UnknownContentType-class.html">UnknownContentType</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UnknownContentType-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="UnknownContentType-expanded"><a name="UnknownContentType.__init__"></a><div id="UnknownContentType.__init__-def"><a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="UnknownContentType.__init__-toggle" onclick="return toggle('UnknownContentType.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.UnknownContentType-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UnknownContentType.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UnknownContentType.__init__-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-name">Exception</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="scapi.ApiConnector.__init__
scapi.InvalidMethodException.__init__
scapi.RESTBase.__init__
scapi.Scope.__init__
scapi.UnknownContentType.__init__
scapi.authentication.BasicAuthenticator.__init__
scapi.authentication.OAuthAuthenticator.__init__
scapi.json._StringGenerator.__init__" class="py-name" href="#" onclick="return doclink('link-16', '__init__', 'link-14');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_msg</tt> <tt class="py-op">=</tt> <tt class="py-name">msg</tt> </tt>
</div><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> </tt>
<a name="UnknownContentType.__repr__"></a><div id="UnknownContentType.__repr__-def"><a name="L85"></a><tt class="py-lineno"> 85</tt> <a class="py-toggle" href="#" id="UnknownContentType.__repr__-toggle" onclick="return toggle('UnknownContentType.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.UnknownContentType-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UnknownContentType.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UnknownContentType.__repr__-expanded"><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> <tt class="py-op">+</tt> <tt class="py-string">":"</tt> <tt class="py-op">+</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_msg</tt> </tt>
</div><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> </tt>
<a name="UnknownContentType.__str__"></a><div id="UnknownContentType.__str__-def"><a name="L88"></a><tt class="py-lineno"> 88</tt> <a class="py-toggle" href="#" id="UnknownContentType.__str__-toggle" onclick="return toggle('UnknownContentType.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.UnknownContentType-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="UnknownContentType.__str__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="UnknownContentType.__str__-expanded"><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
<a name="ApiConnector"></a><div id="ApiConnector-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="ApiConnector-toggle" onclick="return toggle('ApiConnector');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html">ApiConnector</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ApiConnector-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> The ApiConnector holds all the data necessary to authenticate against</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> the soundcloud-api. You can instantiate several connectors if you like, but usually one </tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> should be sufficient.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-string"> SoundClound imposes a maximum on the number of returned items. This value is that</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-string"> maximum.</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt id="link-17" class="py-name" targets="Variable scapi.ApiConnector.LIST_LIMIT=scapi.ApiConnector-class.html#LIST_LIMIT"><a title="scapi.ApiConnector.LIST_LIMIT" class="py-name" href="#" onclick="return doclink('link-17', 'LIST_LIMIT', 'link-17');">LIST_LIMIT</a></tt> <tt class="py-op">=</tt> <tt class="py-number">50</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-string"> The query-parameter that is used to request results beginning from a certain offset.</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Variable scapi.ApiConnector.LIST_OFFSET_PARAMETER=scapi.ApiConnector-class.html#LIST_OFFSET_PARAMETER"><a title="scapi.ApiConnector.LIST_OFFSET_PARAMETER" class="py-name" href="#" onclick="return doclink('link-18', 'LIST_OFFSET_PARAMETER', 'link-18');">LIST_OFFSET_PARAMETER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'offset'</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-string">"""</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-string"> The query-parameter that is used to request results being limited to a certain amount.</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-string"> </tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-string"> Currently this is of no use and just for completeness sake.</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-string"> """</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt id="link-19" class="py-name" targets="Variable scapi.ApiConnector.LIST_LIMIT_PARAMETER=scapi.ApiConnector-class.html#LIST_LIMIT_PARAMETER"><a title="scapi.ApiConnector.LIST_LIMIT_PARAMETER" class="py-name" href="#" onclick="return doclink('link-19', 'LIST_LIMIT_PARAMETER', 'link-19');">LIST_LIMIT_PARAMETER</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'limit'</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> </tt>
<a name="ApiConnector.__init__"></a><div id="ApiConnector.__init__-def"><a name="L116"></a><tt class="py-lineno">116</tt> <a class="py-toggle" href="#" id="ApiConnector.__init__-toggle" onclick="return toggle('ApiConnector.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">host</tt><tt class="py-op">,</tt> <tt class="py-param">user</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">authenticator</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">base</tt><tt class="py-op">=</tt><tt class="py-string">""</tt><tt class="py-op">,</tt> <tt class="py-param">collapse_scope</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiConnector.__init__-expanded"><a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> Constructor for the API-Singleton. Use it once with parameters, and then the</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> subsequent calls internal to the API will work.</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> @type host: str</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> @param host: the host to connect to, e.g. "api.soundcloud.com". If a port is needed, use</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> "api.soundcloud.com:1234"</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> @type user: str</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> @param user: if given, the username for basic HTTP authentication</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"> @type password: str</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> @param password: if the user is given, you have to give a password as well</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> @type authenticator: OAuthAuthenticator | BasicAuthenticator</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> @param authenticator: the authenticator to use, see L{scapi.authentication}</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">host</tt> <tt class="py-op">=</tt> <tt class="py-name">host</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">authenticator</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">authenticator</tt> <tt class="py-op">=</tt> <tt class="py-name">authenticator</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">user</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> <tt class="py-keyword">and</tt> <tt class="py-name">password</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">authenticator</tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="scapi.authentication.BasicAuthenticator" class="py-name" href="#" onclick="return doclink('link-20', 'BasicAuthenticator', 'link-3');">BasicAuthenticator</a></tt><tt class="py-op">(</tt><tt class="py-name">user</tt><tt class="py-op">,</tt> <tt class="py-name">password</tt><tt class="py-op">)</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base</tt> <tt class="py-op">=</tt> <tt class="py-name">base</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">collapse_scope</tt> <tt class="py-op">=</tt> <tt class="py-name">collapse_scope</tt> </tt>
</div><a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> </tt>
<a name="ApiConnector.normalize_method"></a><div id="ApiConnector.normalize_method-def"><a name="L139"></a><tt class="py-lineno">139</tt> <a class="py-toggle" href="#" id="ApiConnector.normalize_method-toggle" onclick="return toggle('ApiConnector.normalize_method');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html#normalize_method">normalize_method</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector.normalize_method-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiConnector.normalize_method-expanded"><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt class="py-docstring"> This method will take a method that has been part of a redirect of some sort</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-docstring"> and see if it's valid, which means that it's located beneath our base. </tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"> If yes, we return it normalized without that very base.</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">)</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">"/"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-name">path</tt> <tt class="py-op">=</tt> <tt class="py-name">path</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-comment"># if the base is "", we return the whole path,</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># otherwise normalize it away</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base</tt> <tt class="py-op">==</tt> <tt class="py-string">""</tt><tt class="py-op">:</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">path</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">path</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_base</tt><tt class="py-op">)</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-21" class="py-name" targets="Class scapi.InvalidMethodException=scapi.InvalidMethodException-class.html"><a title="scapi.InvalidMethodException" class="py-name" href="#" onclick="return doclink('link-21', 'InvalidMethodException', 'link-21');">InvalidMethodException</a></tt><tt class="py-op">(</tt><tt class="py-string">"Not a valid API method: %s"</tt> <tt class="py-op">%</tt> <tt class="py-name">method</tt><tt class="py-op">)</tt> </tt>
</div><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> </tt>
<a name="ApiConnector.fetch_request_token"></a><div id="ApiConnector.fetch_request_token-def"><a name="L158"></a><tt class="py-lineno">158</tt> <a class="py-toggle" href="#" id="ApiConnector.fetch_request_token-toggle" onclick="return toggle('ApiConnector.fetch_request_token');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html#fetch_request_token">fetch_request_token</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">oauth_callback</tt><tt class="py-op">=</tt><tt class="py-string">"oob"</tt><tt class="py-op">,</tt> <tt class="py-param">oauth_verifier</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector.fetch_request_token-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiConnector.fetch_request_token-expanded"><a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"><tt class="py-docstring"> Helper-function for a registered consumer to obtain a request token, as</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"><tt class="py-docstring"> used by oauth.</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"><tt class="py-docstring"> Use it like this:</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; oauth_authenticator = scapi.authentication.OAuthAuthenticator(CONSUMER, </tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> CONSUMER_SECRET,</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> None, </tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> None)</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.ApiConnector(host=API_HOST, authenticator=oauth_authenticator)</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; token, secret = sca.fetch_request_token()</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; authorization_url = sca.get_request_token_authorization_url(token)</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> Please note the None passed as token &amp; secret to the authenticator.</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">url</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt id="link-22" class="py-name"><a title="scapi.REQUEST_TOKEN_URL" class="py-name" href="#" onclick="return doclink('link-22', 'REQUEST_TOKEN_URL', 'link-11');">REQUEST_TOKEN_URL</a></tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">authenticator</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Method scapi.authentication.BasicAuthenticator.augment_request()=scapi.authentication.BasicAuthenticator-class.html#augment_request,Method scapi.authentication.OAuthAuthenticator.augment_request()=scapi.authentication.OAuthAuthenticator-class.html#augment_request"><a title="scapi.authentication.BasicAuthenticator.augment_request
scapi.authentication.OAuthAuthenticator.augment_request" class="py-name" href="#" onclick="return doclink('link-23', 'augment_request', 'link-23');">augment_request</a></tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">oauth_callback</tt><tt class="py-op">=</tt><tt class="py-name">oauth_callback</tt><tt class="py-op">,</tt> <tt class="py-name">oauth_verifier</tt><tt class="py-op">=</tt><tt class="py-name">oauth_verifier</tt><tt class="py-op">)</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-name">handlers</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-24" class="py-name"><a title="scapi.USE_PROXY" class="py-name" href="#" onclick="return doclink('link-24', 'USE_PROXY', 'link-9');">USE_PROXY</a></tt><tt class="py-op">:</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">handlers</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">ProxyHandler</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'http'</tt> <tt class="py-op">:</tt> <tt id="link-25" class="py-name"><a title="scapi.PROXY" class="py-name" href="#" onclick="return doclink('link-25', 'PROXY', 'link-10');">PROXY</a></tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">build_opener</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">handlers</tt><tt class="py-op">)</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-name">handle</tt> <tt class="py-op">=</tt> <tt class="py-name">opener</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-name">info</tt> <tt class="py-op">=</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name" targets="Method scapi.json.JsonReader.read()=scapi.json.JsonReader-class.html#read,Function scapi.json.read()=scapi.json-module.html#read"><a title="scapi.json.JsonReader.read
scapi.json.read" class="py-name" href="#" onclick="return doclink('link-26', 'read', 'link-26');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</tt> <tt class="py-name">cgi</tt><tt class="py-op">.</tt><tt class="py-name">parse_qs</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">,</tt> <tt class="py-name">keep_blank_values</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'oauth_token'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-name">secret</tt> <tt class="py-op">=</tt> <tt class="py-name">params</tt><tt class="py-op">[</tt><tt class="py-string">'oauth_token_secret'</tt><tt class="py-op">]</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">secret</tt> </tt>
</div><a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> </tt>
<a name="ApiConnector.fetch_access_token"></a><div id="ApiConnector.fetch_access_token-def"><a name="L193"></a><tt class="py-lineno">193</tt> <a class="py-toggle" href="#" id="ApiConnector.fetch_access_token-toggle" onclick="return toggle('ApiConnector.fetch_access_token');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html#fetch_access_token">fetch_access_token</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">oauth_verifier</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector.fetch_access_token-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiConnector.fetch_access_token-expanded"><a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> Helper-function for a registered consumer to exchange an access token for</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> a request token.</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"><tt class="py-docstring"> Use it like this:</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; oauth_authenticator = scapi.authentication.OAuthAuthenticator(CONSUMER, </tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-docstring"> CONSUMER_SECRET,</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"><tt class="py-docstring"> request_token, </tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"><tt class="py-docstring"> request_token_secret)</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.ApiConnector(host=API_HOST, authenticator=oauth_authenticator)</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; token, secret = sca.fetch_access_token()</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"><tt class="py-docstring"> Please note the values passed as token &amp; secret to the authenticator.</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name" targets="Method scapi.ApiConnector.fetch_request_token()=scapi.ApiConnector-class.html#fetch_request_token"><a title="scapi.ApiConnector.fetch_request_token" class="py-name" href="#" onclick="return doclink('link-27', 'fetch_request_token', 'link-27');">fetch_request_token</a></tt><tt class="py-op">(</tt><tt id="link-28" class="py-name"><a title="scapi.ACCESS_TOKEN_URL" class="py-name" href="#" onclick="return doclink('link-28', 'ACCESS_TOKEN_URL', 'link-12');">ACCESS_TOKEN_URL</a></tt><tt class="py-op">,</tt> <tt class="py-name">oauth_verifier</tt><tt class="py-op">=</tt><tt class="py-name">oauth_verifier</tt><tt class="py-op">)</tt> </tt>
</div><a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> </tt>
<a name="ApiConnector.get_request_token_authorization_url"></a><div id="ApiConnector.get_request_token_authorization_url-def"><a name="L213"></a><tt class="py-lineno">213</tt> <a class="py-toggle" href="#" id="ApiConnector.get_request_token_authorization_url-toggle" onclick="return toggle('ApiConnector.get_request_token_authorization_url');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.ApiConnector-class.html#get_request_token_authorization_url">get_request_token_authorization_url</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">token</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="ApiConnector.get_request_token_authorization_url-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="ApiConnector.get_request_token_authorization_url-expanded"><a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"><tt class="py-docstring"> Simple helper function to generate the url needed</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"><tt class="py-docstring"> to ask a user for request token authorization.</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"><tt class="py-docstring"> See also L{fetch_request_token}.</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"><tt class="py-docstring"> Possible usage:</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; import webbrowser</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.ApiConnector()</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; authorization_url = sca.get_request_token_authorization_url(token)</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; webbrowser.open(authorization_url)</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">"%s?oauth_token=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-29" class="py-name"><a title="scapi.AUTHORIZATION_URL" class="py-name" href="#" onclick="return doclink('link-29', 'AUTHORIZATION_URL', 'link-13');">AUTHORIZATION_URL</a></tt><tt class="py-op">,</tt> <tt class="py-name">token</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> </tt>
<a name="SCRedirectHandler"></a><div id="SCRedirectHandler-def"><a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="SCRedirectHandler-toggle" onclick="return toggle('SCRedirectHandler');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.SCRedirectHandler-class.html">SCRedirectHandler</a><tt class="py-op">(</tt><tt class="py-base-class">urllib2</tt><tt class="py-op">.</tt><tt class="py-base-class">HTTPRedirectHandler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SCRedirectHandler-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="SCRedirectHandler-expanded"><a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> A urllib2-Handler to deal with the redirects the RESTful API of SC uses.</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt id="link-30" class="py-name" targets="Variable scapi.SCRedirectHandler.alternate_method=scapi.SCRedirectHandler-class.html#alternate_method"><a title="scapi.SCRedirectHandler.alternate_method" class="py-name" href="#" onclick="return doclink('link-30', 'alternate_method', 'link-30');">alternate_method</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> </tt>
<a name="SCRedirectHandler.http_error_303"></a><div id="SCRedirectHandler.http_error_303-def"><a name="L237"></a><tt class="py-lineno">237</tt> <a class="py-toggle" href="#" id="SCRedirectHandler.http_error_303-toggle" onclick="return toggle('SCRedirectHandler.http_error_303');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.SCRedirectHandler-class.html#http_error_303">http_error_303</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">req</tt><tt class="py-op">,</tt> <tt class="py-param">fp</tt><tt class="py-op">,</tt> <tt class="py-param">code</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">hdrs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SCRedirectHandler.http_error_303-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SCRedirectHandler.http_error_303-expanded"><a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"><tt class="py-docstring"> In case of return-code 303 (See-other), we have to store the location we got</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> because that will determine the actual type of resource returned.</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="scapi.SCRedirectHandler.alternate_method" class="py-name" href="#" onclick="return doclink('link-31', 'alternate_method', 'link-30');">alternate_method</a></tt> <tt class="py-op">=</tt> <tt class="py-name">hdrs</tt><tt class="py-op">[</tt><tt class="py-string">'location'</tt><tt class="py-op">]</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-comment"># for oauth, we need to re-create the whole header-shizzle. This</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># does it - it recreates a full url and signs the request</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">new_url</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="scapi.SCRedirectHandler.alternate_method" class="py-name" href="#" onclick="return doclink('link-32', 'alternate_method', 'link-30');">alternate_method</a></tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-comment"># if USE_PROXY:</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># import pdb; pdb.set_trace()</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># old_url = req.get_full_url()</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># protocol, host, _, _, _, _ = urlparse.urlparse(old_url)</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># new_url = urlparse.urlunparse((protocol, host, self.alternate_method, None, None, None))</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt class="py-name">recreate_request</tt><tt class="py-op">(</tt><tt class="py-name">new_url</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPRedirectHandler</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Method scapi.SCRedirectHandler.http_error_303()=scapi.SCRedirectHandler-class.html#http_error_303"><a title="scapi.SCRedirectHandler.http_error_303" class="py-name" href="#" onclick="return doclink('link-33', 'http_error_303', 'link-33');">http_error_303</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt class="py-name">code</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt class="py-name">hdrs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> </tt>
<a name="SCRedirectHandler.http_error_201"></a><div id="SCRedirectHandler.http_error_201-def"><a name="L254"></a><tt class="py-lineno">254</tt> <a class="py-toggle" href="#" id="SCRedirectHandler.http_error_201-toggle" onclick="return toggle('SCRedirectHandler.http_error_201');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.SCRedirectHandler-class.html#http_error_201">http_error_201</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">req</tt><tt class="py-op">,</tt> <tt class="py-param">fp</tt><tt class="py-op">,</tt> <tt class="py-param">code</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">hdrs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="SCRedirectHandler.http_error_201-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="SCRedirectHandler.http_error_201-expanded"><a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"><tt class="py-docstring"> We fake a 201 being a 303 so that our redirection-scheme takes place</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"><tt class="py-docstring"> for the 201 the API throws in case we created something. If the location is</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"><tt class="py-docstring"> not available though, that means that whatever we created has succeded - without</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"><tt class="py-docstring"> being a named resource. Assigning an asset to a track is an example of such</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> case.</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'location'</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">hdrs</tt><tt class="py-op">:</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-34" class="py-name" targets="Class scapi.NoResultFromRequest=scapi.NoResultFromRequest-class.html"><a title="scapi.NoResultFromRequest" class="py-name" href="#" onclick="return doclink('link-34', 'NoResultFromRequest', 'link-34');">NoResultFromRequest</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="scapi.SCRedirectHandler.http_error_303" class="py-name" href="#" onclick="return doclink('link-35', 'http_error_303', 'link-33');">http_error_303</a></tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">fp</tt><tt class="py-op">,</tt> <tt class="py-number">303</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">,</tt> <tt class="py-name">hdrs</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> </tt>
<a name="Scope"></a><div id="Scope-def"><a name="L266"></a><tt class="py-lineno">266</tt> <a class="py-toggle" href="#" id="Scope-toggle" onclick="return toggle('Scope');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Scope-class.html">Scope</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Scope-expanded"><a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"><tt class="py-docstring"> The basic means to query and create resources. The Scope uses the L{ApiConnector} to</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"><tt class="py-docstring"> create the proper URIs for querying or creating resources. </tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> For accessing resources from the root level, you explcitly create a Scope and pass it</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"> an L{ApiConnector}-instance. Then you can query it </tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> or create new resources like this:</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; connector = scapi.ApiConnector(host='host', user='user', password='password') # initialize the API</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; scope = scapi.Scope(connector) # get the root scope</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; users = list(scope.users())</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"><tt class="py-docstring"> [&lt;scapi.User object at 0x12345&gt;, ...]</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"><tt class="py-docstring"> Please not that all resources that are lists are returned as B{generator}. So you need</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"><tt class="py-docstring"> to either iterate over them, or call list(resources) on them.</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"><tt class="py-docstring"> When accessing resources that belong to another resource, like contacts of a user, you access</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"><tt class="py-docstring"> the parent's resource scope implicitly through the resource instance like this:</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; user = scope.users().next()</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; list(user.contacts())</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"><tt class="py-docstring"> [&lt;scapi.Contact object at 0x12345&gt;, ...]</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="Scope.__init__"></a><div id="Scope.__init__-def"><a name="L291"></a><tt class="py-lineno">291</tt> <a class="py-toggle" href="#" id="Scope.__init__-toggle" onclick="return toggle('Scope.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">connector</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">parent</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope.__init__-expanded"><a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"><tt class="py-docstring"> Create the Scope. It can have a resource as scope, and possibly a parent-scope.</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"><tt class="py-docstring"> @param connector: The connector to use.</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"><tt class="py-docstring"> @type connector: ApiConnector</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"><tt class="py-docstring"> @type scope: scapi.RESTBase</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"><tt class="py-docstring"> @param scope: the resource to make this scope belong to</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"><tt class="py-docstring"> @type parent: scapi.Scope</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"><tt class="py-docstring"> @param parent: the parent scope of this scope</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">scope</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-name">scope</tt><tt class="py-op">,</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parent</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-name">parent</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method scapi.RESTBase._scope()=scapi.RESTBase-class.html#_scope"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-36', '_scope', 'link-36');">_scope</a></tt> <tt class="py-op">+</tt> <tt class="py-name">scope</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-37', '_scope', 'link-36');">_scope</a></tt> <tt class="py-op">=</tt> <tt class="py-name">scope</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_connector</tt> <tt class="py-op">=</tt> <tt class="py-name">connector</tt> </tt>
</div><a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"> </tt>
<a name="Scope._get_connector"></a><div id="Scope._get_connector-def"><a name="L312"></a><tt class="py-lineno">312</tt> <a class="py-toggle" href="#" id="Scope._get_connector-toggle" onclick="return toggle('Scope._get_connector');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#_get_connector">_get_connector</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope._get_connector-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope._get_connector-expanded"><a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_connector</tt> </tt>
</div><a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> </tt>
<a name="Scope.oauth_sign_get_request"></a><div id="Scope.oauth_sign_get_request-def"><a name="L316"></a><tt class="py-lineno">316</tt> <a class="py-toggle" href="#" id="Scope.oauth_sign_get_request-toggle" onclick="return toggle('Scope.oauth_sign_get_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#oauth_sign_get_request">oauth_sign_get_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope.oauth_sign_get_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope.oauth_sign_get_request-expanded"><a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"><tt class="py-docstring"> This method will take an arbitrary url, and rewrite it</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt class="py-docstring"> so that the current authenticator's oauth-headers are appended</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> as query-parameters.</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"><tt class="py-docstring"> This is used in streaming and downloading, because those content</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"><tt class="py-docstring"> isn't served from the SoundCloud servers themselves.</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"><tt class="py-docstring"> A usage example would look like this:</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = sca.tracks(params={</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"><tt class="py-docstring"> "filter" : "downloadable",</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"><tt class="py-docstring"> }).next()</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; download_url = track.download_url</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; signed_url = track.oauth_sign_get_request(download_url)</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; data = urllib2.urlopen(signed_url).read()</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-name">scheme</tt><tt class="py-op">,</tt> <tt class="py-name">netloc</tt><tt class="py-op">,</tt> <tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">,</tt> <tt class="py-name">fragment</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-name">all_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">query</tt><tt class="py-op">:</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> <tt class="py-name">all_params</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">cgi</tt><tt class="py-op">.</tt><tt class="py-name">parse_qs</tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">all_params</tt><tt class="py-op">:</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> <tt class="py-name">all_params</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_connector</tt><tt class="py-op">.</tt><tt class="py-name">authenticator</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="scapi.authentication.BasicAuthenticator.augment_request
scapi.authentication.OAuthAuthenticator.augment_request" class="py-name" href="#" onclick="return doclink('link-38', 'augment_request', 'link-23');">augment_request</a></tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">all_params</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"> <tt class="py-name">auth_header</tt> <tt class="py-op">=</tt> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt class="py-name">get_header</tt><tt class="py-op">(</tt><tt class="py-string">"Authorization"</tt><tt class="py-op">)</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"> <tt class="py-name">auth_header</tt> <tt class="py-op">=</tt> <tt class="py-name">auth_header</tt><tt class="py-op">[</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-string">"OAuth "</tt><tt class="py-op">)</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"> <tt class="py-name">query_params</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">query</tt><tt class="py-op">:</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"> <tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">)</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">auth_header</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">","</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt> <tt class="py-line"> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">part</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">"="</tt><tt class="py-op">)</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-keyword">assert</tt> <tt class="py-name">key</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">"oauth"</tt><tt class="py-op">)</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> <tt class="py-name">query_params</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"%s=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt> <tt class="py-line"> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt> <tt class="py-line"> <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-string">"&amp;"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">query_params</tt><tt class="py-op">)</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-name">urlparse</tt><tt class="py-op">.</tt><tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">scheme</tt><tt class="py-op">,</tt> <tt class="py-name">netloc</tt><tt class="py-op">,</tt> <tt class="py-name">path</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">query</tt><tt class="py-op">,</tt> <tt class="py-name">fragment</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">url</tt> </tt>
</div><a name="L367"></a><tt class="py-lineno">367</tt> <tt class="py-line"> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt> <tt class="py-line"> </tt>
<a name="Scope._create_request"></a><div id="Scope._create_request-def"><a name="L369"></a><tt class="py-lineno">369</tt> <a class="py-toggle" href="#" id="Scope._create_request-toggle" onclick="return toggle('Scope._create_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#_create_request">_create_request</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">connector</tt><tt class="py-op">,</tt> <tt class="py-param">parameters</tt><tt class="py-op">,</tt> <tt class="py-param">queryparams</tt><tt class="py-op">,</tt> <tt class="py-param">alternate_http_method</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">use_multipart</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope._create_request-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope._create_request-expanded"><a name="L370"></a><tt class="py-lineno">370</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt> <tt class="py-line"><tt class="py-docstring"> This method returnes the urllib2.Request to perform the actual HTTP-request.</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt> <tt class="py-line"><tt class="py-docstring"> We return a subclass that overload the get_method-method to return a custom method like "PUT".</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt> <tt class="py-line"><tt class="py-docstring"> Additionally, the request is enhanced with the current authenticators authorization scheme</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt> <tt class="py-line"><tt class="py-docstring"> headers.</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt> <tt class="py-line"><tt class="py-docstring"> @param url: the destination url</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt> <tt class="py-line"><tt class="py-docstring"> @param connector: our connector-instance</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt> <tt class="py-line"><tt class="py-docstring"> @param parameters: the POST-parameters to use.</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt> <tt class="py-line"><tt class="py-docstring"> @type parameters: None|dict&lt;str, basestring|list&lt;basestring&gt;&gt;</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt> <tt class="py-line"><tt class="py-docstring"> @param queryparams: the queryparams to use</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt> <tt class="py-line"><tt class="py-docstring"> @type queryparams: None|dict&lt;str, basestring|list&lt;basestring&gt;&gt;</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt> <tt class="py-line"><tt class="py-docstring"> @param alternate_http_method: an alternate HTTP-method to use</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt> <tt class="py-line"><tt class="py-docstring"> @type alternate_http_method: str</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt> <tt class="py-line"><tt class="py-docstring"> @return: the fully equipped request</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: urllib2.Request</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt> <tt class="py-line"> <tt class="py-keyword">class</tt> <tt class="py-def-name">MyRequest</tt><tt class="py-op">(</tt><tt class="py-base-class">urllib2</tt><tt class="py-op">.</tt><tt class="py-base-class">Request</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">get_method</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">alternate_http_method</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">alternate_http_method</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">.</tt><tt class="py-name">get_method</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L393"></a><tt class="py-lineno">393</tt> <tt class="py-line"> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">has_data</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">parameters</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L396"></a><tt class="py-lineno">396</tt> <tt class="py-line"> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">augment_request</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">params</tt><tt class="py-op">,</tt> <tt class="py-param">use_multipart</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt> <tt class="py-line"> <tt class="py-name">connector</tt><tt class="py-op">.</tt><tt class="py-name">authenticator</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="scapi.authentication.BasicAuthenticator.augment_request
scapi.authentication.OAuthAuthenticator.augment_request" class="py-name" href="#" onclick="return doclink('link-39', 'augment_request', 'link-23');">augment_request</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">params</tt><tt class="py-op">,</tt> <tt class="py-name">use_multipart</tt><tt class="py-op">)</tt> </tt>
</div><a name="L399"></a><tt class="py-lineno">399</tt> <tt class="py-line"> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">recreate_request</tt><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">location</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name" targets="Method scapi.Scope._create_request()=scapi.Scope-class.html#_create_request"><a title="scapi.Scope._create_request" class="py-name" href="#" onclick="return doclink('link-40', '_create_request', 'link-40');">_create_request</a></tt><tt class="py-op">(</tt><tt class="py-name">location</tt><tt class="py-op">,</tt> <tt class="py-name">connector</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L403"></a><tt class="py-lineno">403</tt> <tt class="py-line"> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt> <tt class="py-line"> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">MyRequest</tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt> <tt class="py-line"> <tt class="py-name">all_params</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">parameters</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt> <tt class="py-line"> <tt class="py-name">all_params</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">parameters</tt><tt class="py-op">)</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">queryparams</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt> <tt class="py-line"> <tt class="py-name">all_params</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">queryparams</tt><tt class="py-op">)</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">all_params</tt><tt class="py-op">:</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt> <tt class="py-line"> <tt class="py-name">all_params</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt> <tt class="py-line"> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="scapi.authentication.BasicAuthenticator.augment_request
scapi.authentication.OAuthAuthenticator.augment_request" class="py-name" href="#" onclick="return doclink('link-41', 'augment_request', 'link-23');">augment_request</a></tt><tt class="py-op">(</tt><tt class="py-name">all_params</tt><tt class="py-op">,</tt> <tt class="py-name">use_multipart</tt><tt class="py-op">)</tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt> <tt class="py-line"> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt class="py-name">add_header</tt><tt class="py-op">(</tt><tt class="py-string">"Accept"</tt><tt class="py-op">,</tt> <tt class="py-string">"application/json"</tt><tt class="py-op">)</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">req</tt> </tt>
</div><a name="L415"></a><tt class="py-lineno">415</tt> <tt class="py-line"> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt> <tt class="py-line"> </tt>
<a name="Scope._create_query_string"></a><div id="Scope._create_query_string-def"><a name="L417"></a><tt class="py-lineno">417</tt> <a class="py-toggle" href="#" id="Scope._create_query_string-toggle" onclick="return toggle('Scope._create_query_string');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#_create_query_string">_create_query_string</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">queryparams</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope._create_query_string-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope._create_query_string-expanded"><a name="L418"></a><tt class="py-lineno">418</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt> <tt class="py-line"><tt class="py-docstring"> Small helpermethod to create the querystring from a dict.</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt> <tt class="py-line"><tt class="py-docstring"> @type queryparams: None|dict&lt;str, basestring|list&lt;basestring&gt;&gt;</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt> <tt class="py-line"><tt class="py-docstring"> @param queryparams: the queryparameters.</tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt> <tt class="py-line"><tt class="py-docstring"> @return: either the empty string, or a "?" followed by the parameters joined by "&amp;"</tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: str</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">queryparams</tt><tt class="py-op">:</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">""</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt> <tt class="py-line"> <tt class="py-name">h</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">values</tt> <tt class="py-keyword">in</tt> <tt class="py-name">queryparams</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">long</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">)</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">values</tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">values</tt><tt class="py-op">]</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">values</tt><tt class="py-op">:</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt> <tt class="py-line"> <tt class="py-name">v</tt> <tt class="py-op">=</tt> <tt class="py-name">v</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt> <tt class="py-line"> <tt class="py-name">h</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"%s=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt id="link-42" class="py-name"><a title="scapi.util.escape" class="py-name" href="#" onclick="return doclink('link-42', 'escape', 'link-6');">escape</a></tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">"?"</tt> <tt class="py-op">+</tt> <tt class="py-string">"&amp;"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">h</tt><tt class="py-op">)</tt> </tt>
</div><a name="L438"></a><tt class="py-lineno">438</tt> <tt class="py-line"> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt> <tt class="py-line"> </tt>
<a name="Scope._call"></a><div id="Scope._call-def"><a name="L440"></a><tt class="py-lineno">440</tt> <a class="py-toggle" href="#" id="Scope._call-toggle" onclick="return toggle('Scope._call');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#_call">_call</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope._call-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope._call-expanded"><a name="L441"></a><tt class="py-lineno">441</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt> <tt class="py-line"><tt class="py-docstring"> The workhorse. It's complicated, convoluted and beyond understanding of a mortal being.</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt> <tt class="py-line"><tt class="py-docstring"> You have been warned.</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt> <tt class="py-line"> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt> <tt class="py-line"> <tt class="py-name">queryparams</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt> <tt class="py-line"> <tt class="py-name">__offset__</tt> <tt class="py-op">=</tt> <tt id="link-43" class="py-name" targets="Class scapi.ApiConnector=scapi.ApiConnector-class.html"><a title="scapi.ApiConnector" class="py-name" href="#" onclick="return doclink('link-43', 'ApiConnector', 'link-43');">ApiConnector</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="scapi.ApiConnector.LIST_LIMIT" class="py-name" href="#" onclick="return doclink('link-44', 'LIST_LIMIT', 'link-17');">LIST_LIMIT</a></tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">"__offset__"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt> <tt class="py-line"> <tt class="py-name">offset</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-string">"__offset__"</tt><tt class="py-op">)</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt> <tt class="py-line"> <tt class="py-name">queryparams</tt><tt class="py-op">[</tt><tt class="py-string">'offset'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">offset</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt> <tt class="py-line"> <tt class="py-name">__offset__</tt> <tt class="py-op">=</tt> <tt class="py-name">offset</tt> <tt class="py-op">+</tt> <tt id="link-45" class="py-name"><a title="scapi.ApiConnector" class="py-name" href="#" onclick="return doclink('link-45', 'ApiConnector', 'link-43');">ApiConnector</a></tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="scapi.ApiConnector.LIST_LIMIT" class="py-name" href="#" onclick="return doclink('link-46', 'LIST_LIMIT', 'link-17');">LIST_LIMIT</a></tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt> <tt class="py-line"> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">"params"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt> <tt class="py-line"> <tt class="py-name">queryparams</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-string">"params"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt> <tt class="py-line"> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt> <tt class="py-line"> <tt class="py-comment"># create a closure to invoke this method again with a greater offset</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">_cl_method</tt> <tt class="py-op">=</tt> <tt class="py-name">method</tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt> <tt class="py-line"> <tt class="py-name">_cl_args</tt> <tt class="py-op">=</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt> <tt class="py-line"> <tt class="py-name">_cl_kwargs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt> <tt class="py-line"> <tt class="py-name">_cl_kwargs</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt> <tt class="py-line"> <tt class="py-name">_cl_kwargs</tt><tt class="py-op">[</tt><tt class="py-string">"__offset__"</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">__offset__</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">continue_list_fetching</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name" targets="Method scapi.Scope._call()=scapi.Scope-class.html#_call"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-47', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">_cl_args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">_cl_kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L465"></a><tt class="py-lineno">465</tt> <tt class="py-line"> <tt class="py-name">connector</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Method scapi.Scope._get_connector()=scapi.Scope-class.html#_get_connector"><a title="scapi.Scope._get_connector" class="py-name" href="#" onclick="return doclink('link-48', '_get_connector', 'link-48');">_get_connector</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">filelike</tt><tt class="py-op">(</tt><tt class="py-param">v</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">,</tt> <tt class="py-string">"read"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L472"></a><tt class="py-lineno">472</tt> <tt class="py-line"> <tt class="py-name">alternate_http_method</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">"_alternate_http_method"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">kwargs</tt><tt class="py-op">:</tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt> <tt class="py-line"> <tt class="py-name">alternate_http_method</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt><tt class="py-op">.</tt><tt class="py-name">pop</tt><tt class="py-op">(</tt><tt class="py-string">"_alternate_http_method"</tt><tt class="py-op">)</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt> <tt class="py-line"> <tt class="py-name">urlparams</tt> <tt class="py-op">=</tt> <tt class="py-name">kwargs</tt> <tt class="py-keyword">if</tt> <tt class="py-name">kwargs</tt> <tt class="py-keyword">else</tt> <tt class="py-name">None</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt> <tt class="py-line"> <tt class="py-name">use_multipart</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">urlparams</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt> <tt class="py-line"> <tt class="py-name">fileargs</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">urlparams</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-name">filelike</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt> <tt class="py-line"> <tt class="py-name">use_multipart</tt> <tt class="py-op">=</tt> <tt class="py-name">bool</tt><tt class="py-op">(</tt><tt class="py-name">fileargs</tt><tt class="py-op">)</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt> <tt class="py-line"> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt> <tt class="py-line"> <tt class="py-comment"># ensure the method has a trailing /</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">method</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt class="py-string">"/"</tt><tt class="py-op">:</tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">method</tt> <tt class="py-op">+</tt> <tt class="py-string">"/"</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-string">"%s%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-string">"/"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">a</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">a</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt> <tt class="py-line"> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-49', '_scope', 'link-36');">_scope</a></tt><tt class="py-op">:</tt> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt> <tt class="py-line"> <tt class="py-name">scopes</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-50', '_scope', 'link-36');">_scope</a></tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">connector</tt><tt class="py-op">.</tt><tt class="py-name">collapse_scope</tt><tt class="py-op">:</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt> <tt class="py-line"> <tt class="py-name">scopes</tt> <tt class="py-op">=</tt> <tt class="py-name">scopes</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-string">"/"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">sc</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-51', '_scope', 'link-36');">_scope</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">sc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">scopes</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">"/"</tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt> <tt class="py-line"> <tt class="py-name">url</tt> <tt class="py-op">=</tt> <tt class="py-string">"http://%(host)s/%(base)s%(scope)s%(method)s%(queryparams)s"</tt> <tt class="py-op">%</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">host</tt><tt class="py-op">=</tt><tt class="py-name">connector</tt><tt class="py-op">.</tt><tt class="py-name">host</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">=</tt><tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-name">base</tt><tt class="py-op">=</tt><tt class="py-name">connector</tt><tt class="py-op">.</tt><tt class="py-name">_base</tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">=</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">queryparams</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method scapi.Scope._create_query_string()=scapi.Scope-class.html#_create_query_string"><a title="scapi.Scope._create_query_string" class="py-name" href="#" onclick="return doclink('link-52', '_create_query_string', 'link-52');">_create_query_string</a></tt><tt class="py-op">(</tt><tt class="py-name">queryparams</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt> <tt class="py-line"> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt> <tt class="py-line"> <tt class="py-comment"># we need to install SCRedirectHandler</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># to gather possible See-Other redirects</tt> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># so that we can exchange our method</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">redirect_handler</tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name" targets="Class scapi.SCRedirectHandler=scapi.SCRedirectHandler-class.html"><a title="scapi.SCRedirectHandler" class="py-name" href="#" onclick="return doclink('link-53', 'SCRedirectHandler', 'link-53');">SCRedirectHandler</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt> <tt class="py-line"> <tt class="py-name">handlers</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">redirect_handler</tt><tt class="py-op">]</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-54" class="py-name"><a title="scapi.USE_PROXY" class="py-name" href="#" onclick="return doclink('link-54', 'USE_PROXY', 'link-9');">USE_PROXY</a></tt><tt class="py-op">:</tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt> <tt class="py-line"> <tt class="py-name">handlers</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">ProxyHandler</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-string">'http'</tt> <tt class="py-op">:</tt> <tt id="link-55" class="py-name"><a title="scapi.PROXY" class="py-name" href="#" onclick="return doclink('link-55', 'PROXY', 'link-10');">PROXY</a></tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt> <tt class="py-line"> <tt class="py-name">req</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="scapi.Scope._create_request" class="py-name" href="#" onclick="return doclink('link-56', '_create_request', 'link-40');">_create_request</a></tt><tt class="py-op">(</tt><tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">connector</tt><tt class="py-op">,</tt> <tt class="py-name">urlparams</tt><tt class="py-op">,</tt> <tt class="py-name">queryparams</tt><tt class="py-op">,</tt> <tt class="py-name">alternate_http_method</tt><tt class="py-op">,</tt> <tt class="py-name">use_multipart</tt><tt class="py-op">)</tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt> <tt class="py-line"> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt> <tt class="py-line"> <tt class="py-name">http_method</tt> <tt class="py-op">=</tt> <tt class="py-name">req</tt><tt class="py-op">.</tt><tt class="py-name">get_method</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">urlparams</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt> <tt class="py-line"> <tt id="link-57" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-57', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Posting url: %s, method: %s"</tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">)</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt> <tt class="py-line"> <tt id="link-58" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-58', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Fetching url: %s, method: %s"</tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">,</tt> <tt class="py-name">http_method</tt><tt class="py-op">)</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt> <tt class="py-line"> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt> <tt class="py-line"> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">use_multipart</tt><tt class="py-op">:</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt> <tt class="py-line"> <tt class="py-name">handlers</tt><tt class="py-op">.</tt><tt class="py-name">extend</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">MultipartPostHandler</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">urlparams</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt> <tt class="py-line"> <tt class="py-name">urlparams</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">urlparams</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">build_opener</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">handlers</tt><tt class="py-op">)</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt> <tt class="py-line"> <tt class="py-name">handle</tt> <tt class="py-op">=</tt> <tt class="py-name">opener</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">req</tt><tt class="py-op">,</tt> <tt class="py-name">urlparams</tt><tt class="py-op">)</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-59" class="py-name"><a title="scapi.NoResultFromRequest" class="py-name" href="#" onclick="return doclink('link-59', 'NoResultFromRequest', 'link-34');">NoResultFromRequest</a></tt><tt class="py-op">:</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">urllib2</tt><tt class="py-op">.</tt><tt class="py-name">HTTPError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">http_method</tt> <tt class="py-op">==</tt> <tt class="py-string">"GET"</tt> <tt class="py-keyword">and</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">code</tt> <tt class="py-op">==</tt> <tt class="py-number">404</tt><tt class="py-op">:</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt> <tt class="py-line"> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt> <tt class="py-line"> <tt class="py-name">info</tt> <tt class="py-op">=</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt> <tt class="py-line"> <tt class="py-name">ct</tt> <tt class="py-op">=</tt> <tt class="py-name">info</tt><tt class="py-op">[</tt><tt class="py-string">'Content-Type'</tt><tt class="py-op">]</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="scapi.json.JsonReader.read
scapi.json.read" class="py-name" href="#" onclick="return doclink('link-60', 'read', 'link-26');">read</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt> <tt class="py-line"> <tt id="link-61" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-61', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Content-type:%s"</tt><tt class="py-op">,</tt> <tt class="py-name">ct</tt><tt class="py-op">)</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt> <tt class="py-line"> <tt id="link-62" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-62', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Request Content:\n%s"</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">redirect_handler</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="scapi.SCRedirectHandler.alternate_method" class="py-name" href="#" onclick="return doclink('link-63', 'alternate_method', 'link-30');">alternate_method</a></tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt> <tt class="py-line"> <tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-name">connector</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name" targets="Method scapi.ApiConnector.normalize_method()=scapi.ApiConnector-class.html#normalize_method"><a title="scapi.ApiConnector.normalize_method" class="py-name" href="#" onclick="return doclink('link-64', 'normalize_method', 'link-64');">normalize_method</a></tt><tt class="py-op">(</tt><tt class="py-name">redirect_handler</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="scapi.SCRedirectHandler.alternate_method" class="py-name" href="#" onclick="return doclink('link-65', 'alternate_method', 'link-30');">alternate_method</a></tt><tt class="py-op">)</tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt> <tt class="py-line"> <tt id="link-66" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-66', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Method changed through redirect to: &lt;%s&gt;"</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">)</tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt> <tt class="py-line"> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L536"></a><tt class="py-lineno">536</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">"application/json"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">ct</tt><tt class="py-op">:</tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-name">content</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L538"></a><tt class="py-lineno">538</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">content</tt><tt class="py-op">:</tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt> <tt class="py-line"> <tt class="py-name">content</tt> <tt class="py-op">=</tt> <tt class="py-string">"{}"</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-name">simplejson</tt><tt class="py-op">.</tt><tt class="py-name">loads</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt> <tt class="py-line"> <tt id="link-67" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-67', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-string">"Couldn't decode returned json"</tt><tt class="py-op">)</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt> <tt class="py-line"> <tt id="link-68" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-68', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Method scapi.Scope._map()=scapi.Scope-class.html#_map"><a title="scapi.Scope._map" class="py-name" href="#" onclick="return doclink('link-69', '_map', 'link-69');">_map</a></tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">,</tt> <tt class="py-name">method</tt><tt class="py-op">,</tt> <tt class="py-name">continue_list_fetching</tt><tt class="py-op">)</tt> </tt>
<a name="L547"></a><tt class="py-lineno">547</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">content</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt> <tt class="py-line"> <tt class="py-comment"># this might be the famous SeeOtherSpecialCase which means that</tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># all that matters is just the method</tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-70" class="py-name" targets="Class scapi.UnknownContentType=scapi.UnknownContentType-class.html"><a title="scapi.UnknownContentType" class="py-name" href="#" onclick="return doclink('link-70', 'UnknownContentType', 'link-70');">UnknownContentType</a></tt><tt class="py-op">(</tt><tt class="py-string">"%s, returned:\n%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">ct</tt><tt class="py-op">,</tt> <tt class="py-name">content</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt> <tt class="py-line"> <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L554"></a><tt class="py-lineno">554</tt> <tt class="py-line"> <tt class="py-name">handle</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L555"></a><tt class="py-lineno">555</tt> <tt class="py-line"> </tt>
<a name="Scope._map"></a><div id="Scope._map-def"><a name="L556"></a><tt class="py-lineno">556</tt> <a class="py-toggle" href="#" id="Scope._map-toggle" onclick="return toggle('Scope._map');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#_map">_map</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">res</tt><tt class="py-op">,</tt> <tt class="py-param">method</tt><tt class="py-op">,</tt> <tt class="py-param">continue_list_fetching</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope._map-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope._map-expanded"><a name="L557"></a><tt class="py-lineno">557</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt> <tt class="py-line"><tt class="py-docstring"> This method will take the JSON-result of a HTTP-call and return our domain-objects.</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt> <tt class="py-line"><tt class="py-docstring"> It's also deep magic, don't look.</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt> <tt class="py-line"> <tt class="py-name">pathparts</tt> <tt class="py-op">=</tt> <tt class="py-name">reversed</tt><tt class="py-op">(</tt><tt class="py-name">method</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">"/"</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt> <tt class="py-line"> <tt class="py-name">stack</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt class="py-name">pathparts</tt><tt class="py-op">:</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt> <tt class="py-line"> <tt class="py-name">stack</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">part</tt><tt class="py-op">)</tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">part</tt> <tt class="py-keyword">in</tt> <tt id="link-71" class="py-name" targets="Class scapi.RESTBase=scapi.RESTBase-class.html"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-71', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Variable scapi.RESTBase.REGISTRY=scapi.RESTBase-class.html#REGISTRY"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-72', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">:</tt> </tt>
<a name="L567"></a><tt class="py-lineno">567</tt> <tt class="py-line"> <tt class="py-name">cls</tt> <tt class="py-op">=</tt> <tt id="link-73" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-73', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-74', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">part</tt><tt class="py-op">]</tt> </tt>
<a name="L568"></a><tt class="py-lineno">568</tt> <tt class="py-line"> <tt class="py-comment"># multiple objects</tt> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">result_gen</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt> <tt class="py-line"> <tt class="py-name">count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">res</tt><tt class="py-op">:</tt> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt> <tt class="py-line"> <tt class="py-keyword">yield</tt> <tt class="py-name">cls</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">)</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt> <tt class="py-line"> <tt class="py-name">count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L575"></a><tt class="py-lineno">575</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">count</tt> <tt class="py-op">==</tt> <tt id="link-75" class="py-name"><a title="scapi.ApiConnector" class="py-name" href="#" onclick="return doclink('link-75', 'ApiConnector', 'link-43');">ApiConnector</a></tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="scapi.ApiConnector.LIST_LIMIT" class="py-name" href="#" onclick="return doclink('link-76', 'LIST_LIMIT', 'link-17');">LIST_LIMIT</a></tt><tt class="py-op">:</tt> </tt>
<a name="L576"></a><tt class="py-lineno">576</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">item</tt> <tt class="py-keyword">in</tt> <tt class="py-name">continue_list_fetching</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L577"></a><tt class="py-lineno">577</tt> <tt class="py-line"> <tt class="py-keyword">yield</tt> <tt class="py-name">item</tt> </tt>
</div><a name="L578"></a><tt class="py-lineno">578</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">result_gen</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cls</tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">stack</tt><tt class="py-op">)</tt> </tt>
<a name="L581"></a><tt class="py-lineno">581</tt> <tt class="py-line"> <tt id="link-77" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-77', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"don't know how to handle result"</tt><tt class="py-op">)</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt> <tt class="py-line"> <tt id="link-78" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-78', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">)</tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
</div><a name="L584"></a><tt class="py-lineno">584</tt> <tt class="py-line"> </tt>
<a name="Scope.__getattr__"></a><div id="Scope.__getattr__-def"><a name="L585"></a><tt class="py-lineno">585</tt> <a class="py-toggle" href="#" id="Scope.__getattr__-toggle" onclick="return toggle('Scope.__getattr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#__getattr__">__getattr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope.__getattr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope.__getattr__-expanded"><a name="L586"></a><tt class="py-lineno">586</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt> <tt class="py-line"><tt class="py-docstring"> Retrieve an API-method or a scoped domain-class. </tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt> <tt class="py-line"><tt class="py-docstring"> If the former, result is a callable that supports the following invocations:</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L591"></a><tt class="py-lineno">591</tt> <tt class="py-line"><tt class="py-docstring"> - calling (...), with possible arguments (positional/keyword), return the resulting resource or list of resources.</tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt> <tt class="py-line"><tt class="py-docstring"> When calling, you can pass a keyword-argument B{params}. This must be a dict or L{MultiDict} and will be used to add additional query-get-parameters.</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt> <tt class="py-line"><tt class="py-docstring"> - invoking append(resource) on it will PUT the resource, making it part of the current resource. Makes</tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt> <tt class="py-line"><tt class="py-docstring"> sense only if it's a collection of course.</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L597"></a><tt class="py-lineno">597</tt> <tt class="py-line"><tt class="py-docstring"> - invoking remove(resource) on it will DELETE the resource from it's container. Also only usable on collections.</tt> </tt>
<a name="L598"></a><tt class="py-lineno">598</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L599"></a><tt class="py-lineno">599</tt> <tt class="py-line"><tt class="py-docstring"> TODO: describe the latter </tt> </tt>
<a name="L600"></a><tt class="py-lineno">600</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L601"></a><tt class="py-lineno">601</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt> <tt class="py-line"> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt> <tt class="py-line"> <tt class="py-keyword">class</tt> <tt class="py-def-name">api_call</tt><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">__call__</tt><tt class="py-op">(</tt><tt class="py-param">selfish</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-79', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">_name</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L606"></a><tt class="py-lineno">606</tt> <tt class="py-line"> </tt>
<a name="L607"></a><tt class="py-lineno">607</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwargs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L608"></a><tt class="py-lineno">608</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L609"></a><tt class="py-lineno">609</tt> <tt class="py-line"><tt class="py-docstring"> Will invoke the new method on the named resource _name, with </tt> </tt>
<a name="L610"></a><tt class="py-lineno">610</tt> <tt class="py-line"><tt class="py-docstring"> self as scope.</tt> </tt>
<a name="L611"></a><tt class="py-lineno">611</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L612"></a><tt class="py-lineno">612</tt> <tt class="py-line"> <tt class="py-name">cls</tt> <tt class="py-op">=</tt> <tt id="link-80" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-80', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-81', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">_name</tt><tt class="py-op">]</tt> </tt>
<a name="L613"></a><tt class="py-lineno">613</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name" targets="Class Method scapi.RESTBase.new()=scapi.RESTBase-class.html#new"><a title="scapi.RESTBase.new" class="py-name" href="#" onclick="return doclink('link-82', 'new', 'link-82');">new</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L614"></a><tt class="py-lineno">614</tt> <tt class="py-line"> </tt>
<a name="L615"></a><tt class="py-lineno">615</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">append</tt><tt class="py-op">(</tt><tt class="py-param">selfish</tt><tt class="py-op">,</tt> <tt class="py-param">resource</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L616"></a><tt class="py-lineno">616</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt> <tt class="py-line"><tt class="py-docstring"> If the current scope is </tt> </tt>
<a name="L618"></a><tt class="py-lineno">618</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L619"></a><tt class="py-lineno">619</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-83', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">_name</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">resource</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">_alternate_http_method</tt><tt class="py-op">=</tt><tt class="py-string">"PUT"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L620"></a><tt class="py-lineno">620</tt> <tt class="py-line"> </tt>
<a name="L621"></a><tt class="py-lineno">621</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">remove</tt><tt class="py-op">(</tt><tt class="py-param">selfish</tt><tt class="py-op">,</tt> <tt class="py-param">resource</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-84', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">_name</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">resource</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">_alternate_http_method</tt><tt class="py-op">=</tt><tt class="py-string">"DELETE"</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L623"></a><tt class="py-lineno">623</tt> <tt class="py-line"> </tt>
<a name="L624"></a><tt class="py-lineno">624</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">_name</tt> <tt class="py-keyword">in</tt> <tt id="link-85" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-85', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-86" class="py-name" targets="Variable scapi.RESTBase.ALL_DOMAIN_CLASSES=scapi.RESTBase-class.html#ALL_DOMAIN_CLASSES"><a title="scapi.RESTBase.ALL_DOMAIN_CLASSES" class="py-name" href="#" onclick="return doclink('link-86', 'ALL_DOMAIN_CLASSES', 'link-86');">ALL_DOMAIN_CLASSES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L625"></a><tt class="py-lineno">625</tt> <tt class="py-line"> <tt class="py-name">cls</tt> <tt class="py-op">=</tt> <tt id="link-87" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-87', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="scapi.RESTBase.ALL_DOMAIN_CLASSES" class="py-name" href="#" onclick="return doclink('link-88', 'ALL_DOMAIN_CLASSES', 'link-86');">ALL_DOMAIN_CLASSES</a></tt><tt class="py-op">[</tt><tt class="py-name">_name</tt><tt class="py-op">]</tt> </tt>
<a name="L626"></a><tt class="py-lineno">626</tt> <tt class="py-line"> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt> <tt class="py-line"> <tt class="py-keyword">class</tt> <tt class="py-def-name">ScopeBinder</tt><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">new</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt> <tt class="py-line"> </tt>
<a name="L630"></a><tt class="py-lineno">630</tt> <tt class="py-line"> <tt class="py-name">d</tt> <tt class="py-op">=</tt> <tt id="link-89" class="py-name"><a title="scapi.util.MultiDict" class="py-name" href="#" onclick="return doclink('link-89', 'MultiDict', 'link-7');">MultiDict</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L631"></a><tt class="py-lineno">631</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name" targets="Class Method scapi.RESTBase._singleton()=scapi.RESTBase-class.html#_singleton"><a title="scapi.RESTBase._singleton" class="py-name" href="#" onclick="return doclink('link-90', '_singleton', 'link-90');">_singleton</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L632"></a><tt class="py-lineno">632</tt> <tt class="py-line"> </tt>
<a name="L633"></a><tt class="py-lineno">633</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">unfold_value</tt><tt class="py-op">(</tt><tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L634"></a><tt class="py-lineno">634</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">basestring</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L635"></a><tt class="py-lineno">635</tt> <tt class="py-line"> <tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name" targets="Method scapi.util.MultiDict.add()=scapi.util.MultiDict-class.html#add"><a title="scapi.util.MultiDict.add" class="py-name" href="#" onclick="return doclink('link-91', 'add', 'link-91');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L636"></a><tt class="py-lineno">636</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L637"></a><tt class="py-lineno">637</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">sub_key</tt><tt class="py-op">,</tt> <tt class="py-name">sub_value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L638"></a><tt class="py-lineno">638</tt> <tt class="py-line"> <tt class="py-name">unfold_value</tt><tt class="py-op">(</tt><tt class="py-string">"%s[%s]"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">sub_key</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">sub_value</tt><tt class="py-op">)</tt> </tt>
<a name="L639"></a><tt class="py-lineno">639</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L640"></a><tt class="py-lineno">640</tt> <tt class="py-line"> <tt class="py-comment"># assume iteration else</tt> </tt>
<a name="L641"></a><tt class="py-lineno">641</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">for</tt> <tt class="py-name">sub_value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value</tt><tt class="py-op">:</tt> </tt>
<a name="L642"></a><tt class="py-lineno">642</tt> <tt class="py-line"> <tt class="py-name">unfold_value</tt><tt class="py-op">(</tt><tt class="py-name">key</tt> <tt class="py-op">+</tt> <tt class="py-string">"[]"</tt><tt class="py-op">,</tt> <tt class="py-name">sub_value</tt><tt class="py-op">)</tt> </tt>
</div><a name="L643"></a><tt class="py-lineno">643</tt> <tt class="py-line"> </tt>
<a name="L644"></a><tt class="py-lineno">644</tt> <tt class="py-line"> </tt>
<a name="L645"></a><tt class="py-lineno">645</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">data</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L646"></a><tt class="py-lineno">646</tt> <tt class="py-line"> <tt class="py-name">unfold_value</tt><tt class="py-op">(</tt><tt class="py-string">"%s[%s]"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L647"></a><tt class="py-lineno">647</tt> <tt class="py-line"> </tt>
<a name="L648"></a><tt class="py-lineno">648</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">scope</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-92', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-93" class="py-name" targets="Variable scapi.Comment.KIND=scapi.Comment-class.html#KIND,Variable scapi.Event.KIND=scapi.Event-class.html#KIND,Variable scapi.Group.KIND=scapi.Group-class.html#KIND,Variable scapi.Playlist.KIND=scapi.Playlist-class.html#KIND,Variable scapi.RESTBase.KIND=scapi.RESTBase-class.html#KIND,Variable scapi.Track.KIND=scapi.Track-class.html#KIND,Variable scapi.User.KIND=scapi.User-class.html#KIND"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-93', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
</div><a name="L649"></a><tt class="py-lineno">649</tt> <tt class="py-line"> </tt>
<a name="L650"></a><tt class="py-lineno">650</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">create</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L651"></a><tt class="py-lineno">651</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name" targets="Class Method scapi.RESTBase.create()=scapi.RESTBase-class.html#create"><a title="scapi.RESTBase.create" class="py-name" href="#" onclick="return doclink('link-94', 'create', 'link-94');">create</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
</div><a name="L652"></a><tt class="py-lineno">652</tt> <tt class="py-line"> </tt>
<a name="L653"></a><tt class="py-lineno">653</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">get</tt><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L654"></a><tt class="py-lineno">654</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-95" class="py-name" targets="Class Method scapi.RESTBase.get()=scapi.RESTBase-class.html#get"><a title="scapi.RESTBase.get" class="py-name" href="#" onclick="return doclink('link-95', 'get', 'link-95');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">id</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L655"></a><tt class="py-lineno">655</tt> <tt class="py-line"> </tt>
<a name="L656"></a><tt class="py-lineno">656</tt> <tt class="py-line"> </tt>
<a name="L657"></a><tt class="py-lineno">657</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">ScopeBinder</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L658"></a><tt class="py-lineno">658</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">api_call</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L659"></a><tt class="py-lineno">659</tt> <tt class="py-line"> </tt>
<a name="Scope.__repr__"></a><div id="Scope.__repr__-def"><a name="L660"></a><tt class="py-lineno">660</tt> <a class="py-toggle" href="#" id="Scope.__repr__-toggle" onclick="return toggle('Scope.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope.__repr__-expanded"><a name="L661"></a><tt class="py-lineno">661</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
</div><a name="L662"></a><tt class="py-lineno">662</tt> <tt class="py-line"> </tt>
<a name="Scope.__str__"></a><div id="Scope.__str__-def"><a name="L663"></a><tt class="py-lineno">663</tt> <a class="py-toggle" href="#" id="Scope.__str__-toggle" onclick="return toggle('Scope.__str__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.Scope-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Scope.__str__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Scope.__str__-expanded"><a name="L664"></a><tt class="py-lineno">664</tt> <tt class="py-line"> <tt class="py-name">scopes</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="scapi.RESTBase._scope" class="py-name" href="#" onclick="return doclink('link-96', '_scope', 'link-36');">_scope</a></tt> </tt>
<a name="L665"></a><tt class="py-lineno">665</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L666"></a><tt class="py-lineno">666</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt>
<a name="L667"></a><tt class="py-lineno">667</tt> <tt class="py-line"> <tt class="py-name">base</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">2</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L668"></a><tt class="py-lineno">668</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">base</tt> <tt class="py-op">+</tt> <tt class="py-string">"/"</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L669"></a><tt class="py-lineno">669</tt> <tt class="py-line"> </tt>
<a name="RESTBase"></a><div id="RESTBase-def"><a name="L670"></a><tt class="py-lineno">670</tt> <tt class="py-line"> </tt>
<a name="L671"></a><tt class="py-lineno">671</tt> <tt class="py-line"><tt class="py-comment"># maybe someday I'll make that work.</tt> </tt>
<a name="L672"></a><tt class="py-lineno">672</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># class RESTBaseMeta(type):</tt> </tt>
<a name="L673"></a><tt class="py-lineno">673</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># def __new__(self, name, bases, d):</tt> </tt>
<a name="L674"></a><tt class="py-lineno">674</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># clazz = type(name, bases, d)</tt> </tt>
<a name="L675"></a><tt class="py-lineno">675</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># if 'KIND' in d:</tt> </tt>
<a name="L676"></a><tt class="py-lineno">676</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># kind = d['KIND']</tt> </tt>
<a name="L677"></a><tt class="py-lineno">677</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># RESTBase.REGISTRY[kind] = clazz</tt> </tt>
<a name="L678"></a><tt class="py-lineno">678</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># return clazz</tt> </tt>
<a name="L679"></a><tt class="py-lineno">679</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L680"></a><tt class="py-lineno">680</tt> <a class="py-toggle" href="#" id="RESTBase-toggle" onclick="return toggle('RESTBase');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.RESTBase-class.html">RESTBase</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="RESTBase-expanded"><a name="L681"></a><tt class="py-lineno">681</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L682"></a><tt class="py-lineno">682</tt> <tt class="py-line"><tt class="py-docstring"> The baseclass for all our domain-objects/resources.</tt> </tt>
<a name="L683"></a><tt class="py-lineno">683</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L684"></a><tt class="py-lineno">684</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L685"></a><tt class="py-lineno">685</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L686"></a><tt class="py-lineno">686</tt> <tt class="py-line"> <tt id="link-97" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-97', 'REGISTRY', 'link-72');">REGISTRY</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L687"></a><tt class="py-lineno">687</tt> <tt class="py-line"> </tt>
<a name="L688"></a><tt class="py-lineno">688</tt> <tt class="py-line"> <tt id="link-98" class="py-name"><a title="scapi.RESTBase.ALL_DOMAIN_CLASSES" class="py-name" href="#" onclick="return doclink('link-98', 'ALL_DOMAIN_CLASSES', 'link-86');">ALL_DOMAIN_CLASSES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L689"></a><tt class="py-lineno">689</tt> <tt class="py-line"> </tt>
<a name="L690"></a><tt class="py-lineno">690</tt> <tt class="py-line"> <tt id="link-99" class="py-name" targets="Variable scapi.RESTBase.ALIASES=scapi.RESTBase-class.html#ALIASES,Variable scapi.Track.ALIASES=scapi.Track-class.html#ALIASES,Variable scapi.User.ALIASES=scapi.User-class.html#ALIASES"><a title="scapi.RESTBase.ALIASES
scapi.Track.ALIASES
scapi.User.ALIASES" class="py-name" href="#" onclick="return doclink('link-99', 'ALIASES', 'link-99');">ALIASES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L691"></a><tt class="py-lineno">691</tt> <tt class="py-line"> </tt>
<a name="L692"></a><tt class="py-lineno">692</tt> <tt class="py-line"> <tt id="link-100" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-100', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L693"></a><tt class="py-lineno">693</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__init__"></a><div id="RESTBase.__init__-def"><a name="L694"></a><tt class="py-lineno">694</tt> <a class="py-toggle" href="#" id="RESTBase.__init__-toggle" onclick="return toggle('RESTBase.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">path_stack</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__init__-expanded"><a name="L695"></a><tt class="py-lineno">695</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt> <tt class="py-op">=</tt> <tt class="py-name">data</tt> </tt>
<a name="L696"></a><tt class="py-lineno">696</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt> <tt class="py-op">=</tt> <tt class="py-name">scope</tt> </tt>
<a name="L697"></a><tt class="py-lineno">697</tt> <tt class="py-line"> <tt class="py-comment"># try and see if we can/must create an id out of our path</tt> </tt>
<a name="L698"></a><tt class="py-lineno">698</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-101" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-101', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"path_stack: %r"</tt><tt class="py-op">,</tt> <tt class="py-name">path_stack</tt><tt class="py-op">)</tt> </tt>
<a name="L699"></a><tt class="py-lineno">699</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">path_stack</tt><tt class="py-op">:</tt> </tt>
<a name="L700"></a><tt class="py-lineno">700</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L701"></a><tt class="py-lineno">701</tt> <tt class="py-line"> <tt class="py-name">id</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">path_stack</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L702"></a><tt class="py-lineno">702</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt><tt class="py-op">[</tt><tt class="py-string">'id'</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">id</tt> </tt>
<a name="L703"></a><tt class="py-lineno">703</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">ValueError</tt><tt class="py-op">:</tt> </tt>
<a name="L704"></a><tt class="py-lineno">704</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L705"></a><tt class="py-lineno">705</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__getattr__"></a><div id="RESTBase.__getattr__-def"><a name="L706"></a><tt class="py-lineno">706</tt> <a class="py-toggle" href="#" id="RESTBase.__getattr__-toggle" onclick="return toggle('RESTBase.__getattr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__getattr__">__getattr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__getattr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__getattr__-expanded"><a name="L707"></a><tt class="py-lineno">707</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt><tt class="py-op">:</tt> </tt>
<a name="L708"></a><tt class="py-lineno">708</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> </tt>
<a name="L709"></a><tt class="py-lineno">709</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt id="link-102" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-102', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-103', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">:</tt> </tt>
<a name="L710"></a><tt class="py-lineno">710</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt class="py-name">dict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L711"></a><tt class="py-lineno">711</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt id="link-104" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-104', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-105', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">)</tt> </tt>
<a name="L712"></a><tt class="py-lineno">712</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">obj</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L713"></a><tt class="py-lineno">713</tt> <tt class="py-line"> <tt class="py-name">obj</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt id="link-106" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-106', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-107', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt><tt class="py-op">(</tt><tt class="py-name">o</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">o</tt> <tt class="py-keyword">in</tt> <tt class="py-name">obj</tt><tt class="py-op">]</tt> </tt>
<a name="L714"></a><tt class="py-lineno">714</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L715"></a><tt class="py-lineno">715</tt> <tt class="py-line"> <tt id="link-108" class="py-name"><a title="scapi.authentication.logger
scapi.logger
scapi.tests.scapi_tests.logger
scapi.tests.test_connect.logger
scapi.tests.test_oauth.logger" class="py-name" href="#" onclick="return doclink('link-108', 'logger', 'link-8');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-string">"Found %s in our registry, but don't know what to do with"</tt>\ </tt>
<a name="L716"></a><tt class="py-lineno">716</tt> <tt class="py-line"> <tt class="py-string">"the object."</tt><tt class="py-op">)</tt> </tt>
<a name="L717"></a><tt class="py-lineno">717</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">obj</tt> </tt>
<a name="L718"></a><tt class="py-lineno">718</tt> <tt class="py-line"> <tt class="py-name">scope</tt> <tt class="py-op">=</tt> <tt id="link-109" class="py-name" targets="Class scapi.Scope=scapi.Scope-class.html"><a title="scapi.Scope" class="py-name" href="#" onclick="return doclink('link-109', 'Scope', 'link-109');">Scope</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="scapi.Scope._get_connector" class="py-name" href="#" onclick="return doclink('link-110', '_get_connector', 'link-48');">_get_connector</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">parent</tt><tt class="py-op">=</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">)</tt> </tt>
<a name="L719"></a><tt class="py-lineno">719</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L720"></a><tt class="py-lineno">720</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__setattr__"></a><div id="RESTBase.__setattr__-def"><a name="L721"></a><tt class="py-lineno">721</tt> <a class="py-toggle" href="#" id="RESTBase.__setattr__-toggle" onclick="return toggle('RESTBase.__setattr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__setattr__">__setattr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__setattr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__setattr__-expanded"><a name="L722"></a><tt class="py-lineno">722</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L723"></a><tt class="py-lineno">723</tt> <tt class="py-line"><tt class="py-docstring"> This method is used to set a property, a resource or a list of resources as property of the resource the</tt> </tt>
<a name="L724"></a><tt class="py-lineno">724</tt> <tt class="py-line"><tt class="py-docstring"> method is invoked on.</tt> </tt>
<a name="L725"></a><tt class="py-lineno">725</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L726"></a><tt class="py-lineno">726</tt> <tt class="py-line"><tt class="py-docstring"> For example, to set a comment on a track, do</tt> </tt>
<a name="L727"></a><tt class="py-lineno">727</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L728"></a><tt class="py-lineno">728</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L729"></a><tt class="py-lineno">729</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = scapi.Track.new(title='bar', sharing="private")</tt> </tt>
<a name="L730"></a><tt class="py-lineno">730</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; comment = scapi.Comment.create(body="This is the body of my comment", timestamp=10) </tt> </tt>
<a name="L731"></a><tt class="py-lineno">731</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track.comments = comment</tt> </tt>
<a name="L732"></a><tt class="py-lineno">732</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L733"></a><tt class="py-lineno">733</tt> <tt class="py-line"><tt class="py-docstring"> To set a list of users as permissions, do</tt> </tt>
<a name="L734"></a><tt class="py-lineno">734</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L735"></a><tt class="py-lineno">735</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L736"></a><tt class="py-lineno">736</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; me = sca.me()</tt> </tt>
<a name="L737"></a><tt class="py-lineno">737</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = scapi.Track.new(title='bar', sharing="private")</tt> </tt>
<a name="L738"></a><tt class="py-lineno">738</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; users = sca.users()</tt> </tt>
<a name="L739"></a><tt class="py-lineno">739</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; users_to_set = [user for user in users[:10] if user != me]</tt> </tt>
<a name="L740"></a><tt class="py-lineno">740</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track.permissions = users_to_set</tt> </tt>
<a name="L741"></a><tt class="py-lineno">741</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L742"></a><tt class="py-lineno">742</tt> <tt class="py-line"><tt class="py-docstring"> And finally, to simply change the title of a track, do</tt> </tt>
<a name="L743"></a><tt class="py-lineno">743</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L744"></a><tt class="py-lineno">744</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L745"></a><tt class="py-lineno">745</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = sca.Track.get(track_id)</tt> </tt>
<a name="L746"></a><tt class="py-lineno">746</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track.title = "new_title"</tt> </tt>
<a name="L747"></a><tt class="py-lineno">747</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L748"></a><tt class="py-lineno">748</tt> <tt class="py-line"><tt class="py-docstring"> @param name: the property name</tt> </tt>
<a name="L749"></a><tt class="py-lineno">749</tt> <tt class="py-line"><tt class="py-docstring"> @type name: str</tt> </tt>
<a name="L750"></a><tt class="py-lineno">750</tt> <tt class="py-line"><tt class="py-docstring"> @param value: the property, resource or resources to set</tt> </tt>
<a name="L751"></a><tt class="py-lineno">751</tt> <tt class="py-line"><tt class="py-docstring"> @type value: RESTBase | list&lt;RESTBase&gt; | basestring | long | int | float</tt> </tt>
<a name="L752"></a><tt class="py-lineno">752</tt> <tt class="py-line"><tt class="py-docstring"> @return: None</tt> </tt>
<a name="L753"></a><tt class="py-lineno">753</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L754"></a><tt class="py-lineno">754</tt> <tt class="py-line"> </tt>
<a name="L755"></a><tt class="py-lineno">755</tt> <tt class="py-line"> <tt class="py-comment"># update "private" data, such as __data</tt> </tt>
<a name="L756"></a><tt class="py-lineno">756</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-keyword">if</tt> <tt class="py-string">"_RESTBase__"</tt> <tt class="py-keyword">in</tt> <tt class="py-name">name</tt><tt class="py-op">:</tt> </tt>
<a name="L757"></a><tt class="py-lineno">757</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt><tt class="py-op">[</tt><tt class="py-name">name</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L758"></a><tt class="py-lineno">758</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L759"></a><tt class="py-lineno">759</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L760"></a><tt class="py-lineno">760</tt> <tt class="py-line"> <tt class="py-comment"># the parametername is something like</tt> </tt>
<a name="L761"></a><tt class="py-lineno">761</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># permissions[user_id][]</tt> </tt>
<a name="L762"></a><tt class="py-lineno">762</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment"># so we try to infer that.</tt> </tt>
<a name="L763"></a><tt class="py-lineno">763</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parameter_name</tt> <tt class="py-op">=</tt> <tt class="py-string">"%s[%s_id][]"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="scapi.RESTBase._singleton" class="py-name" href="#" onclick="return doclink('link-111', '_singleton', 'link-90');">_singleton</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L764"></a><tt class="py-lineno">764</tt> <tt class="py-line"> <tt class="py-name">values</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">o</tt><tt class="py-op">.</tt><tt class="py-name">id</tt> <tt class="py-keyword">for</tt> <tt class="py-name">o</tt> <tt class="py-keyword">in</tt> <tt class="py-name">value</tt><tt class="py-op">]</tt> </tt>
<a name="L765"></a><tt class="py-lineno">765</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">"_alternate_http_method"</tt> <tt class="py-op">:</tt> <tt class="py-string">"PUT"</tt><tt class="py-op">,</tt> </tt>
<a name="L766"></a><tt class="py-lineno">766</tt> <tt class="py-line"> <tt class="py-name">parameter_name</tt> <tt class="py-op">:</tt> <tt class="py-name">values</tt><tt class="py-op">}</tt> </tt>
<a name="L767"></a><tt class="py-lineno">767</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-112', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-113', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">,</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
<a name="L768"></a><tt class="py-lineno">768</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt id="link-114" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-114', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L769"></a><tt class="py-lineno">769</tt> <tt class="py-line"> <tt class="py-comment"># we got a single instance, so make that an argument</tt> </tt>
<a name="L770"></a><tt class="py-lineno">770</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-115', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-116', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">,</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">value</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name" targets="Method scapi.RESTBase._as_arguments()=scapi.RESTBase-class.html#_as_arguments"><a title="scapi.RESTBase._as_arguments" class="py-name" href="#" onclick="return doclink('link-117', '_as_arguments', 'link-117');">_as_arguments</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L771"></a><tt class="py-lineno">771</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L772"></a><tt class="py-lineno">772</tt> <tt class="py-line"> <tt class="py-comment"># we have a simple property</tt> </tt>
<a name="L773"></a><tt class="py-lineno">773</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">parameter_name</tt> <tt class="py-op">=</tt> <tt class="py-string">"%s[%s]"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="scapi.RESTBase._singleton" class="py-name" href="#" onclick="return doclink('link-118', '_singleton', 'link-90');">_singleton</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
<a name="L774"></a><tt class="py-lineno">774</tt> <tt class="py-line"> <tt class="py-name">kwargs</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-string">"_alternate_http_method"</tt> <tt class="py-op">:</tt> <tt class="py-string">"PUT"</tt><tt class="py-op">,</tt> </tt>
<a name="L775"></a><tt class="py-lineno">775</tt> <tt class="py-line"> <tt class="py-name">parameter_name</tt> <tt class="py-op">:</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name" targets="Method scapi.RESTBase._convert_value()=scapi.RESTBase-class.html#_convert_value"><a title="scapi.RESTBase._convert_value" class="py-name" href="#" onclick="return doclink('link-119', '_convert_value', 'link-119');">_convert_value</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt><tt class="py-op">}</tt> </tt>
<a name="L776"></a><tt class="py-lineno">776</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__scope</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="scapi.Scope._call" class="py-name" href="#" onclick="return doclink('link-120', '_call', 'link-47');">_call</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-121', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwargs</tt><tt class="py-op">)</tt> </tt>
</div><a name="L777"></a><tt class="py-lineno">777</tt> <tt class="py-line"> </tt>
<a name="RESTBase._as_arguments"></a><div id="RESTBase._as_arguments-def"><a name="L778"></a><tt class="py-lineno">778</tt> <a class="py-toggle" href="#" id="RESTBase._as_arguments-toggle" onclick="return toggle('RESTBase._as_arguments');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#_as_arguments">_as_arguments</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><a name="L779"></a><tt class="py-lineno">779</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L780"></a><tt class="py-lineno">780</tt> <tt class="py-line"><tt class="py-docstring"> Converts a resource to a argument-string the way Rails expects it.</tt> </tt>
<a name="L781"></a><tt class="py-lineno">781</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L782"></a><tt class="py-lineno">782</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L783"></a><tt class="py-lineno">783</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L784"></a><tt class="py-lineno">784</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="scapi.RESTBase._convert_value" class="py-name" href="#" onclick="return doclink('link-122', '_convert_value', 'link-119');">_convert_value</a></tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L785"></a><tt class="py-lineno">785</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">[</tt><tt class="py-string">"%s[%s]"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="scapi.RESTBase._singleton" class="py-name" href="#" onclick="return doclink('link-123', '_singleton', 'link-90');">_singleton</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">key</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L786"></a><tt class="py-lineno">786</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
</div><a name="L787"></a><tt class="py-lineno">787</tt> <tt class="py-line"> </tt>
<a name="RESTBase._convert_value"></a><div id="RESTBase._convert_value-def"><a name="L788"></a><tt class="py-lineno">788</tt> <a class="py-toggle" href="#" id="RESTBase._convert_value-toggle" onclick="return toggle('RESTBase._convert_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#_convert_value">_convert_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase._convert_value-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase._convert_value-expanded"><a name="L789"></a><tt class="py-lineno">789</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L790"></a><tt class="py-lineno">790</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">"utf-8"</tt><tt class="py-op">)</tt> </tt>
<a name="L791"></a><tt class="py-lineno">791</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L792"></a><tt class="py-lineno">792</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
<a name="L793"></a><tt class="py-lineno">793</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L794"></a><tt class="py-lineno">794</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L795"></a><tt class="py-lineno">795</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">value</tt> </tt>
</div><a name="L796"></a><tt class="py-lineno">796</tt> <tt class="py-line"> </tt>
<a name="L797"></a><tt class="py-lineno">797</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt>
<a name="RESTBase.create"></a><div id="RESTBase.create-def"><a name="L798"></a><tt class="py-lineno">798</tt> <a class="py-toggle" href="#" id="RESTBase.create-toggle" onclick="return toggle('RESTBase.create');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#create">create</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.create-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.create-expanded"><a name="L799"></a><tt class="py-lineno">799</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L800"></a><tt class="py-lineno">800</tt> <tt class="py-line"><tt class="py-docstring"> This is a convenience-method for creating an object that will be passed</tt> </tt>
<a name="L801"></a><tt class="py-lineno">801</tt> <tt class="py-line"><tt class="py-docstring"> as parameter - e.g. a comment. A usage would look like this:</tt> </tt>
<a name="L802"></a><tt class="py-lineno">802</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L803"></a><tt class="py-lineno">803</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L804"></a><tt class="py-lineno">804</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = sca.Track.new(title='bar', sharing="private")</tt> </tt>
<a name="L805"></a><tt class="py-lineno">805</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; comment = sca.Comment.create(body="This is the body of my comment", timestamp=10) </tt> </tt>
<a name="L806"></a><tt class="py-lineno">806</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track.comments = comment</tt> </tt>
<a name="L807"></a><tt class="py-lineno">807</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L808"></a><tt class="py-lineno">808</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L809"></a><tt class="py-lineno">809</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">cls</tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">,</tt> <tt class="py-name">scope</tt><tt class="py-op">)</tt> </tt>
</div><a name="L810"></a><tt class="py-lineno">810</tt> <tt class="py-line"> </tt>
<a name="L811"></a><tt class="py-lineno">811</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt>
<a name="RESTBase.new"></a><div id="RESTBase.new-def"><a name="L812"></a><tt class="py-lineno">812</tt> <a class="py-toggle" href="#" id="RESTBase.new-toggle" onclick="return toggle('RESTBase.new');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#new">new</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">data</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.new-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.new-expanded"><a name="L813"></a><tt class="py-lineno">813</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L814"></a><tt class="py-lineno">814</tt> <tt class="py-line"><tt class="py-docstring"> Create a new resource inside a given Scope. The actual values are in data. </tt> </tt>
<a name="L815"></a><tt class="py-lineno">815</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L816"></a><tt class="py-lineno">816</tt> <tt class="py-line"><tt class="py-docstring"> So for creating new resources, you have two options:</tt> </tt>
<a name="L817"></a><tt class="py-lineno">817</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L818"></a><tt class="py-lineno">818</tt> <tt class="py-line"><tt class="py-docstring"> - create an instance directly using the class:</tt> </tt>
<a name="L819"></a><tt class="py-lineno">819</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L820"></a><tt class="py-lineno">820</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; scope = scapi.Scope(connector)</tt> </tt>
<a name="L821"></a><tt class="py-lineno">821</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; scope.User.new(...)</tt> </tt>
<a name="L822"></a><tt class="py-lineno">822</tt> <tt class="py-line"><tt class="py-docstring"> &lt;scapi.User object at 0x1234&gt;</tt> </tt>
<a name="L823"></a><tt class="py-lineno">823</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L824"></a><tt class="py-lineno">824</tt> <tt class="py-line"><tt class="py-docstring"> - create a instance in a certain scope:</tt> </tt>
<a name="L825"></a><tt class="py-lineno">825</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L826"></a><tt class="py-lineno">826</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; scope = scapi.Scope(connector)</tt> </tt>
<a name="L827"></a><tt class="py-lineno">827</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; user = scapi.User("1")</tt> </tt>
<a name="L828"></a><tt class="py-lineno">828</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = user.tracks.new()</tt> </tt>
<a name="L829"></a><tt class="py-lineno">829</tt> <tt class="py-line"><tt class="py-docstring"> &lt;scapi.Track object at 0x1234&gt;</tt> </tt>
<a name="L830"></a><tt class="py-lineno">830</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L831"></a><tt class="py-lineno">831</tt> <tt class="py-line"><tt class="py-docstring"> @param scope: if not empty, a one-element tuple containing the Scope</tt> </tt>
<a name="L832"></a><tt class="py-lineno">832</tt> <tt class="py-line"><tt class="py-docstring"> @type scope: tuple&lt;Scope&gt;[1]</tt> </tt>
<a name="L833"></a><tt class="py-lineno">833</tt> <tt class="py-line"><tt class="py-docstring"> @param data: the data</tt> </tt>
<a name="L834"></a><tt class="py-lineno">834</tt> <tt class="py-line"><tt class="py-docstring"> @type data: dict</tt> </tt>
<a name="L835"></a><tt class="py-lineno">835</tt> <tt class="py-line"><tt class="py-docstring"> @return: new instance of the resource</tt> </tt>
<a name="L836"></a><tt class="py-lineno">836</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L837"></a><tt class="py-lineno">837</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="scapi.RESTBase.new" class="py-name" href="#" onclick="return doclink('link-124', 'new', 'link-82');">new</a></tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
</div><a name="L838"></a><tt class="py-lineno">838</tt> <tt class="py-line"> </tt>
<a name="L839"></a><tt class="py-lineno">839</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt>
<a name="RESTBase.get"></a><div id="RESTBase.get-def"><a name="L840"></a><tt class="py-lineno">840</tt> <a class="py-toggle" href="#" id="RESTBase.get-toggle" onclick="return toggle('RESTBase.get');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#get">get</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">scope</tt><tt class="py-op">,</tt> <tt class="py-param">id</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.get-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.get-expanded"><a name="L841"></a><tt class="py-lineno">841</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L842"></a><tt class="py-lineno">842</tt> <tt class="py-line"><tt class="py-docstring"> Fetch a resource by id.</tt> </tt>
<a name="L843"></a><tt class="py-lineno">843</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L844"></a><tt class="py-lineno">844</tt> <tt class="py-line"><tt class="py-docstring"> Simply pass a known id as argument. For example</tt> </tt>
<a name="L845"></a><tt class="py-lineno">845</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L846"></a><tt class="py-lineno">846</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; sca = scapi.Scope(connector)</tt> </tt>
<a name="L847"></a><tt class="py-lineno">847</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; track = sca.Track.get(id)</tt> </tt>
<a name="L848"></a><tt class="py-lineno">848</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L849"></a><tt class="py-lineno">849</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L850"></a><tt class="py-lineno">850</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">getattr</tt><tt class="py-op">(</tt><tt class="py-name">scope</tt><tt class="py-op">,</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-125', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt class="py-name">id</tt><tt class="py-op">)</tt> </tt>
</div><a name="L851"></a><tt class="py-lineno">851</tt> <tt class="py-line"> </tt>
<a name="L852"></a><tt class="py-lineno">852</tt> <tt class="py-line"> </tt>
<a name="RESTBase._scope"></a><div id="RESTBase._scope-def"><a name="L853"></a><tt class="py-lineno">853</tt> <a class="py-toggle" href="#" id="RESTBase._scope-toggle" onclick="return toggle('RESTBase._scope');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#_scope">_scope</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase._scope-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase._scope-expanded"><a name="L854"></a><tt class="py-lineno">854</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L855"></a><tt class="py-lineno">855</tt> <tt class="py-line"><tt class="py-docstring"> Return the scope this resource lives in, which is the KIND and id</tt> </tt>
<a name="L856"></a><tt class="py-lineno">856</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L857"></a><tt class="py-lineno">857</tt> <tt class="py-line"><tt class="py-docstring"> @return: "&lt;KIND&gt;/&lt;id&gt;"</tt> </tt>
<a name="L858"></a><tt class="py-lineno">858</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L859"></a><tt class="py-lineno">859</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">"%s/%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-126', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L860"></a><tt class="py-lineno">860</tt> <tt class="py-line"> </tt>
<a name="L861"></a><tt class="py-lineno">861</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt>
<a name="RESTBase._singleton"></a><div id="RESTBase._singleton-def"><a name="L862"></a><tt class="py-lineno">862</tt> <a class="py-toggle" href="#" id="RESTBase._singleton-toggle" onclick="return toggle('RESTBase._singleton');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#_singleton">_singleton</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase._singleton-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase._singleton-expanded"><a name="L863"></a><tt class="py-lineno">863</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L864"></a><tt class="py-lineno">864</tt> <tt class="py-line"><tt class="py-docstring"> This method will take a resource name like "users" and</tt> </tt>
<a name="L865"></a><tt class="py-lineno">865</tt> <tt class="py-line"><tt class="py-docstring"> return the single-case, in the example "user".</tt> </tt>
<a name="L866"></a><tt class="py-lineno">866</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L867"></a><tt class="py-lineno">867</tt> <tt class="py-line"><tt class="py-docstring"> Currently, it's not very sophisticated, only strips a trailing s.</tt> </tt>
<a name="L868"></a><tt class="py-lineno">868</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L869"></a><tt class="py-lineno">869</tt> <tt class="py-line"> <tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-127', 'KIND', 'link-93');">KIND</a></tt> </tt>
<a name="L870"></a><tt class="py-lineno">870</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">name</tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-op">==</tt> <tt class="py-string">'s'</tt><tt class="py-op">:</tt> </tt>
<a name="L871"></a><tt class="py-lineno">871</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">name</tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>
<a name="L872"></a><tt class="py-lineno">872</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Can't make %s to a singleton"</tt> <tt class="py-op">%</tt> <tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L873"></a><tt class="py-lineno">873</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__repr__"></a><div id="RESTBase.__repr__-def"><a name="L874"></a><tt class="py-lineno">874</tt> <a class="py-toggle" href="#" id="RESTBase.__repr__-toggle" onclick="return toggle('RESTBase.__repr__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__repr__">__repr__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__repr__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__repr__-expanded"><a name="L875"></a><tt class="py-lineno">875</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L876"></a><tt class="py-lineno">876</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"\n\n******\n%s:"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
<a name="L877"></a><tt class="py-lineno">877</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">""</tt><tt class="py-op">)</tt> </tt>
<a name="L878"></a><tt class="py-lineno">878</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__data</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L879"></a><tt class="py-lineno">879</tt> <tt class="py-line"> <tt class="py-name">key</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt>
<a name="L880"></a><tt class="py-lineno">880</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">,</tt> <tt class="py-name">unicode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L881"></a><tt class="py-lineno">881</tt> <tt class="py-line"> <tt class="py-name">v</tt> <tt class="py-op">=</tt> <tt class="py-name">v</tt><tt class="py-op">.</tt><tt class="py-name">encode</tt><tt class="py-op">(</tt><tt class="py-string">'utf-8'</tt><tt class="py-op">)</tt> </tt>
<a name="L882"></a><tt class="py-lineno">882</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L883"></a><tt class="py-lineno">883</tt> <tt class="py-line"> <tt class="py-name">v</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt> </tt>
<a name="L884"></a><tt class="py-lineno">884</tt> <tt class="py-line"> <tt class="py-name">res</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-string">"%s=%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L885"></a><tt class="py-lineno">885</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">"\n"</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">res</tt><tt class="py-op">)</tt> </tt>
</div><a name="L886"></a><tt class="py-lineno">886</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__hash__"></a><div id="RESTBase.__hash__-def"><a name="L887"></a><tt class="py-lineno">887</tt> <a class="py-toggle" href="#" id="RESTBase.__hash__-toggle" onclick="return toggle('RESTBase.__hash__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__hash__">__hash__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__hash__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__hash__-expanded"><a name="L888"></a><tt class="py-lineno">888</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">hash</tt><tt class="py-op">(</tt><tt class="py-string">"%s%i"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-128', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L889"></a><tt class="py-lineno">889</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__eq__"></a><div id="RESTBase.__eq__-def"><a name="L890"></a><tt class="py-lineno">890</tt> <a class="py-toggle" href="#" id="RESTBase.__eq__-toggle" onclick="return toggle('RESTBase.__eq__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__eq__">__eq__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__eq__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__eq__-expanded"><a name="L891"></a><tt class="py-lineno">891</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L892"></a><tt class="py-lineno">892</tt> <tt class="py-line"><tt class="py-docstring"> Test for equality. </tt> </tt>
<a name="L893"></a><tt class="py-lineno">893</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L894"></a><tt class="py-lineno">894</tt> <tt class="py-line"><tt class="py-docstring"> Resources are considered equal if the have the same kind and id.</tt> </tt>
<a name="L895"></a><tt class="py-lineno">895</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L896"></a><tt class="py-lineno">896</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">other</tt><tt class="py-op">,</tt> <tt id="link-129" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-129', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L897"></a><tt class="py-lineno">897</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
<a name="L898"></a><tt class="py-lineno">898</tt> <tt class="py-line"> <tt class="py-name">res</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-130', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">==</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-131', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">id</tt> <tt class="py-op">==</tt> <tt class="py-name">other</tt><tt class="py-op">.</tt><tt class="py-name">id</tt> </tt>
<a name="L899"></a><tt class="py-lineno">899</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">res</tt> </tt>
</div><a name="L900"></a><tt class="py-lineno">900</tt> <tt class="py-line"> </tt>
<a name="RESTBase.__ne__"></a><div id="RESTBase.__ne__-def"><a name="L901"></a><tt class="py-lineno">901</tt> <a class="py-toggle" href="#" id="RESTBase.__ne__-toggle" onclick="return toggle('RESTBase.__ne__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi.RESTBase-class.html#__ne__">__ne__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">other</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="RESTBase.__ne__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="RESTBase.__ne__-expanded"><a name="L902"></a><tt class="py-lineno">902</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt> <tt class="py-op">==</tt> <tt class="py-name">other</tt> </tt>
</div></div><a name="L903"></a><tt class="py-lineno">903</tt> <tt class="py-line"> </tt>
<a name="User"></a><div id="User-def"><a name="L904"></a><tt class="py-lineno">904</tt> <a class="py-toggle" href="#" id="User-toggle" onclick="return toggle('User');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.User-class.html">User</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="User-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="User-expanded"><a name="L905"></a><tt class="py-lineno">905</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L906"></a><tt class="py-lineno">906</tt> <tt class="py-line"><tt class="py-docstring"> A user domain object/resource. </tt> </tt>
<a name="L907"></a><tt class="py-lineno">907</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L908"></a><tt class="py-lineno">908</tt> <tt class="py-line"> <tt id="link-132" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-132', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'users'</tt> </tt>
<a name="L909"></a><tt class="py-lineno">909</tt> <tt class="py-line"> <tt id="link-133" class="py-name"><a title="scapi.RESTBase.ALIASES
scapi.Track.ALIASES
scapi.User.ALIASES" class="py-name" href="#" onclick="return doclink('link-133', 'ALIASES', 'link-99');">ALIASES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'me'</tt><tt class="py-op">,</tt> <tt class="py-string">'permissions'</tt><tt class="py-op">,</tt> <tt class="py-string">'contacts'</tt><tt class="py-op">,</tt> <tt class="py-string">'user'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L910"></a><tt class="py-lineno">910</tt> <tt class="py-line"> </tt>
<a name="Track"></a><div id="Track-def"><a name="L911"></a><tt class="py-lineno">911</tt> <a class="py-toggle" href="#" id="Track-toggle" onclick="return toggle('Track');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Track-class.html">Track</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Track-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Track-expanded"><a name="L912"></a><tt class="py-lineno">912</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L913"></a><tt class="py-lineno">913</tt> <tt class="py-line"><tt class="py-docstring"> A track domain object/resource. </tt> </tt>
<a name="L914"></a><tt class="py-lineno">914</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L915"></a><tt class="py-lineno">915</tt> <tt class="py-line"> <tt id="link-134" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-134', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'tracks'</tt> </tt>
<a name="L916"></a><tt class="py-lineno">916</tt> <tt class="py-line"> <tt id="link-135" class="py-name"><a title="scapi.RESTBase.ALIASES
scapi.Track.ALIASES
scapi.User.ALIASES" class="py-name" href="#" onclick="return doclink('link-135', 'ALIASES', 'link-99');">ALIASES</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'favorites'</tt><tt class="py-op">]</tt> </tt>
</div><a name="L917"></a><tt class="py-lineno">917</tt> <tt class="py-line"> </tt>
<a name="Comment"></a><div id="Comment-def"><a name="L918"></a><tt class="py-lineno">918</tt> <a class="py-toggle" href="#" id="Comment-toggle" onclick="return toggle('Comment');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Comment-class.html">Comment</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Comment-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Comment-expanded"><a name="L919"></a><tt class="py-lineno">919</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L920"></a><tt class="py-lineno">920</tt> <tt class="py-line"><tt class="py-docstring"> A comment domain object/resource. </tt> </tt>
<a name="L921"></a><tt class="py-lineno">921</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L922"></a><tt class="py-lineno">922</tt> <tt class="py-line"> <tt id="link-136" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-136', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'comments'</tt> </tt>
</div><a name="L923"></a><tt class="py-lineno">923</tt> <tt class="py-line"> </tt>
<a name="Event"></a><div id="Event-def"><a name="L924"></a><tt class="py-lineno">924</tt> <a class="py-toggle" href="#" id="Event-toggle" onclick="return toggle('Event');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Event-class.html">Event</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Event-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Event-expanded"><a name="L925"></a><tt class="py-lineno">925</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L926"></a><tt class="py-lineno">926</tt> <tt class="py-line"><tt class="py-docstring"> A event domain object/resource. </tt> </tt>
<a name="L927"></a><tt class="py-lineno">927</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L928"></a><tt class="py-lineno">928</tt> <tt class="py-line"> <tt id="link-137" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-137', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'events'</tt> </tt>
</div><a name="L929"></a><tt class="py-lineno">929</tt> <tt class="py-line"> </tt>
<a name="Playlist"></a><div id="Playlist-def"><a name="L930"></a><tt class="py-lineno">930</tt> <a class="py-toggle" href="#" id="Playlist-toggle" onclick="return toggle('Playlist');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Playlist-class.html">Playlist</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Playlist-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Playlist-expanded"><a name="L931"></a><tt class="py-lineno">931</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L932"></a><tt class="py-lineno">932</tt> <tt class="py-line"><tt class="py-docstring"> A playlist/set domain object/resource</tt> </tt>
<a name="L933"></a><tt class="py-lineno">933</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L934"></a><tt class="py-lineno">934</tt> <tt class="py-line"> <tt id="link-138" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-138', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'playlists'</tt> </tt>
</div><a name="L935"></a><tt class="py-lineno">935</tt> <tt class="py-line"> </tt>
<a name="Group"></a><div id="Group-def"><a name="L936"></a><tt class="py-lineno">936</tt> <a class="py-toggle" href="#" id="Group-toggle" onclick="return toggle('Group');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="scapi.Group-class.html">Group</a><tt class="py-op">(</tt><tt class="py-base-class">RESTBase</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Group-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Group-expanded"><a name="L937"></a><tt class="py-lineno">937</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L938"></a><tt class="py-lineno">938</tt> <tt class="py-line"><tt class="py-docstring"> A group domain object/resource</tt> </tt>
<a name="L939"></a><tt class="py-lineno">939</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L940"></a><tt class="py-lineno">940</tt> <tt class="py-line"> <tt id="link-139" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-139', 'KIND', 'link-93');">KIND</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'groups'</tt> </tt>
</div><a name="L941"></a><tt class="py-lineno">941</tt> <tt class="py-line"> </tt>
<a name="register_classes"></a><div id="register_classes-def"><a name="L942"></a><tt class="py-lineno">942</tt> <tt class="py-line"> </tt>
<a name="L943"></a><tt class="py-lineno">943</tt> <tt class="py-line"> </tt>
<a name="L944"></a><tt class="py-lineno">944</tt> <tt class="py-line"><tt class="py-comment"># this registers all the RESTBase subclasses.</tt> </tt>
<a name="L945"></a><tt class="py-lineno">945</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># One day using a metaclass will make this a tad</tt> </tt>
<a name="L946"></a><tt class="py-lineno">946</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># less ugly.</tt> </tt>
<a name="L947"></a><tt class="py-lineno">947</tt> <a class="py-toggle" href="#" id="register_classes-toggle" onclick="return toggle('register_classes');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="scapi-module.html#register_classes">register_classes</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register_classes-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="register_classes-expanded"><a name="L948"></a><tt class="py-lineno">948</tt> <tt class="py-line"> <tt class="py-name">g</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L949"></a><tt class="py-lineno">949</tt> <tt class="py-line"> <tt class="py-name">g</tt><tt class="py-op">.</tt><tt class="py-name">update</tt><tt class="py-op">(</tt><tt class="py-name">globals</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L950"></a><tt class="py-lineno">950</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">cls</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-op">(</tt><tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">k</tt><tt class="py-op">,</tt> <tt class="py-name">v</tt> <tt class="py-keyword">in</tt> <tt class="py-name">g</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">if</tt> <tt class="py-name">isclass</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-name">issubclass</tt><tt class="py-op">(</tt><tt class="py-name">v</tt><tt class="py-op">,</tt> <tt id="link-140" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-140', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">v</tt> <tt class="py-op">==</tt> <tt id="link-141" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-141', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L951"></a><tt class="py-lineno">951</tt> <tt class="py-line"> <tt id="link-142" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-142', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-143', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="scapi.Comment.KIND
scapi.Event.KIND
scapi.Group.KIND
scapi.Playlist.KIND
scapi.RESTBase.KIND
scapi.Track.KIND
scapi.User.KIND" class="py-name" href="#" onclick="return doclink('link-144', 'KIND', 'link-93');">KIND</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt> </tt>
<a name="L952"></a><tt class="py-lineno">952</tt> <tt class="py-line"> <tt id="link-145" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-145', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="scapi.RESTBase.ALL_DOMAIN_CLASSES" class="py-name" href="#" onclick="return doclink('link-146', 'ALL_DOMAIN_CLASSES', 'link-86');">ALL_DOMAIN_CLASSES</a></tt><tt class="py-op">[</tt><tt class="py-name">cls</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt> </tt>
<a name="L953"></a><tt class="py-lineno">953</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">alias</tt> <tt class="py-keyword">in</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="scapi.RESTBase.ALIASES
scapi.Track.ALIASES
scapi.User.ALIASES" class="py-name" href="#" onclick="return doclink('link-147', 'ALIASES', 'link-99');">ALIASES</a></tt><tt class="py-op">:</tt> </tt>
<a name="L954"></a><tt class="py-lineno">954</tt> <tt class="py-line"> <tt id="link-148" class="py-name"><a title="scapi.RESTBase" class="py-name" href="#" onclick="return doclink('link-148', 'RESTBase', 'link-71');">RESTBase</a></tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="scapi.RESTBase.REGISTRY" class="py-name" href="#" onclick="return doclink('link-149', 'REGISTRY', 'link-72');">REGISTRY</a></tt><tt class="py-op">[</tt><tt class="py-name">alias</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt> </tt>
<a name="L955"></a><tt class="py-lineno">955</tt> <tt class="py-line"> <tt class="py-name">__all__</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
</div><a name="L956"></a><tt class="py-lineno">956</tt> <tt class="py-line"><tt id="link-150" class="py-name" targets="Function scapi.register_classes()=scapi-module.html#register_classes"><a title="scapi.register_classes" class="py-name" href="#" onclick="return doclink('link-150', 'register_classes', 'link-150');">register_classes</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L957"></a><tt class="py-lineno">957</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&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"
>SoundCloud API</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 Thu Sep 10 00:58:50 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>
Reference in New Issue View Git Blame Copy Permalink