Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / epy / googleapiclient.sample_tools-module.html
blob: 042bbb632938176c1bccde168ef692cf2caa19a4 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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>googleapiclient.sample_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 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;googleapiclient</a> ::
41 Module&nbsp;sample_tools
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&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="googleapiclient.sample_tools-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== MODULE DESCRIPTION ==================== -->
58<h1 class="epydoc">Module sample_tools</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.sample_tools-pysrc.html">source&nbsp;code</a></span></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]59<p>Utilities for making samples.</p>
60 <p>Consolidates a lot of code commonly repeated in sample
61 applications.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 jcgregorio@google.com (Joe Gregorio)
66 </p>
67</div><!-- ==================== FUNCTIONS ==================== -->
68<a name="section-Functions"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Functions</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Functions"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <table width="100%" cellpadding="0" cellspacing="0" border="0">
89 <tr>
90 <td><span class="summary-sig"><a href="googleapiclient.sample_tools-module.html#init" class="summary-sig-name">init</a>(<span class="summary-sig-arg">argv</span>,
91 <span class="summary-sig-arg">name</span>,
92 <span class="summary-sig-arg">version</span>,
93 <span class="summary-sig-arg">doc</span>,
94 <span class="summary-sig-arg">filename</span>,
95 <span class="summary-sig-arg">scope</span>=<span class="summary-sig-default">None</span>,
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]96 <span class="summary-sig-arg">parents</span>=<span class="summary-sig-default">[]</span>,
97 <span class="summary-sig-arg">discovery_filename</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98 A common initialization routine for samples.</td>
99 <td align="right" valign="top">
100 <span class="codelink"><a href="googleapiclient.sample_tools-pysrc.html#init">source&nbsp;code</a></span>
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108</table>
109<!-- ==================== FUNCTION DETAILS ==================== -->
110<a name="section-FunctionDetails"></a>
111<table class="details" border="1" cellpadding="3"
112 cellspacing="0" width="100%" bgcolor="white">
113<tr bgcolor="#70b0f0" class="table-header">
114 <td colspan="2" class="table-header">
115 <table border="0" cellpadding="0" cellspacing="0" width="100%">
116 <tr valign="top">
117 <td align="left"><span class="table-header">Function Details</span></td>
118 <td align="right" valign="top"
119 ><span class="options">[<a href="#section-FunctionDetails"
120 class="privatelink" onclick="toggle_private();"
121 >hide private</a>]</span></td>
122 </tr>
123 </table>
124 </td>
125</tr>
126</table>
127<a name="init"></a>
128<div>
129<table class="details" border="1" cellpadding="3"
130 cellspacing="0" width="100%" bgcolor="white">
131<tr><td>
132 <table width="100%" cellpadding="0" cellspacing="0" border="0">
133 <tr valign="top"><td>
134 <h3 class="epydoc"><span class="sig"><span class="sig-name">init</span>(<span class="sig-arg">argv</span>,
135 <span class="sig-arg">name</span>,
136 <span class="sig-arg">version</span>,
137 <span class="sig-arg">doc</span>,
138 <span class="sig-arg">filename</span>,
139 <span class="sig-arg">scope</span>=<span class="sig-default">None</span>,
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]140 <span class="sig-arg">parents</span>=<span class="sig-default">[]</span>,
141 <span class="sig-arg">discovery_filename</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 </h3>
143 </td><td align="right" valign="top"
144 ><span class="codelink"><a href="googleapiclient.sample_tools-pysrc.html#init">source&nbsp;code</a></span>&nbsp;
145 </td>
146 </tr></table>
147
148 <pre class="literalblock">
149A common initialization routine for samples.
150
151Many of the sample applications do the same initialization, which has now
152been consolidated into this function. This function uses common idioms found
153in almost all the samples, i.e. for an API with name 'apiname', the
154credentials are stored in a file named apiname.dat, and the
155client_secrets.json file is stored in the same directory as the application
156main file.
157
158Args:
159 argv: list of string, the command-line parameters of the application.
160 name: string, name of the API.
161 version: string, version of the API.
162 doc: string, description of the application. Usually set to __doc__.
163 file: string, filename of the application. Usually set to __file__.
164 parents: list of argparse.ArgumentParser, additional command-line flags.
165 scope: string, The OAuth scope used.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]166 discovery_filename: string, name of local discovery file (JSON). Use when discovery doc not available via URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167
168Returns:
169 A tuple of (service, flags), where service is the service object and flags
170 is the parsed command-line flags.
171
172</pre>
173 <dl class="fields">
174 </dl>
175</td></tr></table>
176</div>
177<br />
178<!-- ==================== NAVIGATION BAR ==================== -->
179<table class="navbar" border="0" width="100%" cellpadding="0"
180 bgcolor="#a0c0ff" cellspacing="0">
181 <tr valign="middle">
182 <!-- Home link -->
183 <th>&nbsp;&nbsp;&nbsp;<a
184 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
185
186 <!-- Tree link -->
187 <th>&nbsp;&nbsp;&nbsp;<a
188 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
189
190 <!-- Index link -->
191 <th>&nbsp;&nbsp;&nbsp;<a
192 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
193
194 <!-- Help link -->
195 <th>&nbsp;&nbsp;&nbsp;<a
196 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
197
198 <th class="navbar" width="100%"></th>
199 </tr>
200</table>
201<table border="0" cellpadding="0" cellspacing="0" width="100%%">
202 <tr>
203 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]204 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 </td>
206 <td align="right" class="footer">
207 <a target="mainFrame" href="http://epydoc.sourceforge.net"
208 >http://epydoc.sourceforge.net</a>
209 </td>
210 </tr>
211</table>
212
213<script type="text/javascript">
214 <!--
215 // Private objects are initially displayed (because if
216 // javascript is turned off then we want them to be
217 // visible); but by default, we want to hide them. So hide
218 // them unless we have a cookie that says to show them.
219 checkCookie();
220 // -->
221</script>
222</body>
223</html>