blob: 4348198a2f487cf5147042f18dbfb7f9a299869e [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<?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.discovery_cache</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 Package&nbsp;discovery_cache
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.discovery_cache-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== PACKAGE DESCRIPTION ==================== -->
58<h1 class="epydoc">Package discovery_cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache-pysrc.html">source&nbsp;code</a></span></p>
59<pre class="literalblock">
60Caching utility for the discovery document.
61
62</pre>
63
64<!-- ==================== SUBMODULES ==================== -->
65<a name="section-Submodules"></a>
66<table class="summary" border="1" cellpadding="3"
67 cellspacing="0" width="100%" bgcolor="white">
68<tr bgcolor="#70b0f0" class="table-header">
69 <td colspan="2" class="table-header">
70 <table border="0" cellpadding="0" cellspacing="0" width="100%">
71 <tr valign="top">
72 <td align="left"><span class="table-header">Submodules</span></td>
73 <td align="right" valign="top"
74 ><span class="options">[<a href="#section-Submodules"
75 class="privatelink" onclick="toggle_private();"
76 >hide private</a>]</span></td>
77 </tr>
78 </table>
79 </td>
80</tr>
81 <tr><td class="summary">
82 <ul class="nomargin">
83 <li> <strong class="uidlink"><a href="googleapiclient.discovery_cache.appengine_memcache-module.html">googleapiclient.discovery_cache.appengine_memcache</a></strong>: <em class="summary">App Engine memcache based cache for the discovery document.</em> </li>
84 <li> <strong class="uidlink"><a href="googleapiclient.discovery_cache.base-module.html">googleapiclient.discovery_cache.base</a></strong>: <em class="summary">An abstract class for caching the discovery document.</em> </li>
85 <li> <strong class="uidlink"><a href="googleapiclient.discovery_cache.file_cache-module.html">googleapiclient.discovery_cache.file_cache</a></strong>: <em class="summary">File based cache for the discovery document.</em> </li>
86 </ul></td></tr>
87</table>
88
89<br />
90<!-- ==================== FUNCTIONS ==================== -->
91<a name="section-Functions"></a>
92<table class="summary" border="1" cellpadding="3"
93 cellspacing="0" width="100%" bgcolor="white">
94<tr bgcolor="#70b0f0" class="table-header">
95 <td colspan="2" class="table-header">
96 <table border="0" cellpadding="0" cellspacing="0" width="100%">
97 <tr valign="top">
98 <td align="left"><span class="table-header">Functions</span></td>
99 <td align="right" valign="top"
100 ><span class="options">[<a href="#section-Functions"
101 class="privatelink" onclick="toggle_private();"
102 >hide private</a>]</span></td>
103 </tr>
104 </table>
105 </td>
106</tr>
107<tr>
108 <td width="15%" align="right" valign="top" class="summary">
109 <span class="summary-type">&nbsp;</span>
110 </td><td class="summary">
111 <table width="100%" cellpadding="0" cellspacing="0" border="0">
112 <tr>
113 <td><span class="summary-sig"><a href="googleapiclient.discovery_cache-module.html#autodetect" class="summary-sig-name">autodetect</a>()</span><br />
114 Detects an appropriate cache module and returns it.</td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="googleapiclient.discovery_cache-pysrc.html#autodetect">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124</table>
125<!-- ==================== VARIABLES ==================== -->
126<a name="section-Variables"></a>
127<table class="summary" border="1" cellpadding="3"
128 cellspacing="0" width="100%" bgcolor="white">
129<tr bgcolor="#70b0f0" class="table-header">
130 <td colspan="2" class="table-header">
131 <table border="0" cellpadding="0" cellspacing="0" width="100%">
132 <tr valign="top">
133 <td align="left"><span class="table-header">Variables</span></td>
134 <td align="right" valign="top"
135 ><span class="options">[<a href="#section-Variables"
136 class="privatelink" onclick="toggle_private();"
137 >hide private</a>]</span></td>
138 </tr>
139 </table>
140 </td>
141</tr>
142<tr>
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700146 <a name="LOGGER"></a><span class="summary-name">LOGGER</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
147 </td>
148 </tr>
149<tr>
150 <td width="15%" align="right" valign="top" class="summary">
151 <span class="summary-type">&nbsp;</span>
152 </td><td class="summary">
Takashi Matsuo06694102015-09-11 13:55:40 -0700153 <a name="DISCOVERY_DOC_MAX_AGE"></a><span class="summary-name">DISCOVERY_DOC_MAX_AGE</span> = <code title="60* 60* 24">60* 60* 24</code>
154 </td>
155 </tr>
156</table>
157<!-- ==================== FUNCTION DETAILS ==================== -->
158<a name="section-FunctionDetails"></a>
159<table class="details" border="1" cellpadding="3"
160 cellspacing="0" width="100%" bgcolor="white">
161<tr bgcolor="#70b0f0" class="table-header">
162 <td colspan="2" class="table-header">
163 <table border="0" cellpadding="0" cellspacing="0" width="100%">
164 <tr valign="top">
165 <td align="left"><span class="table-header">Function Details</span></td>
166 <td align="right" valign="top"
167 ><span class="options">[<a href="#section-FunctionDetails"
168 class="privatelink" onclick="toggle_private();"
169 >hide private</a>]</span></td>
170 </tr>
171 </table>
172 </td>
173</tr>
174</table>
175<a name="autodetect"></a>
176<div>
177<table class="details" border="1" cellpadding="3"
178 cellspacing="0" width="100%" bgcolor="white">
179<tr><td>
180 <table width="100%" cellpadding="0" cellspacing="0" border="0">
181 <tr valign="top"><td>
182 <h3 class="epydoc"><span class="sig"><span class="sig-name">autodetect</span>()</span>
183 </h3>
184 </td><td align="right" valign="top"
185 ><span class="codelink"><a href="googleapiclient.discovery_cache-pysrc.html#autodetect">source&nbsp;code</a></span>&nbsp;
186 </td>
187 </tr></table>
188
189 <pre class="literalblock">
190Detects an appropriate cache module and returns it.
191
192Returns:
193 googleapiclient.discovery_cache.base.Cache, a cache object which
194 is auto detected, or None if no cache object is available.
195
196</pre>
197 <dl class="fields">
198 </dl>
199</td></tr></table>
200</div>
201<br />
202<!-- ==================== NAVIGATION BAR ==================== -->
203<table class="navbar" border="0" width="100%" cellpadding="0"
204 bgcolor="#a0c0ff" cellspacing="0">
205 <tr valign="middle">
206 <!-- Home link -->
207 <th>&nbsp;&nbsp;&nbsp;<a
208 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
209
210 <!-- Tree link -->
211 <th>&nbsp;&nbsp;&nbsp;<a
212 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
213
214 <!-- Index link -->
215 <th>&nbsp;&nbsp;&nbsp;<a
216 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
217
218 <!-- Help link -->
219 <th>&nbsp;&nbsp;&nbsp;<a
220 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
221
222 <th class="navbar" width="100%"></th>
223 </tr>
224</table>
225<table border="0" cellpadding="0" cellspacing="0" width="100%%">
226 <tr>
227 <td align="left" class="footer">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800228 Generated by Epydoc 3.0.1 on Thu Jan 5 12:55:02 2017
Takashi Matsuo06694102015-09-11 13:55:40 -0700229 </td>
230 <td align="right" class="footer">
231 <a target="mainFrame" href="http://epydoc.sourceforge.net"
232 >http://epydoc.sourceforge.net</a>
233 </td>
234 </tr>
235</table>
236
237<script type="text/javascript">
238 <!--
239 // Private objects are initially displayed (because if
240 // javascript is turned off then we want them to be
241 // visible); but by default, we want to hide them. So hide
242 // them unless we have a cookie that says to show them.
243 checkCookie();
244 // -->
245</script>
246</body>
247</html>