Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5350efbd1960dc5a25376ac73b15f4d6ec8428ef / . / docs / epy / oauth2client.tools-pysrc.html
blob: 5e8d427e393b294a5320459677c9a6248af345f3 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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>oauth2client.tools</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
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 Module&nbsp;tools
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.tools-pysrc.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<h1 class="epydoc">Source Code for <a href="oauth2client.tools-module.html">Module oauth2client.tools</a></h1>
55<pre class="py-src">
56<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright (C) 2010 Google Inc.</tt> </tt>
57<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
58<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>
59<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>
60<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>
61<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
62<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>
63<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
64<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>
65<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>
66<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>
67<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>
68<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt>
69<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"> </tt>
70<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">"""Command-line tools for authenticating via OAuth 2.0</tt> </tt>
71<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
72<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">Do the OAuth 2.0 Web Server dance for a command line application. Stores the</tt> </tt>
73<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">generated credentials in a common file that is used by other example apps in</tt> </tt>
74<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">the same directory.</tt> </tt>
75<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
76<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt>
77<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'jcgregorio@google.com (Joe Gregorio)'</tt> </tt>
78<a name="L23"></a><tt class="py-lineno"> 23</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">'run'</tt><tt class="py-op">]</tt> </tt>
79<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> </tt>
80<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt>
81<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">BaseHTTPServer</tt> </tt>
82<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">gflags</tt> </tt>
83<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">socket</tt> </tt>
84<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
85<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">webbrowser</tt> </tt>
86<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]87<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-0', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module oauth2client.client=oauth2client.client-module.html"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-1', 'client', 'link-1');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Class oauth2client.client.FlowExchangeError=oauth2client.client.FlowExchangeError-class.html"><a title="oauth2client.client.FlowExchangeError" class="py-name" href="#" onclick="return doclink('link-2', 'FlowExchangeError', 'link-2');">FlowExchangeError</a></tt> </tt>
88<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-3" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-3', 'oauth2client', 'link-0');">oauth2client</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="oauth2client.client" class="py-name" href="#" onclick="return doclink('link-4', 'client', 'link-1');">client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-5" class="py-name" targets="Variable oauth2client.client.OOB_CALLBACK_URN=oauth2client.client-module.html#OOB_CALLBACK_URN"><a title="oauth2client.client.OOB_CALLBACK_URN" class="py-name" href="#" onclick="return doclink('link-5', 'OOB_CALLBACK_URN', 'link-5');">OOB_CALLBACK_URN</a></tt> </tt>
89<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-6" class="py-name"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-6', 'oauth2client', 'link-0');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-7" class="py-name" targets="Module oauth2client.util=oauth2client.util-module.html"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-7', 'util', 'link-7');">util</a></tt> </tt>
90<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> </tt>
91<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
92<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">urlparse</tt> <tt class="py-keyword">import</tt> <tt class="py-name">parse_qsl</tt> </tt>
93<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
94<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-keyword">from</tt> <tt class="py-name">cgi</tt> <tt class="py-keyword">import</tt> <tt class="py-name">parse_qsl</tt> </tt>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]95<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]96<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> </tt>
97<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt id="link-8" class="py-name" targets="Variable apiclient.model.FLAGS=apiclient.model-module.html#FLAGS,Variable oauth2client.tools.FLAGS=oauth2client.tools-module.html#FLAGS,Variable oauth2client.util.FLAGS=oauth2client.util-module.html#FLAGS"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]98oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]99oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-8', 'FLAGS', 'link-8');">FLAGS</a></tt> <tt class="py-op">=</tt> <tt class="py-name">gflags</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]100oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]101oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-9', 'FLAGS', 'link-8');">FLAGS</a></tt> </tt>
102<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> </tt>
103<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-name">gflags</tt><tt class="py-op">.</tt><tt class="py-name">DEFINE_boolean</tt><tt class="py-op">(</tt><tt class="py-string">'auth_local_webserver'</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> </tt>
104<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'Run a local web server to handle redirects during '</tt> </tt>
105<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-string">'OAuth authorization.'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
106<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> </tt>
107<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-name">gflags</tt><tt class="py-op">.</tt><tt class="py-name">DEFINE_string</tt><tt class="py-op">(</tt><tt class="py-string">'auth_host_name'</tt><tt class="py-op">,</tt> <tt class="py-string">'localhost'</tt><tt class="py-op">,</tt> </tt>
108<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'Host name to use when running a local web server to '</tt> </tt>
109<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-string">'handle redirects during OAuth authorization.'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
110<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> </tt>
111<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-name">gflags</tt><tt class="py-op">.</tt><tt class="py-name">DEFINE_multi_int</tt><tt class="py-op">(</tt><tt class="py-string">'auth_host_port'</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-number">8080</tt><tt class="py-op">,</tt> <tt class="py-number">8090</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> </tt>
112<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-string">'Port to use when running a local web server to '</tt> </tt>
113<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-string">'handle redirects during OAuth authorization.'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
114<a name="ClientRedirectServer"></a><div id="ClientRedirectServer-def"><a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> </tt>
115<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt>
116<a name="L57"></a><tt class="py-lineno"> 57</tt> <a class="py-toggle" href="#" id="ClientRedirectServer-toggle" onclick="return toggle('ClientRedirectServer');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.tools.ClientRedirectServer-class.html">ClientRedirectServer</a><tt class="py-op">(</tt><tt class="py-base-class">BaseHTTPServer</tt><tt class="py-op">.</tt><tt class="py-base-class">HTTPServer</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
117</div><div id="ClientRedirectServer-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ClientRedirectServer-expanded"><a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-docstring">"""A server to handle OAuth 2.0 redirects back to localhost.</tt> </tt>
118<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
119<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> Waits for a single request and parses the query parameters</tt> </tt>
120<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> into query_params and then stops serving.</tt> </tt>
121<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
122<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt id="link-10" class="py-name" targets="Variable oauth2client.tools.ClientRedirectServer.query_params=oauth2client.tools.ClientRedirectServer-class.html#query_params"><a title="oauth2client.tools.ClientRedirectServer.query_params" class="py-name" href="#" onclick="return doclink('link-10', 'query_params', 'link-10');">query_params</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
123</div><a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> </tt>
124<a name="ClientRedirectHandler"></a><div id="ClientRedirectHandler-def"><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
125<a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="ClientRedirectHandler-toggle" onclick="return toggle('ClientRedirectHandler');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.tools.ClientRedirectHandler-class.html">ClientRedirectHandler</a><tt class="py-op">(</tt><tt class="py-base-class">BaseHTTPServer</tt><tt class="py-op">.</tt><tt class="py-base-class">BaseHTTPRequestHandler</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
126</div><div id="ClientRedirectHandler-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="ClientRedirectHandler-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-docstring">"""A handler for OAuth 2.0 redirects back to localhost.</tt> </tt>
127<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
128<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> Waits for a single request and parses the query parameters</tt> </tt>
129<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"> into the servers query_params and then stops serving.</tt> </tt>
130<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
131<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> </tt>
132<a name="ClientRedirectHandler.do_GET"></a><div id="ClientRedirectHandler.do_GET-def"><a name="L73"></a><tt class="py-lineno"> 73</tt> <a class="py-toggle" href="#" id="ClientRedirectHandler.do_GET-toggle" onclick="return toggle('ClientRedirectHandler.do_GET');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.tools.ClientRedirectHandler-class.html#do_GET">do_GET</a><tt class="py-op">(</tt><tt class="py-param">s</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
133</div><div id="ClientRedirectHandler.do_GET-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ClientRedirectHandler.do_GET-expanded"><a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-docstring">"""Handle a GET request.</tt> </tt>
134<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
135<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> Parses the query parameters and prints a message</tt> </tt>
136<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> if the flow has completed. Note that we can't detect</tt> </tt>
137<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> if an error occurred.</tt> </tt>
138<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
139<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">send_response</tt><tt class="py-op">(</tt><tt class="py-number">200</tt><tt class="py-op">)</tt> </tt>
140<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">send_header</tt><tt class="py-op">(</tt><tt class="py-string">"Content-type"</tt><tt class="py-op">,</tt> <tt class="py-string">"text/html"</tt><tt class="py-op">)</tt> </tt>
141<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">end_headers</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
142<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">path</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-number">1</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>
143<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-name">query</tt> <tt class="py-op">=</tt> <tt class="py-name">dict</tt><tt class="py-op">(</tt><tt class="py-name">parse_qsl</tt><tt class="py-op">(</tt><tt class="py-name">query</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
144<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">server</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="oauth2client.tools.ClientRedirectServer.query_params" class="py-name" href="#" onclick="return doclink('link-11', 'query_params', 'link-10');">query_params</a></tt> <tt class="py-op">=</tt> <tt class="py-name">query</tt> </tt>
145<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">wfile</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-string">"&lt;html&gt;&lt;head&gt;&lt;title&gt;Authentication Status&lt;/title&gt;&lt;/head&gt;"</tt><tt class="py-op">)</tt> </tt>
146<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">wfile</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-string">"&lt;body&gt;&lt;p&gt;The authentication flow has completed.&lt;/p&gt;"</tt><tt class="py-op">)</tt> </tt>
147<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-name">s</tt><tt class="py-op">.</tt><tt class="py-name">wfile</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-string">"&lt;/body&gt;&lt;/html&gt;"</tt><tt class="py-op">)</tt> </tt>
148</div><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> </tt>
149<a name="ClientRedirectHandler.log_message"></a><div id="ClientRedirectHandler.log_message-def"><a name="L90"></a><tt class="py-lineno"> 90</tt> <a class="py-toggle" href="#" id="ClientRedirectHandler.log_message-toggle" onclick="return toggle('ClientRedirectHandler.log_message');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.tools.ClientRedirectHandler-class.html#log_message">log_message</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">format</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>
150</div><div id="ClientRedirectHandler.log_message-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="ClientRedirectHandler.log_message-expanded"><a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-docstring">"""Do not log messages to stdout while running as command line program."""</tt> </tt>
151<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
152</div></div><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> </tt>
153<a name="run"></a><div id="run-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> </tt>
154<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Function oauth2client.util.positional()=oauth2client.util-module.html#positional"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-12', 'positional', 'link-12');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
155<a name="L96"></a><tt class="py-lineno"> 96</tt> <a class="py-toggle" href="#" id="run-toggle" onclick="return toggle('run');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.tools-module.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">flow</tt><tt class="py-op">,</tt> <tt class="py-param">storage</tt><tt class="py-op">,</tt> <tt class="py-param">http</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
156</div><div id="run-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="run-expanded"><a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-docstring">"""Core code for a command-line application.</tt> </tt>
157<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]158<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> The run() function is called from your application and runs through all the</tt> </tt>
159<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> steps to obtain credentials. It takes a Flow argument and attempts to open an</tt> </tt>
160<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> authorization server page in the user's default web browser. The server asks</tt> </tt>
161<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> the user to grant your application access to the user's data. If the user</tt> </tt>
162<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> grants access, the run() function returns new credentials. The new credentials</tt> </tt>
163<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> are also stored in the Storage argument, which updates the file associated</tt> </tt>
164<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> with the Storage object.</tt> </tt>
165<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
166<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> It presumes it is run from a command-line application and supports the</tt> </tt>
167<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> following flags:</tt> </tt>
168<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
169<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> --[no]auth_local_webserver</tt> </tt>
170<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
171<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> Run a local web server to handle redirects during OAuth authorization.</tt> </tt>
172<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
173<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> --auth_host_name</tt> </tt>
174<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
175<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"> Host name to use when running a local web server to handle redirects</tt> </tt>
176<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> during OAuth authorization.</tt> </tt>
177<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
178<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> --auth_host_port</tt> </tt>
179<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
180<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> Port to use when running a local web server to handle redirects during</tt> </tt>
181<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> OAuth authorization.</tt> </tt>
182<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
183<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-docstring"> Since it uses flags make sure to initialize the gflags module before calling</tt> </tt>
184<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"><tt class="py-docstring"> run().</tt> </tt>
185<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
186<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
187<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"><tt class="py-docstring"> flow: Flow, an OAuth 2.0 Flow to step through.</tt> </tt>
188<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> storage: Storage, a Storage to store the credential in.</tt> </tt>
189<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> http: An instance of httplib2.Http.request</tt> </tt>
190<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> or something that acts like it.</tt> </tt>
191<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
192<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt>
193<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> Credentials, the obtained credential.</tt> </tt>
194<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
195<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]196oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]197oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-13', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_local_webserver</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]198<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">success</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
199<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-name">port_number</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
200<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">port</tt> <tt class="py-keyword">in</tt> <tt id="link-14" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]201oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]202oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-14', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_host_port</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]203<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-name">port_number</tt> <tt class="py-op">=</tt> <tt class="py-name">port</tt> </tt>
204<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
205<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-name">httpd</tt> <tt class="py-op">=</tt> <tt id="link-15" class="py-name" targets="Class oauth2client.tools.ClientRedirectServer=oauth2client.tools.ClientRedirectServer-class.html"><a title="oauth2client.tools.ClientRedirectServer" class="py-name" href="#" onclick="return doclink('link-15', 'ClientRedirectServer', 'link-15');">ClientRedirectServer</a></tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt id="link-16" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]206oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]207oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-16', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_host_name</tt><tt class="py-op">,</tt> <tt class="py-name">port</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]208<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt id="link-17" class="py-name" targets="Class oauth2client.tools.ClientRedirectHandler=oauth2client.tools.ClientRedirectHandler-class.html"><a title="oauth2client.tools.ClientRedirectHandler" class="py-name" href="#" onclick="return doclink('link-17', 'ClientRedirectHandler', 'link-17');">ClientRedirectHandler</a></tt><tt class="py-op">)</tt> </tt>
209<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">socket</tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
210<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
211<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>
212<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-name">success</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
213<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
214<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> <tt id="link-18" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]215oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]216oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-18', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_local_webserver</tt> <tt class="py-op">=</tt> <tt class="py-name">success</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]217<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">success</tt><tt class="py-op">:</tt> </tt>
218<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Failed to start a local webserver listening on either port 8080'</tt> </tt>
219<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'or port 9090. Please check your firewall settings and locally'</tt> </tt>
220<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'running programs that may be blocking or using those ports.'</tt> </tt>
221<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
222<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Falling back to --noauth_local_webserver and continuing with'</tt><tt class="py-op">,</tt> </tt>
223<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'authorization.'</tt> </tt>
224<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
225<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> </tt>
226<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-19" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]227oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]228oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-19', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_local_webserver</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]229<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-name">oauth_callback</tt> <tt class="py-op">=</tt> <tt class="py-string">'http://%s:%s/'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-20" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]230oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]231oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-20', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_host_name</tt><tt class="py-op">,</tt> <tt class="py-name">port_number</tt><tt class="py-op">)</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]232<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
233<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> <tt class="py-name">oauth_callback</tt> <tt class="py-op">=</tt> <tt id="link-21" class="py-name"><a title="oauth2client.client.OOB_CALLBACK_URN" class="py-name" href="#" onclick="return doclink('link-21', 'OOB_CALLBACK_URN', 'link-5');">OOB_CALLBACK_URN</a></tt> </tt>
234<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt class="py-name">redirect_uri</tt> <tt class="py-op">=</tt> <tt class="py-name">oauth_callback</tt> </tt>
235<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt id="link-22" class="py-name" targets="Method oauth2client.appengine.OAuth2Decorator.authorize_url()=oauth2client.appengine.OAuth2Decorator-class.html#authorize_url"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-22', 'authorize_url', 'link-22');">authorize_url</a></tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Method oauth2client.client.OAuth2WebServerFlow.step1_get_authorize_url()=oauth2client.client.OAuth2WebServerFlow-class.html#step1_get_authorize_url"><a title="oauth2client.client.OAuth2WebServerFlow.step1_get_authorize_url" class="py-name" href="#" onclick="return doclink('link-23', 'step1_get_authorize_url', 'link-23');">step1_get_authorize_url</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
236<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> </tt>
237<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-24" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]238oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]239oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-24', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_local_webserver</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]240<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> <tt class="py-name">webbrowser</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt id="link-25" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-25', 'authorize_url', 'link-22');">authorize_url</a></tt><tt class="py-op">,</tt> <tt class="py-name">new</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-name">autoraise</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt> </tt>
241<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Your browser has been opened to visit:'</tt> </tt>
242<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
243<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt id="link-26" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-26', 'authorize_url', 'link-22');">authorize_url</a></tt> </tt>
244<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
245<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'If your browser is on a different machine then exit and re-run this'</tt> </tt>
246<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'application with the command-line parameter '</tt> </tt>
247<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
248<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">' --noauth_local_webserver'</tt> </tt>
249<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
250<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
251<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Go to the following link in your browser:'</tt> </tt>
252<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
253<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt id="link-27" class="py-name"><a title="oauth2client.appengine.OAuth2Decorator.authorize_url" class="py-name" href="#" onclick="return doclink('link-27', 'authorize_url', 'link-22');">authorize_url</a></tt> </tt>
254<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> </tt>
255<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> </tt>
256<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-name">code</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
257<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-28" class="py-name"><a title="apiclient.model.FLAGS
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]258oauth2client.tools.FLAGS
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]259oauth2client.util.FLAGS" class="py-name" href="#" onclick="return doclink('link-28', 'FLAGS', 'link-8');">FLAGS</a></tt><tt class="py-op">.</tt><tt class="py-name">auth_local_webserver</tt><tt class="py-op">:</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]260<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-name">httpd</tt><tt class="py-op">.</tt><tt class="py-name">handle_request</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
261<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'error'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">httpd</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="oauth2client.tools.ClientRedirectServer.query_params" class="py-name" href="#" onclick="return doclink('link-29', 'query_params', 'link-10');">query_params</a></tt><tt class="py-op">:</tt> </tt>
262<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-string">'Authentication request was rejected.'</tt><tt class="py-op">)</tt> </tt>
263<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'code'</tt> <tt class="py-keyword">in</tt> <tt class="py-name">httpd</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="oauth2client.tools.ClientRedirectServer.query_params" class="py-name" href="#" onclick="return doclink('link-30', 'query_params', 'link-10');">query_params</a></tt><tt class="py-op">:</tt> </tt>
264<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-name">code</tt> <tt class="py-op">=</tt> <tt class="py-name">httpd</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="oauth2client.tools.ClientRedirectServer.query_params" class="py-name" href="#" onclick="return doclink('link-31', 'query_params', 'link-10');">query_params</a></tt><tt class="py-op">[</tt><tt class="py-string">'code'</tt><tt class="py-op">]</tt> </tt>
265<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
266<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Failed to find "code" in the query parameters of the redirect.'</tt> </tt>
267<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-string">'Try running with --noauth_local_webserver.'</tt><tt class="py-op">)</tt> </tt>
268<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
269<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-name">code</tt> <tt class="py-op">=</tt> <tt class="py-name">raw_input</tt><tt class="py-op">(</tt><tt class="py-string">'Enter verification code: '</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
270<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> </tt>
271<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
272<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-name">credential</tt> <tt class="py-op">=</tt> <tt class="py-name">flow</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method oauth2client.client.OAuth2WebServerFlow.step2_exchange()=oauth2client.client.OAuth2WebServerFlow-class.html#step2_exchange"><a title="oauth2client.client.OAuth2WebServerFlow.step2_exchange" class="py-name" href="#" onclick="return doclink('link-32', 'step2_exchange', 'link-32');">step2_exchange</a></tt><tt class="py-op">(</tt><tt class="py-name">code</tt><tt class="py-op">,</tt> <tt id="link-33" class="py-name" targets="Module apiclient.http=apiclient.http-module.html,Method oauth2client.appengine.OAuth2Decorator.http()=oauth2client.appengine.OAuth2Decorator-class.html#http"><a title="apiclient.http
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]273oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-33', 'http', 'link-33');">http</a></tt><tt class="py-op">=</tt><tt id="link-34" class="py-name"><a title="apiclient.http
274oauth2client.appengine.OAuth2Decorator.http" class="py-name" href="#" onclick="return doclink('link-34', 'http', 'link-33');">http</a></tt><tt class="py-op">)</tt> </tt>
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]275<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt id="link-35" class="py-name"><a title="oauth2client.client.FlowExchangeError" class="py-name" href="#" onclick="return doclink('link-35', 'FlowExchangeError', 'link-2');">FlowExchangeError</a></tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
276<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exit</tt><tt class="py-op">(</tt><tt class="py-string">'Authentication has failed: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">e</tt><tt class="py-op">)</tt> </tt>
277<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> </tt>
278<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-name">storage</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method oauth2client.client.Storage.put()=oauth2client.client.Storage-class.html#put"><a title="oauth2client.client.Storage.put" class="py-name" href="#" onclick="return doclink('link-36', 'put', 'link-36');">put</a></tt><tt class="py-op">(</tt><tt class="py-name">credential</tt><tt class="py-op">)</tt> </tt>
279<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-name">credential</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Method oauth2client.client.OAuth2Credentials.set_store()=oauth2client.client.OAuth2Credentials-class.html#set_store"><a title="oauth2client.client.OAuth2Credentials.set_store" class="py-name" href="#" onclick="return doclink('link-37', 'set_store', 'link-37');">set_store</a></tt><tt class="py-op">(</tt><tt class="py-name">storage</tt><tt class="py-op">)</tt> </tt>
280<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-keyword">print</tt> <tt class="py-string">'Authentication successful.'</tt> </tt>
281<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> </tt>
282<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">credential</tt> </tt>
283</div><a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> </tt><script type="text/javascript">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]284<!--
285expandto(location.href);
286// -->
287</script>
288</pre>
289<br />
290<!-- ==================== NAVIGATION BAR ==================== -->
291<table class="navbar" border="0" width="100%" cellpadding="0"
292 bgcolor="#a0c0ff" cellspacing="0">
293 <tr valign="middle">
294
295 <!-- Tree link -->
296 <th>&nbsp;&nbsp;&nbsp;<a
297 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
298
299 <!-- Index link -->
300 <th>&nbsp;&nbsp;&nbsp;<a
301 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
302
303 <!-- Help link -->
304 <th>&nbsp;&nbsp;&nbsp;<a
305 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
306
307 <th class="navbar" width="100%"></th>
308 </tr>
309</table>
310<table border="0" cellpadding="0" cellspacing="0" width="100%%">
311 <tr>
312 <td align="left" class="footer">
Joe Gregorio5350efb2012-10-24 08:54:11 -0400[diff] [blame^]313 Generated by Epydoc 3.0.1 on Wed Oct 24 08:53:10 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]314 </td>
315 <td align="right" class="footer">
316 <a target="mainFrame" href="http://epydoc.sourceforge.net"
317 >http://epydoc.sourceforge.net</a>
318 </td>
319 </tr>
320</table>
321
322<script type="text/javascript">
323 <!--
324 // Private objects are initially displayed (because if
325 // javascript is turned off then we want them to be
326 // visible); but by default, we want to hide them. So hide
327 // them unless we have a cookie that says to show them.
328 checkCookie();
329 // -->
330</script>
331</body>
332</html>