Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a9407624e954e34bfd989f64ed0f5be74c40d4c5 / . / docs / epy / googleapiclient.discovery_cache.base.Cache-class.html
blob: a604c9546559c83d6a6972c6f477a0e5c4fe952d [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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.discovery_cache.base.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 <a href="googleapiclient.discovery_cache-module.html">Package&nbsp;discovery_cache</a> ::
42 <a href="googleapiclient.discovery_cache.base-module.html">Module&nbsp;base</a> ::
43 Class&nbsp;Cache
44 </span>
45 </td>
46 <td>
47 <table cellpadding="0" cellspacing="0">
48 <!-- hide/show private -->
49 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51 <tr><td align="right"><span class="options"
52 >[<a href="frames.html" target="_top">frames</a
53 >]&nbsp;|&nbsp;<a href="googleapiclient.discovery_cache.base.Cache-class.html"
54 target="_top">no&nbsp;frames</a>]</span></td></tr>
55 </table>
56 </td>
57 </tr>
58</table>
59<!-- ==================== CLASS DESCRIPTION ==================== -->
60<h1 class="epydoc">Class Cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache">source&nbsp;code</a></span></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]61<pre class="base-tree">
62object --+
63 |
64 <strong class="uidshort">Cache</strong>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]65</pre>
66
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]67<hr />
68<p>A base abstract cache class.</p>
69
70<!-- ==================== NESTED CLASSES ==================== -->
71<a name="section-NestedClasses"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Nested Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-NestedClasses"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 __metaclass__<br />
92 Metaclass for defining Abstract Base Classes (ABCs).
93 </td>
94 </tr>
95</table>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96<!-- ==================== INSTANCE METHODS ==================== -->
97<a name="section-InstanceMethods"></a>
98<table class="summary" border="1" cellpadding="3"
99 cellspacing="0" width="100%" bgcolor="white">
100<tr bgcolor="#70b0f0" class="table-header">
101 <td colspan="2" class="table-header">
102 <table border="0" cellpadding="0" cellspacing="0" width="100%">
103 <tr valign="top">
104 <td align="left"><span class="table-header">Instance Methods</span></td>
105 <td align="right" valign="top"
106 ><span class="options">[<a href="#section-InstanceMethods"
107 class="privatelink" onclick="toggle_private();"
108 >hide private</a>]</span></td>
109 </tr>
110 </table>
111 </td>
112</tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td><span class="summary-sig"><a href="googleapiclient.discovery_cache.base.Cache-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
120 <span class="summary-sig-arg">url</span>)</span><br />
121 Gets the content from the memcache with a given key.</td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.get">source&nbsp;code</a></span>
124
125 </td>
126 </tr>
127 </table>
128
129 </td>
130 </tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <td><span class="summary-sig"><a href="googleapiclient.discovery_cache.base.Cache-class.html#set" class="summary-sig-name">set</a>(<span class="summary-sig-arg">self</span>,
138 <span class="summary-sig-arg">url</span>,
139 <span class="summary-sig-arg">content</span>)</span><br />
140 Sets the given key and content in the cache.</td>
141 <td align="right" valign="top">
142 <span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.set">source&nbsp;code</a></span>
143
144 </td>
145 </tr>
146 </table>
147
148 </td>
149 </tr>
150 <tr>
151 <td colspan="2" class="summary">
152 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
153 <code>__delattr__</code>,
154 <code>__format__</code>,
155 <code>__getattribute__</code>,
156 <code>__hash__</code>,
157 <code>__init__</code>,
158 <code>__new__</code>,
159 <code>__reduce__</code>,
160 <code>__reduce_ex__</code>,
161 <code>__repr__</code>,
162 <code>__setattr__</code>,
163 <code>__sizeof__</code>,
164 <code>__str__</code>,
165 <code>__subclasshook__</code>
166 </p>
167 </td>
168 </tr>
169</table>
170<!-- ==================== CLASS VARIABLES ==================== -->
171<a name="section-ClassVariables"></a>
172<table class="summary" border="1" cellpadding="3"
173 cellspacing="0" width="100%" bgcolor="white">
174<tr bgcolor="#70b0f0" class="table-header">
175 <td colspan="2" class="table-header">
176 <table border="0" cellpadding="0" cellspacing="0" width="100%">
177 <tr valign="top">
178 <td align="left"><span class="table-header">Class Variables</span></td>
179 <td align="right" valign="top"
180 ><span class="options">[<a href="#section-ClassVariables"
181 class="privatelink" onclick="toggle_private();"
182 >hide private</a>]</span></td>
183 </tr>
184 </table>
185 </td>
186</tr>
187<tr>
188 <td width="15%" align="right" valign="top" class="summary">
189 <span class="summary-type">&nbsp;</span>
190 </td><td class="summary">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]191 <a name="__abstractmethods__"></a><span class="summary-name">__abstractmethods__</span> = <code title="frozenset(['get', 'set'])"><code class="variable-group">frozenset([</code><code class="variable-quote">'</code><code class="variable-string">get</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">set</code><code class="variable-quote">'</code><code class="variable-group">])</code></code>
192 </td>
193 </tr>
194<tr class="private">
195 <td width="15%" align="right" valign="top" class="summary">
196 <span class="summary-type">&nbsp;</span>
197 </td><td class="summary">
198 <a name="_abc_cache"></a><span class="summary-name">_abc_cache</span> = <code title="&lt;_weakrefset.WeakSet object at 0x7fb69e350450&gt;">&lt;_weakrefset.WeakSet object at 0x7fb69e350450&gt;</code>
199 </td>
200 </tr>
201<tr class="private">
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <a href="googleapiclient.discovery_cache.base.Cache-class.html#_abc_negative_cache" class="summary-name" onclick="show_private();">_abc_negative_cache</a> = <code title="&lt;_weakrefset.WeakSet object at 0x7fb69e350510&gt;">&lt;_weakrefset.WeakSet object at 0x7fb69e3<code class="variable-ellipsis">...</code></code>
206 </td>
207 </tr>
208<tr class="private">
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <a name="_abc_negative_cache_version"></a><span class="summary-name">_abc_negative_cache_version</span> = <code title="22">22</code>
213 </td>
214 </tr>
215<tr class="private">
216 <td width="15%" align="right" valign="top" class="summary">
217 <span class="summary-type">&nbsp;</span>
218 </td><td class="summary">
219 <a name="_abc_registry"></a><span class="summary-name">_abc_registry</span> = <code title="&lt;_weakrefset.WeakSet object at 0x7fb69e350490&gt;">&lt;_weakrefset.WeakSet object at 0x7fb69e350490&gt;</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]220 </td>
221 </tr>
222</table>
223<!-- ==================== PROPERTIES ==================== -->
224<a name="section-Properties"></a>
225<table class="summary" border="1" cellpadding="3"
226 cellspacing="0" width="100%" bgcolor="white">
227<tr bgcolor="#70b0f0" class="table-header">
228 <td colspan="2" class="table-header">
229 <table border="0" cellpadding="0" cellspacing="0" width="100%">
230 <tr valign="top">
231 <td align="left"><span class="table-header">Properties</span></td>
232 <td align="right" valign="top"
233 ><span class="options">[<a href="#section-Properties"
234 class="privatelink" onclick="toggle_private();"
235 >hide private</a>]</span></td>
236 </tr>
237 </table>
238 </td>
239</tr>
240 <tr>
241 <td colspan="2" class="summary">
242 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
243 <code>__class__</code>
244 </p>
245 </td>
246 </tr>
247</table>
248<!-- ==================== METHOD DETAILS ==================== -->
249<a name="section-MethodDetails"></a>
250<table class="details" border="1" cellpadding="3"
251 cellspacing="0" width="100%" bgcolor="white">
252<tr bgcolor="#70b0f0" class="table-header">
253 <td colspan="2" class="table-header">
254 <table border="0" cellpadding="0" cellspacing="0" width="100%">
255 <tr valign="top">
256 <td align="left"><span class="table-header">Method Details</span></td>
257 <td align="right" valign="top"
258 ><span class="options">[<a href="#section-MethodDetails"
259 class="privatelink" onclick="toggle_private();"
260 >hide private</a>]</span></td>
261 </tr>
262 </table>
263 </td>
264</tr>
265</table>
266<a name="get"></a>
267<div>
268<table class="details" border="1" cellpadding="3"
269 cellspacing="0" width="100%" bgcolor="white">
270<tr><td>
271 <table width="100%" cellpadding="0" cellspacing="0" border="0">
272 <tr valign="top"><td>
273 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
274 <span class="sig-arg">url</span>)</span>
275 </h3>
276 </td><td align="right" valign="top"
277 ><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.get">source&nbsp;code</a></span>&nbsp;
278 </td>
279 </tr></table>
280
281 <pre class="literalblock">
282Gets the content from the memcache with a given key.
283
284Args:
285 url: string, the key for the cache.
286
287Returns:
288 object, the value in the cache for the given key, or None if the key is
289 not in the cache.
290
291</pre>
292 <dl class="fields">
293 <dt>Decorators:</dt>
294 <dd><ul class="nomargin-top">
295 <li><code>@abc.abstractmethod</code></li>
296 </ul></dd>
297 </dl>
298</td></tr></table>
299</div>
300<a name="set"></a>
301<div>
302<table class="details" border="1" cellpadding="3"
303 cellspacing="0" width="100%" bgcolor="white">
304<tr><td>
305 <table width="100%" cellpadding="0" cellspacing="0" border="0">
306 <tr valign="top"><td>
307 <h3 class="epydoc"><span class="sig"><span class="sig-name">set</span>(<span class="sig-arg">self</span>,
308 <span class="sig-arg">url</span>,
309 <span class="sig-arg">content</span>)</span>
310 </h3>
311 </td><td align="right" valign="top"
312 ><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.set">source&nbsp;code</a></span>&nbsp;
313 </td>
314 </tr></table>
315
316 <pre class="literalblock">
317Sets the given key and content in the cache.
318
319Args:
320 url: string, the key for the cache.
321 content: string, the discovery document.
322
323</pre>
324 <dl class="fields">
325 <dt>Decorators:</dt>
326 <dd><ul class="nomargin-top">
327 <li><code>@abc.abstractmethod</code></li>
328 </ul></dd>
329 </dl>
330</td></tr></table>
331</div>
332<br />
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]333<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
334<a name="section-ClassVariableDetails"></a>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr bgcolor="#70b0f0" class="table-header">
338 <td colspan="2" class="table-header">
339 <table border="0" cellpadding="0" cellspacing="0" width="100%">
340 <tr valign="top">
341 <td align="left"><span class="table-header">Class Variable Details</span></td>
342 <td align="right" valign="top"
343 ><span class="options">[<a href="#section-ClassVariableDetails"
344 class="privatelink" onclick="toggle_private();"
345 >hide private</a>]</span></td>
346 </tr>
347 </table>
348 </td>
349</tr>
350</table>
351<a name="_abc_negative_cache"></a>
352<div class="private">
353<table class="details" border="1" cellpadding="3"
354 cellspacing="0" width="100%" bgcolor="white">
355<tr><td>
356 <h3 class="epydoc">_abc_negative_cache</h3>
357
358 <dl class="fields">
359 </dl>
360 <dl class="fields">
361 <dt>Value:</dt>
362 <dd><table><tr><td><pre class="variable">
363&lt;_weakrefset.WeakSet object at 0x7fb69e350510&gt;
364</pre></td></tr></table>
365</dd>
366 </dl>
367</td></tr></table>
368</div>
369<br />
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]370<!-- ==================== NAVIGATION BAR ==================== -->
371<table class="navbar" border="0" width="100%" cellpadding="0"
372 bgcolor="#a0c0ff" cellspacing="0">
373 <tr valign="middle">
374 <!-- Home link -->
375 <th>&nbsp;&nbsp;&nbsp;<a
376 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
377
378 <!-- Tree link -->
379 <th>&nbsp;&nbsp;&nbsp;<a
380 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
381
382 <!-- Index link -->
383 <th>&nbsp;&nbsp;&nbsp;<a
384 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
385
386 <!-- Help link -->
387 <th>&nbsp;&nbsp;&nbsp;<a
388 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
389
390 <th class="navbar" width="100%"></th>
391 </tr>
392</table>
393<table border="0" cellpadding="0" cellspacing="0" width="100%%">
394 <tr>
395 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]396 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]397 </td>
398 <td align="right" class="footer">
399 <a target="mainFrame" href="http://epydoc.sourceforge.net"
400 >http://epydoc.sourceforge.net</a>
401 </td>
402 </tr>
403</table>
404
405<script type="text/javascript">
406 <!--
407 // Private objects are initially displayed (because if
408 // javascript is turned off then we want them to be
409 // visible); but by default, we want to hide them. So hide
410 // them unless we have a cookie that says to show them.
411 checkCookie();
412 // -->
413</script>
414</body>
415</html>