1<?xml version="1.0" encoding="ascii"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 3 "DTD/xhtml1-transitional.dtd"> 4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 5<head> 6 <title>googleapiclient._auth</title> 7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> 8 <script type="text/javascript" src="epydoc.js"></script> 9</head> 10 11<body bgcolor="white" text="black" link="blue" vlink="#204080" 12 alink="#204080"> 13<!-- ==================== NAVIGATION BAR ==================== --> 14<table class="navbar" border="0" width="100%" cellpadding="0" 15 bgcolor="#a0c0ff" cellspacing="0"> 16 <tr valign="middle"> 17 <!-- Home link --> 18 <th> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </th> 32 33 <th class="navbar" width="100%"></th> 34 </tr> 35</table> 36<table width="100%" cellpadding="0" cellspacing="0"> 37 <tr valign="top"> 38 <td width="100%"> 39 <span class="breadcrumbs"> 40 <a href="googleapiclient-module.html">Package googleapiclient</a> :: 41 Module _auth 42 </span> 43 </td> 44 <td> 45 <table cellpadding="0" cellspacing="0"> 46 <!-- hide/show private --> 47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 48 onclick="toggle_private();">hide private</a>]</span></td></tr> 49 <tr><td align="right"><span class="options" 50 >[<a href="frames.html" target="_top">frames</a 51 >] | <a href="googleapiclient._auth-pysrc.html" 52 target="_top">no frames</a>]</span></td></tr> 53 </table> 54 </td> 55 </tr> 56</table> 57<h1 class="epydoc">Source Code for <a href="googleapiclient._auth-module.html">Module googleapiclient._auth</a></h1> 58<pre class="py-src"> 59<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright 2016 Google Inc. All Rights Reserved.</tt> </tt> 60<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 61<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> 62<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> 63<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> 64<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 65<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> 66<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> 67<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> 68<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> 69<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> 70<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> 71<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt> 72<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt> 73<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">"""Helpers for authentication using oauth2client or google-auth."""</tt> </tt> 74<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"> </tt> 75<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">httplib2</tt> </tt> 76<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"> </tt> 77<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> 78<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt> </tt> 79<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt> </tt> 80<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"> <tt id="link-0" class="py-name" targets="Variable googleapiclient._auth.HAS_GOOGLE_AUTH=googleapiclient._auth-module.html#HAS_GOOGLE_AUTH"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-0', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> 81<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> <tt class="py-comment"># pragma: NO COVER</tt> </tt> 82<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> <tt id="link-1" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-1', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> 83<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt> 84<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> 85<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Variable googleapiclient._auth.google_auth_httplib2=googleapiclient._auth-module.html#google_auth_httplib2"><a title="googleapiclient._auth.google_auth_httplib2" class="py-name" href="#" onclick="return doclink('link-2', 'google_auth_httplib2', 'link-2');">google_auth_httplib2</a></tt> </tt> 86<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> <tt class="py-comment"># pragma: NO COVER</tt> </tt> 87<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> <tt id="link-3" class="py-name"><a title="googleapiclient._auth.google_auth_httplib2" class="py-name" href="#" onclick="return doclink('link-3', 'google_auth_httplib2', 'link-2');">google_auth_httplib2</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt> 88<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt> 89<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> 90<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">oauth2client</tt> </tt> 91<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">client</tt> </tt> 92<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> <tt id="link-4" class="py-name" targets="Variable googleapiclient._auth.HAS_OAUTH2CLIENT=googleapiclient._auth-module.html#HAS_OAUTH2CLIENT"><a title="googleapiclient._auth.HAS_OAUTH2CLIENT" class="py-name" href="#" onclick="return doclink('link-4', 'HAS_OAUTH2CLIENT', 'link-4');">HAS_OAUTH2CLIENT</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> 93<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> <tt class="py-comment"># pragma: NO COVER</tt> </tt> 94<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt id="link-5" class="py-name"><a title="googleapiclient._auth.HAS_OAUTH2CLIENT" class="py-name" href="#" onclick="return doclink('link-5', 'HAS_OAUTH2CLIENT', 'link-4');">HAS_OAUTH2CLIENT</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> 95<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> </tt> 96<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> </tt> 97<a name="default_credentials"></a><div id="default_credentials-def"><a name="L39"></a><tt class="py-lineno"> 39</tt> <a class="py-toggle" href="#" id="default_credentials-toggle" onclick="return toggle('default_credentials');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#default_credentials">default_credentials</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 98</div><div id="default_credentials-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="default_credentials-expanded"><a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns Application Default Credentials."""</tt> </tt> 99<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-6" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-6', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt><tt class="py-op">:</tt> </tt> 100<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">_</tt> <tt class="py-op">=</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">default</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> 101<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt> </tt> 102<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt id="link-7" class="py-name"><a title="googleapiclient._auth.HAS_OAUTH2CLIENT" class="py-name" href="#" onclick="return doclink('link-7', 'HAS_OAUTH2CLIENT', 'link-4');">HAS_OAUTH2CLIENT</a></tt><tt class="py-op">:</tt> </tt> 103<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">oauth2client</tt><tt class="py-op">.</tt><tt class="py-name">client</tt><tt class="py-op">.</tt><tt class="py-name">GoogleCredentials</tt><tt class="py-op">.</tt><tt class="py-name">get_application_default</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> 104<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 105<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">EnvironmentError</tt><tt class="py-op">(</tt> </tt> 106<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-string">'No authentication library is available. Please install either '</tt> </tt> 107<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-string">'google-auth or oauth2client.'</tt><tt class="py-op">)</tt> </tt> 108</div><a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> </tt> 109<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt> 110<a name="with_scopes"></a><div id="with_scopes-def"><a name="L52"></a><tt class="py-lineno"> 52</tt> <a class="py-toggle" href="#" id="with_scopes-toggle" onclick="return toggle('with_scopes');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#with_scopes">with_scopes</a><tt class="py-op">(</tt><tt class="py-param">credentials</tt><tt class="py-op">,</tt> <tt class="py-param">scopes</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 111</div><div id="with_scopes-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="with_scopes-expanded"><a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-docstring">"""Scopes the credentials if necessary.</tt> </tt> 112<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 113<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> 114<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> credentials (Union[</tt> </tt> 115<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> google.auth.credentials.Credentials,</tt> </tt> 116<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials]): The credentials to scope.</tt> </tt> 117<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> scopes (Sequence[str]): The list of scopes.</tt> </tt> 118<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 119<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> 120<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> Union[google.auth.credentials.Credentials,</tt> </tt> 121<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials]: The scoped credentials.</tt> </tt> 122<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> 123<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-8" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-8', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt> </tt> 124<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 125<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">with_scopes_if_required</tt><tt class="py-op">(</tt> </tt> 126<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">scopes</tt><tt class="py-op">)</tt> </tt> 127<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 128<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt> 129<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped_required</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 130<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">create_scoped</tt><tt class="py-op">(</tt><tt class="py-name">scopes</tt><tt class="py-op">)</tt> </tt> 131<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 132<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt> </tt> 133<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">AttributeError</tt><tt class="py-op">:</tt> </tt> 134<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt> </tt> 135</div><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> </tt> 136<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> </tt> 137<a name="authorized_http"></a><div id="authorized_http-def"><a name="L79"></a><tt class="py-lineno"> 79</tt> <a class="py-toggle" href="#" id="authorized_http-toggle" onclick="return toggle('authorized_http');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#authorized_http">authorized_http</a><tt class="py-op">(</tt><tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 138</div><div id="authorized_http-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="authorized_http-expanded"><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-docstring">"""Returns an http client that is authorized with the given credentials.</tt> </tt> 139<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 140<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> 141<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> credentials (Union[</tt> </tt> 142<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> google.auth.credentials.Credentials,</tt> </tt> 143<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> oauth2client.client.Credentials]): The credentials to use.</tt> </tt> 144<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> 145<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> 146<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]: An</tt> </tt> 147<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> authorized http client.</tt> </tt> 148<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> 149<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt id="link-9" class="py-name" targets="Package googleapiclient=googleapiclient-module.html"><a title="googleapiclient" class="py-name" href="#" onclick="return doclink('link-9', 'googleapiclient', 'link-9');">googleapiclient</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Module googleapiclient.http=googleapiclient.http-module.html"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-10', 'http', 'link-10');">http</a></tt> <tt class="py-keyword">import</tt> <tt id="link-11" class="py-name" targets="Function googleapiclient.http.build_http()=googleapiclient.http-module.html#build_http"><a title="googleapiclient.http.build_http" class="py-name" href="#" onclick="return doclink('link-11', 'build_http', 'link-11');">build_http</a></tt> </tt> 150<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> </tt> 151<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-12" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-12', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt> </tt> 152<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 153<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name"><a title="googleapiclient._auth.google_auth_httplib2" class="py-name" href="#" onclick="return doclink('link-13', 'google_auth_httplib2', 'link-2');">google_auth_httplib2</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> 154<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt> </tt> 155<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-string">'Credentials from google.auth specified, but '</tt> </tt> 156<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-string">'google-api-python-client is unable to use these credentials '</tt> </tt> 157<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-string">'unless google-auth-httplib2 is installed. Please install '</tt> </tt> 158<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-string">'google-auth-httplib2.'</tt><tt class="py-op">)</tt> </tt> 159<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-14" class="py-name"><a title="googleapiclient._auth.google_auth_httplib2" class="py-name" href="#" onclick="return doclink('link-14', 'google_auth_httplib2', 'link-2');">google_auth_httplib2</a></tt><tt class="py-op">.</tt><tt class="py-name">AuthorizedHttp</tt><tt class="py-op">(</tt><tt class="py-name">credentials</tt><tt class="py-op">,</tt> </tt> 160<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-15', 'http', 'link-10');">http</a></tt><tt class="py-op">=</tt><tt id="link-16" class="py-name"><a title="googleapiclient.http.build_http" class="py-name" href="#" onclick="return doclink('link-16', 'build_http', 'link-11');">build_http</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> 161<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 162<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">authorize</tt><tt class="py-op">(</tt><tt id="link-17" class="py-name"><a title="googleapiclient.http.build_http" class="py-name" href="#" onclick="return doclink('link-17', 'build_http', 'link-11');">build_http</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> 163</div><a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> </tt> 164<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt> 165<a name="refresh_credentials"></a><div id="refresh_credentials-def"><a name="L107"></a><tt class="py-lineno">107</tt> <a class="py-toggle" href="#" id="refresh_credentials-toggle" onclick="return toggle('refresh_credentials');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#refresh_credentials">refresh_credentials</a><tt class="py-op">(</tt><tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 166</div><div id="refresh_credentials-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="refresh_credentials-expanded"><a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-comment"># Refresh must use a new http instance, as the one associated with the</tt> </tt> 167<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-comment"># credentials could be a AuthorizedHttp or an oauth2client-decorated</tt> </tt> 168<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-comment"># Http instance which would cause a weird recursive loop of refreshing</tt> </tt> 169<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-comment"># and likely tear a hole in spacetime.</tt> </tt> 170<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-name">refresh_http</tt> <tt class="py-op">=</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Http</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> 171<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-18" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-18', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt> </tt> 172<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 173<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt id="link-19" class="py-name" targets="Method googleapiclient.http.HttpMock.request()=googleapiclient.http.HttpMock-class.html#request,Method googleapiclient.http.HttpMockSequence.request()=googleapiclient.http.HttpMockSequence-class.html#request,Method googleapiclient.model.BaseModel.request()=googleapiclient.model.BaseModel-class.html#request,Method googleapiclient.model.Model.request()=googleapiclient.model.Model-class.html#request"><a title="googleapiclient.http.HttpMock.request 174googleapiclient.http.HttpMockSequence.request 175googleapiclient.model.BaseModel.request 176googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-19', 'request', 'link-19');">request</a></tt> <tt class="py-op">=</tt> <tt id="link-20" class="py-name"><a title="googleapiclient._auth.google_auth_httplib2" class="py-name" href="#" onclick="return doclink('link-20', 'google_auth_httplib2', 'link-2');">google_auth_httplib2</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">refresh_http</tt><tt class="py-op">)</tt> </tt> 177<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">refresh</tt><tt class="py-op">(</tt><tt id="link-21" class="py-name"><a title="googleapiclient.http.HttpMock.request 178googleapiclient.http.HttpMockSequence.request 179googleapiclient.model.BaseModel.request 180googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-21', 'request', 'link-19');">request</a></tt><tt class="py-op">)</tt> </tt> 181<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 182<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">refresh</tt><tt class="py-op">(</tt><tt class="py-name">refresh_http</tt><tt class="py-op">)</tt> </tt> 183</div><a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> </tt> 184<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> </tt> 185<a name="apply_credentials"></a><div id="apply_credentials-def"><a name="L121"></a><tt class="py-lineno">121</tt> <a class="py-toggle" href="#" id="apply_credentials-toggle" onclick="return toggle('apply_credentials');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#apply_credentials">apply_credentials</a><tt class="py-op">(</tt><tt class="py-param">credentials</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 186</div><div id="apply_credentials-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="apply_credentials-expanded"><a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-comment"># oauth2client and google-auth have the same interface for this.</tt> </tt> 187<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-22" class="py-name" targets="Function googleapiclient._auth.is_valid()=googleapiclient._auth-module.html#is_valid"><a title="googleapiclient._auth.is_valid" class="py-name" href="#" onclick="return doclink('link-22', 'is_valid', 'link-22');">is_valid</a></tt><tt class="py-op">(</tt><tt class="py-name">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 188<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt id="link-23" class="py-name" targets="Function googleapiclient._auth.refresh_credentials()=googleapiclient._auth-module.html#refresh_credentials"><a title="googleapiclient._auth.refresh_credentials" class="py-name" href="#" onclick="return doclink('link-23', 'refresh_credentials', 'link-23');">refresh_credentials</a></tt><tt class="py-op">(</tt><tt class="py-name">credentials</tt><tt class="py-op">)</tt> </tt> 189<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">apply</tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> 190</div><a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> </tt> 191<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> </tt> 192<a name="is_valid"></a><div id="is_valid-def"><a name="L128"></a><tt class="py-lineno">128</tt> <a class="py-toggle" href="#" id="is_valid-toggle" onclick="return toggle('is_valid');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#is_valid">is_valid</a><tt class="py-op">(</tt><tt class="py-param">credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 193</div><div id="is_valid-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="is_valid-expanded"><a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-24" class="py-name"><a title="googleapiclient._auth.HAS_GOOGLE_AUTH" class="py-name" href="#" onclick="return doclink('link-24', 'HAS_GOOGLE_AUTH', 'link-0');">HAS_GOOGLE_AUTH</a></tt> <tt class="py-keyword">and</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt> </tt> 194<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">google</tt><tt class="py-op">.</tt><tt class="py-name">auth</tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 195<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">valid</tt> </tt> 196<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 197<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt> </tt> 198<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">access_token</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> 199<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-keyword">not</tt> <tt class="py-name">credentials</tt><tt class="py-op">.</tt><tt class="py-name">access_token_expired</tt><tt class="py-op">)</tt> </tt> 200</div><a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> </tt> 201<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> </tt> 202<a name="get_credentials_from_http"></a><div id="get_credentials_from_http-def"><a name="L138"></a><tt class="py-lineno">138</tt> <a class="py-toggle" href="#" id="get_credentials_from_http-toggle" onclick="return toggle('get_credentials_from_http');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="googleapiclient._auth-module.html#get_credentials_from_http">get_credentials_from_http</a><tt class="py-op">(</tt><tt class="py-param">http</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 203</div><div id="get_credentials_from_http-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_credentials_from_http-expanded"><a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-25" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-25', 'http', 'link-10');">http</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> 204<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> 205<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-26" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-26', 'http', 'link-10');">http</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="googleapiclient.http.HttpMock.request 206googleapiclient.http.HttpMockSequence.request 207googleapiclient.model.BaseModel.request 208googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-27', 'request', 'link-19');">request</a></tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 209<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-28" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-28', 'http', 'link-10');">http</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="googleapiclient.http.HttpMock.request 210googleapiclient.http.HttpMockSequence.request 211googleapiclient.model.BaseModel.request 212googleapiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-29', 'request', 'link-19');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt> </tt> 213<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-name">hasattr</tt><tt class="py-op">(</tt><tt id="link-30" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-30', 'http', 'link-10');">http</a></tt><tt class="py-op">,</tt> <tt class="py-string">'credentials'</tt><tt class="py-op">)</tt> </tt> 214<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-31" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-31', 'http', 'link-10');">http</a></tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt><tt class="py-op">,</tt> <tt class="py-name">httplib2</tt><tt class="py-op">.</tt><tt class="py-name">Credentials</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> 215<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-32" class="py-name"><a title="googleapiclient.http" class="py-name" href="#" onclick="return doclink('link-32', 'http', 'link-10');">http</a></tt><tt class="py-op">.</tt><tt class="py-name">credentials</tt> </tt> 216<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> 217<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt> 218</div><a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> </tt><script type="text/javascript"> 219<!-- 220expandto(location.href); 221// --> 222</script> 223</pre> 224<br /> 225<!-- ==================== NAVIGATION BAR ==================== --> 226<table class="navbar" border="0" width="100%" cellpadding="0" 227 bgcolor="#a0c0ff" cellspacing="0"> 228 <tr valign="middle"> 229 <!-- Home link --> 230 <th> <a 231 href="googleapiclient-module.html">Home</a> </th> 232 233 <!-- Tree link --> 234 <th> <a 235 href="module-tree.html">Trees</a> </th> 236 237 <!-- Index link --> 238 <th> <a 239 href="identifier-index.html">Indices</a> </th> 240 241 <!-- Help link --> 242 <th> <a 243 href="help.html">Help</a> </th> 244 245 <th class="navbar" width="100%"></th> 246 </tr> 247</table> 248<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 249 <tr> 250 <td align="left" class="footer"> 251 Generated by Epydoc 3.0.1 on Fri Jun 14 15:57:29 2019 252 </td> 253 <td align="right" class="footer"> 254 <a target="mainFrame" href="http://epydoc.sourceforge.net" 255 >http://epydoc.sourceforge.net</a> 256 </td> 257 </tr> 258</table> 259 260<script type="text/javascript"> 261 <!-- 262 // Private objects are initially displayed (because if 263 // javascript is turned off then we want them to be 264 // visible); but by default, we want to hide them. So hide 265 // them unless we have a cookie that says to show them. 266 checkCookie(); 267 // --> 268</script> 269</body> 270</html> 271