| <?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>googleapiclient._helpers</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> <a |
| href="googleapiclient-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="googleapiclient-module.html">Package googleapiclient</a> :: |
| Module _helpers |
| </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 private</a>]</span></td></tr> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="googleapiclient._helpers-pysrc.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <h1 class="epydoc">Source Code for <a href="googleapiclient._helpers-module.html">Module googleapiclient._helpers</a></h1> |
| <pre class="py-src"> |
| <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright 2015 Google Inc. All rights reserved.</tt> </tt> |
| <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt> |
| <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt> |
| <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt> |
| <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># http://www.apache.org/licenses/LICENSE-2.0</tt> </tt> |
| <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt> |
| <a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt> |
| <a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt> |
| <a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt> |
| <a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt> |
| <a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt> |
| <a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">"""Helper functions for commonly used utilities."""</tt> </tt> |
| <a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"> </tt> |
| <a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">functools</tt> </tt> |
| <a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">inspect</tt> </tt> |
| <a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt> |
| <a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">warnings</tt> </tt> |
| <a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </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">six</tt> </tt> |
| <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">moves</tt> <tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt> |
| <a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> </tt> |
| <a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt> |
| <a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable googleapiclient._helpers.logger=googleapiclient._helpers-module.html#logger,Variable googleapiclient.discovery.logger=googleapiclient.discovery-module.html#logger"><a title="googleapiclient._helpers.logger |
| googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-0', 'logger', 'link-0');">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="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> </tt> |
| <a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt id="link-1" class="py-name" targets="Variable googleapiclient._helpers.POSITIONAL_WARNING=googleapiclient._helpers-module.html#POSITIONAL_WARNING"><a title="googleapiclient._helpers.POSITIONAL_WARNING" class="py-name" href="#" onclick="return doclink('link-1', 'POSITIONAL_WARNING', 'link-1');">POSITIONAL_WARNING</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'WARNING'</tt> </tt> |
| <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt id="link-2" class="py-name" targets="Variable googleapiclient._helpers.POSITIONAL_EXCEPTION=googleapiclient._helpers-module.html#POSITIONAL_EXCEPTION"><a title="googleapiclient._helpers.POSITIONAL_EXCEPTION" class="py-name" href="#" onclick="return doclink('link-2', 'POSITIONAL_EXCEPTION', 'link-2');">POSITIONAL_EXCEPTION</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'EXCEPTION'</tt> </tt> |
| <a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable googleapiclient._helpers.POSITIONAL_IGNORE=googleapiclient._helpers-module.html#POSITIONAL_IGNORE"><a title="googleapiclient._helpers.POSITIONAL_IGNORE" class="py-name" href="#" onclick="return doclink('link-3', 'POSITIONAL_IGNORE', 'link-3');">POSITIONAL_IGNORE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'IGNORE'</tt> </tt> |
| <a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable googleapiclient._helpers.POSITIONAL_SET=googleapiclient._helpers-module.html#POSITIONAL_SET"><a title="googleapiclient._helpers.POSITIONAL_SET" class="py-name" href="#" onclick="return doclink('link-4', 'POSITIONAL_SET', 'link-4');">POSITIONAL_SET</a></tt> <tt class="py-op">=</tt> <tt class="py-name">frozenset</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-5" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_WARNING" class="py-name" href="#" onclick="return doclink('link-5', 'POSITIONAL_WARNING', 'link-1');">POSITIONAL_WARNING</a></tt><tt class="py-op">,</tt> <tt id="link-6" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_EXCEPTION" class="py-name" href="#" onclick="return doclink('link-6', 'POSITIONAL_EXCEPTION', 'link-2');">POSITIONAL_EXCEPTION</a></tt><tt class="py-op">,</tt> </tt> |
| <a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt id="link-7" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_IGNORE" class="py-name" href="#" onclick="return doclink('link-7', 'POSITIONAL_IGNORE', 'link-3');">POSITIONAL_IGNORE</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| <a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> </tt> |
| <a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt id="link-8" class="py-name" targets="Variable googleapiclient._helpers.positional_parameters_enforcement=googleapiclient._helpers-module.html#positional_parameters_enforcement"><a title="googleapiclient._helpers.positional_parameters_enforcement" class="py-name" href="#" onclick="return doclink('link-8', 'positional_parameters_enforcement', 'link-8');">positional_parameters_enforcement</a></tt> <tt class="py-op">=</tt> <tt id="link-9" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_WARNING" class="py-name" href="#" onclick="return doclink('link-9', 'POSITIONAL_WARNING', 'link-1');">POSITIONAL_WARNING</a></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 id="link-10" class="py-name" targets="Variable googleapiclient._helpers._SYM_LINK_MESSAGE=googleapiclient._helpers-module.html#_SYM_LINK_MESSAGE"><a title="googleapiclient._helpers._SYM_LINK_MESSAGE" class="py-name" href="#" onclick="return doclink('link-10', '_SYM_LINK_MESSAGE', 'link-10');">_SYM_LINK_MESSAGE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'File: {0}: Is a symbolic link.'</tt> </tt> |
| <a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable googleapiclient._helpers._IS_DIR_MESSAGE=googleapiclient._helpers-module.html#_IS_DIR_MESSAGE"><a title="googleapiclient._helpers._IS_DIR_MESSAGE" class="py-name" href="#" onclick="return doclink('link-11', '_IS_DIR_MESSAGE', 'link-11');">_IS_DIR_MESSAGE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'{0}: Is a directory'</tt> </tt> |
| <a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable googleapiclient._helpers._MISSING_FILE_MESSAGE=googleapiclient._helpers-module.html#_MISSING_FILE_MESSAGE"><a title="googleapiclient._helpers._MISSING_FILE_MESSAGE" class="py-name" href="#" onclick="return doclink('link-12', '_MISSING_FILE_MESSAGE', 'link-12');">_MISSING_FILE_MESSAGE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'Cannot access {0}: No such file or directory'</tt> </tt> |
| <a name="positional"></a><div id="positional-def"><a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> </tt> |
| <a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> </tt> |
| <a name="L41"></a><tt class="py-lineno"> 41</tt> <a class="py-toggle" href="#" id="positional-toggle" onclick="return toggle('positional');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._helpers-module.html#positional">positional</a><tt class="py-op">(</tt><tt class="py-param">max_positional_args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="positional-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="positional-expanded"><a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-docstring">"""A decorator to declare that only the first N arguments my be positional.</tt> </tt> |
| <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> This decorator makes it easy to support Python 3 style keyword-only</tt> </tt> |
| <a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> parameters. For example, in Python 3 it is possible to write::</tt> </tt> |
| <a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> def fn(pos1, *, kwonly1=None, kwonly1=None):</tt> </tt> |
| <a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> ...</tt> </tt> |
| <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> All named parameters after ``*`` must be a keyword::</tt> </tt> |
| <a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> fn(10, 'kw1', 'kw2') # Raises exception.</tt> </tt> |
| <a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> fn(10, kwonly1='kw1') # Ok.</tt> </tt> |
| <a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> Example</tt> </tt> |
| <a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> ^^^^^^^</tt> </tt> |
| <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> To define a function like above, do::</tt> </tt> |
| <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> @positional(1)</tt> </tt> |
| <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> def fn(pos1, kwonly1=None, kwonly2=None):</tt> </tt> |
| <a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> ...</tt> </tt> |
| <a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> If no default value is provided to a keyword argument, it becomes a</tt> </tt> |
| <a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> required keyword argument::</tt> </tt> |
| <a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> @positional(0)</tt> </tt> |
| <a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> def fn(required_kw):</tt> </tt> |
| <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> ...</tt> </tt> |
| <a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> This must be called with the keyword parameter::</tt> </tt> |
| <a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> fn() # Raises exception.</tt> </tt> |
| <a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> fn(10) # Raises exception.</tt> </tt> |
| <a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> fn(required_kw=10) # Ok.</tt> </tt> |
| <a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> When defining instance or class methods always remember to account for</tt> </tt> |
| <a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> ``self`` and ``cls``::</tt> </tt> |
| <a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> class MyClass(object):</tt> </tt> |
| <a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> @positional(2)</tt> </tt> |
| <a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> def my_method(self, pos1, kwonly1=None):</tt> </tt> |
| <a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> ...</tt> </tt> |
| <a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> @classmethod</tt> </tt> |
| <a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> @positional(2)</tt> </tt> |
| <a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> def my_method(cls, pos1, kwonly1=None):</tt> </tt> |
| <a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> ...</tt> </tt> |
| <a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> The positional decorator behavior is controlled by</tt> </tt> |
| <a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> ``_helpers.positional_parameters_enforcement``, which may be set to</tt> </tt> |
| <a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> ``POSITIONAL_EXCEPTION``, ``POSITIONAL_WARNING`` or</tt> </tt> |
| <a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> ``POSITIONAL_IGNORE`` to raise an exception, log a warning, or do</tt> </tt> |
| <a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> nothing, respectively, if a declaration is violated.</tt> </tt> |
| <a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> max_positional_arguments: Maximum number of positional arguments. All</tt> </tt> |
| <a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> parameters after the this index must be</tt> </tt> |
| <a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> keyword only.</tt> </tt> |
| <a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> A decorator that prevents using arguments after max_positional_args</tt> </tt> |
| <a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> from being used as positional parameters.</tt> </tt> |
| <a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| <a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> TypeError: if a key-word only argument is provided as a positional</tt> </tt> |
| <a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> parameter, but only if</tt> </tt> |
| <a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> _helpers.positional_parameters_enforcement is set to</tt> </tt> |
| <a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> POSITIONAL_EXCEPTION.</tt> </tt> |
| <a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> </tt> |
| <a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">positional_decorator</tt><tt class="py-op">(</tt><tt class="py-param">wrapped</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| <a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">functools</tt><tt class="py-op">.</tt><tt class="py-name">wraps</tt><tt class="py-op">(</tt><tt class="py-name">wrapped</tt><tt class="py-op">)</tt> </tt> |
| <a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">positional_wrapper</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="L116"></a><tt class="py-lineno">116</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">args</tt><tt class="py-op">)</tt> <tt class="py-op">></tt> <tt class="py-name">max_positional_args</tt><tt class="py-op">:</tt> </tt> |
| <a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-name">plural_s</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt> |
| <a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">max_positional_args</tt> <tt class="py-op">!=</tt> <tt class="py-number">1</tt><tt class="py-op">:</tt> </tt> |
| <a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> <tt class="py-name">plural_s</tt> <tt class="py-op">=</tt> <tt class="py-string">'s'</tt> </tt> |
| <a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-name">message</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'{function}() takes at most {args_max} positional '</tt> </tt> |
| <a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-string">'argument{plural} ({args_given} given)'</tt><tt class="py-op">.</tt><tt class="py-name">format</tt><tt class="py-op">(</tt> </tt> |
| <a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-name">function</tt><tt class="py-op">=</tt><tt class="py-name">wrapped</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">,</tt> </tt> |
| <a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-name">args_max</tt><tt class="py-op">=</tt><tt class="py-name">max_positional_args</tt><tt class="py-op">,</tt> </tt> |
| <a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">args_given</tt><tt class="py-op">=</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt> |
| <a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-name">plural</tt><tt class="py-op">=</tt><tt class="py-name">plural_s</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| <a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name"><a title="googleapiclient._helpers.positional_parameters_enforcement" class="py-name" href="#" onclick="return doclink('link-13', 'positional_parameters_enforcement', 'link-8');">positional_parameters_enforcement</a></tt> <tt class="py-op">==</tt> <tt id="link-14" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_EXCEPTION" class="py-name" href="#" onclick="return doclink('link-14', 'POSITIONAL_EXCEPTION', 'link-2');">POSITIONAL_EXCEPTION</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">)</tt> </tt> |
| <a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-15" class="py-name"><a title="googleapiclient._helpers.positional_parameters_enforcement" class="py-name" href="#" onclick="return doclink('link-15', 'positional_parameters_enforcement', 'link-8');">positional_parameters_enforcement</a></tt> <tt class="py-op">==</tt> <tt id="link-16" class="py-name"><a title="googleapiclient._helpers.POSITIONAL_WARNING" class="py-name" href="#" onclick="return doclink('link-16', 'POSITIONAL_WARNING', 'link-1');">POSITIONAL_WARNING</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt id="link-17" class="py-name"><a title="googleapiclient._helpers.logger |
| googleapiclient.discovery.logger" class="py-name" href="#" onclick="return doclink('link-17', 'logger', 'link-0');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warning</tt><tt class="py-op">(</tt><tt class="py-name">message</tt><tt class="py-op">)</tt> </tt> |
| <a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">wrapped</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="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">positional_wrapper</tt> </tt> |
| </div><a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> </tt> |
| <a name="L133"></a><tt class="py-lineno">133</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">max_positional_args</tt><tt class="py-op">,</tt> <tt class="py-name">six</tt><tt class="py-op">.</tt><tt class="py-name">integer_types</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| <a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">positional_decorator</tt> </tt> |
| <a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-keyword">else</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">args</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">defaults</tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">getargspec</tt><tt class="py-op">(</tt><tt class="py-name">max_positional_args</tt><tt class="py-op">)</tt> </tt> |
| <a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-18" class="py-name" targets="Function googleapiclient._helpers.positional()=googleapiclient._helpers-module.html#positional"><a title="googleapiclient._helpers.positional" class="py-name" href="#" onclick="return doclink('link-18', 'positional', 'link-18');">positional</a></tt><tt class="py-op">(</tt><tt class="py-name">len</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">len</tt><tt class="py-op">(</tt><tt class="py-name">defaults</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">(</tt><tt class="py-name">max_positional_args</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> </tt> |
| <a name="parse_unique_urlencoded"></a><div id="parse_unique_urlencoded-def"><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> </tt> |
| <a name="L140"></a><tt class="py-lineno">140</tt> <a class="py-toggle" href="#" id="parse_unique_urlencoded-toggle" onclick="return toggle('parse_unique_urlencoded');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._helpers-module.html#parse_unique_urlencoded">parse_unique_urlencoded</a><tt class="py-op">(</tt><tt class="py-param">content</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="parse_unique_urlencoded-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="parse_unique_urlencoded-expanded"><a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-docstring">"""Parses unique key-value parameters from urlencoded content.</tt> </tt> |
| <a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"><tt class="py-docstring"> content: string, URL-encoded key-value pairs.</tt> </tt> |
| <a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"><tt class="py-docstring"> dict, The key-value pairs from ``content``.</tt> </tt> |
| <a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| <a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> ValueError: if one of the keys is repeated.</tt> </tt> |
| <a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-name">urlencoded_params</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">parse</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> |
| <a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-name">params</tt> <tt class="py-op">=</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">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">six</tt><tt class="py-op">.</tt><tt class="py-name">iteritems</tt><tt class="py-op">(</tt><tt class="py-name">urlencoded_params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| <a name="L155"></a><tt class="py-lineno">155</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">value</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="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-string">'URL-encoded content contains a repeated value:'</tt> </tt> |
| <a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> <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-string">', '</tt><tt class="py-op">.</tt><tt class="py-name">join</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-op">)</tt> </tt> |
| <a name="L158"></a><tt class="py-lineno">158</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-name">msg</tt><tt class="py-op">)</tt> </tt> |
| <a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> <tt class="py-name">params</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 class="py-number">0</tt><tt class="py-op">]</tt> </tt> |
| <a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">params</tt> </tt> |
| </div><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> </tt> |
| <a name="update_query_params"></a><div id="update_query_params-def"><a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> </tt> |
| <a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="update_query_params-toggle" onclick="return toggle('update_query_params');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._helpers-module.html#update_query_params">update_query_params</a><tt class="py-op">(</tt><tt class="py-param">uri</tt><tt class="py-op">,</tt> <tt class="py-param">params</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="update_query_params-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="update_query_params-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-docstring">"""Updates a URI with new query parameters.</tt> </tt> |
| <a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> If a given key from ``params`` is repeated in the ``uri``, then</tt> </tt> |
| <a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> the URI will be considered invalid and an error will occur.</tt> </tt> |
| <a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"> If the URI is valid, then each value from ``params`` will</tt> </tt> |
| <a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> replace the corresponding value in the query parameters (if</tt> </tt> |
| <a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> it exists).</tt> </tt> |
| <a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> uri: string, A valid URI, with potential existing query parameters.</tt> </tt> |
| <a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> params: dict, A dictionary of query parameters.</tt> </tt> |
| <a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> The same URI but with the new query parameters added.</tt> </tt> |
| <a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-name">parts</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">parse</tt><tt class="py-op">.</tt><tt class="py-name">urlparse</tt><tt class="py-op">(</tt><tt class="py-name">uri</tt><tt class="py-op">)</tt> </tt> |
| <a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">query_params</tt> <tt class="py-op">=</tt> <tt id="link-19" class="py-name" targets="Function googleapiclient._helpers.parse_unique_urlencoded()=googleapiclient._helpers-module.html#parse_unique_urlencoded"><a title="googleapiclient._helpers.parse_unique_urlencoded" class="py-name" href="#" onclick="return doclink('link-19', 'parse_unique_urlencoded', 'link-19');">parse_unique_urlencoded</a></tt><tt class="py-op">(</tt><tt class="py-name">parts</tt><tt class="py-op">.</tt><tt class="py-name">query</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">query_params</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Method googleapiclient.channel.Channel.update()=googleapiclient.channel.Channel-class.html#update"><a title="googleapiclient.channel.Channel.update" class="py-name" href="#" onclick="return doclink('link-20', 'update', 'link-20');">update</a></tt><tt class="py-op">(</tt><tt class="py-name">params</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">new_query</tt> <tt class="py-op">=</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">parse</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">query_params</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">new_parts</tt> <tt class="py-op">=</tt> <tt class="py-name">parts</tt><tt class="py-op">.</tt><tt class="py-name">_replace</tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">=</tt><tt class="py-name">new_query</tt><tt class="py-op">)</tt> </tt> |
| <a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">parse</tt><tt class="py-op">.</tt><tt class="py-name">urlunparse</tt><tt class="py-op">(</tt><tt class="py-name">new_parts</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> </tt> |
| <a name="_add_query_parameter"></a><div id="_add_query_parameter-def"><a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> </tt> |
| <a name="L188"></a><tt class="py-lineno">188</tt> <a class="py-toggle" href="#" id="_add_query_parameter-toggle" onclick="return toggle('_add_query_parameter');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._helpers-module.html#_add_query_parameter">_add_query_parameter</a><tt class="py-op">(</tt><tt class="py-param">url</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="_add_query_parameter-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_add_query_parameter-expanded"><a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-docstring">"""Adds a query parameter to a url.</tt> </tt> |
| <a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"> Replaces the current value if it already exists in the URL.</tt> </tt> |
| <a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"><tt class="py-docstring"> url: string, url to add the query parameter to.</tt> </tt> |
| <a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"><tt class="py-docstring"> name: string, query parameter name.</tt> </tt> |
| <a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"><tt class="py-docstring"> value: string, query parameter value.</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"> Returns:</tt> </tt> |
| <a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"><tt class="py-docstring"> Updated query parameter. Does not update the url if value is None.</tt> </tt> |
| <a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| <a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">url</tt> </tt> |
| <a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| <a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-21" class="py-name" targets="Function googleapiclient._helpers.update_query_params()=googleapiclient._helpers-module.html#update_query_params"><a title="googleapiclient._helpers.update_query_params" class="py-name" href="#" onclick="return doclink('link-21', 'update_query_params', 'link-21');">update_query_params</a></tt><tt class="py-op">(</tt><tt class="py-name">url</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-op">)</tt> </tt> |
| </div><a name="L205"></a><tt class="py-lineno">205</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> <a |
| href="googleapiclient-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></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 Fri Jun 14 15:57:29 2019 |
| </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> |
