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.file_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        Module&nbsp;file_cache
43      </span>
44    </td>
45    <td>
46      <table cellpadding="0" cellspacing="0">
47        <!-- hide/show private -->
48        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50        <tr><td align="right"><span class="options"
51            >[<a href="frames.html" target="_top">frames</a
52            >]&nbsp;|&nbsp;<a href="googleapiclient.discovery_cache.file_cache-module.html"
53            target="_top">no&nbsp;frames</a>]</span></td></tr>
54      </table>
55    </td>
56  </tr>
57</table>
58<!-- ==================== MODULE DESCRIPTION ==================== -->
59<h1 class="epydoc">Module file_cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.file_cache-pysrc.html">source&nbsp;code</a></span></p>
60<p>File based cache for the discovery document.</p>
61  <p>The cache is stored in a single file so that multiple processes can
62  share the same cache. It locks the file whenever accesing to the file.
63  When the cache content is corrupted, it will be initialized with an empty
64  cache.</p>
65
66<!-- ==================== CLASSES ==================== -->
67<a name="section-Classes"></a>
68<table class="summary" border="1" cellpadding="3"
69       cellspacing="0" width="100%" bgcolor="white">
70<tr bgcolor="#70b0f0" class="table-header">
71  <td colspan="2" class="table-header">
72    <table border="0" cellpadding="0" cellspacing="0" width="100%">
73      <tr valign="top">
74        <td align="left"><span class="table-header">Classes</span></td>
75        <td align="right" valign="top"
76         ><span class="options">[<a href="#section-Classes"
77         class="privatelink" onclick="toggle_private();"
78         >hide private</a>]</span></td>
79      </tr>
80    </table>
81  </td>
82</tr>
83<tr>
84    <td width="15%" align="right" valign="top" class="summary">
85      <span class="summary-type">&nbsp;</span>
86    </td><td class="summary">
87        <a href="googleapiclient.discovery_cache.file_cache.Cache-class.html" class="summary-name">Cache</a><br />
88      A file based cache for the discovery documents.
89    </td>
90  </tr>
91</table>
92<!-- ==================== FUNCTIONS ==================== -->
93<a name="section-Functions"></a>
94<table class="summary" border="1" cellpadding="3"
95       cellspacing="0" width="100%" bgcolor="white">
96<tr bgcolor="#70b0f0" class="table-header">
97  <td colspan="2" class="table-header">
98    <table border="0" cellpadding="0" cellspacing="0" width="100%">
99      <tr valign="top">
100        <td align="left"><span class="table-header">Functions</span></td>
101        <td align="right" valign="top"
102         ><span class="options">[<a href="#section-Functions"
103         class="privatelink" onclick="toggle_private();"
104         >hide private</a>]</span></td>
105      </tr>
106    </table>
107  </td>
108</tr>
109<tr class="private">
110    <td width="15%" align="right" valign="top" class="summary">
111      <span class="summary-type">&nbsp;</span>
112    </td><td class="summary">
113      <table width="100%" cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td><span class="summary-sig"><a name="_to_timestamp"></a><span class="summary-sig-name">_to_timestamp</span>(<span class="summary-sig-arg">date</span>)</span></td>
116          <td align="right" valign="top">
117            <span class="codelink"><a href="googleapiclient.discovery_cache.file_cache-pysrc.html#_to_timestamp">source&nbsp;code</a></span>
118
119          </td>
120        </tr>
121      </table>
122
123    </td>
124  </tr>
125<tr class="private">
126    <td width="15%" align="right" valign="top" class="summary">
127      <span class="summary-type">&nbsp;</span>
128    </td><td class="summary">
129      <table width="100%" cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td><span class="summary-sig"><a name="_read_or_initialize_cache"></a><span class="summary-sig-name">_read_or_initialize_cache</span>(<span class="summary-sig-arg">f</span>)</span></td>
132          <td align="right" valign="top">
133            <span class="codelink"><a href="googleapiclient.discovery_cache.file_cache-pysrc.html#_read_or_initialize_cache">source&nbsp;code</a></span>
134
135          </td>
136        </tr>
137      </table>
138
139    </td>
140  </tr>
141</table>
142<!-- ==================== VARIABLES ==================== -->
143<a name="section-Variables"></a>
144<table class="summary" border="1" cellpadding="3"
145       cellspacing="0" width="100%" bgcolor="white">
146<tr bgcolor="#70b0f0" class="table-header">
147  <td colspan="2" class="table-header">
148    <table border="0" cellpadding="0" cellspacing="0" width="100%">
149      <tr valign="top">
150        <td align="left"><span class="table-header">Variables</span></td>
151        <td align="right" valign="top"
152         ><span class="options">[<a href="#section-Variables"
153         class="privatelink" onclick="toggle_private();"
154         >hide private</a>]</span></td>
155      </tr>
156    </table>
157  </td>
158</tr>
159<tr>
160    <td width="15%" align="right" valign="top" class="summary">
161      <span class="summary-type">&nbsp;</span>
162    </td><td class="summary">
163        <a name="LOGGER"></a><span class="summary-name">LOGGER</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
164    </td>
165  </tr>
166<tr>
167    <td width="15%" align="right" valign="top" class="summary">
168      <span class="summary-type">&nbsp;</span>
169    </td><td class="summary">
170        <a name="FILENAME"></a><span class="summary-name">FILENAME</span> = <code title="&quot;google-api-python-client-discovery-doc.cache&quot;">&quot;google-api-python-client-discovery-doc.cache&quot;</code>
171    </td>
172  </tr>
173<tr>
174    <td width="15%" align="right" valign="top" class="summary">
175      <span class="summary-type">&nbsp;</span>
176    </td><td class="summary">
177        <a name="EPOCH"></a><span class="summary-name">EPOCH</span> = <code title="datetime.datetime.utcfromtimestamp(0)">datetime.datetime.utcfromtimestamp(0)</code>
178    </td>
179  </tr>
180<tr>
181    <td width="15%" align="right" valign="top" class="summary">
182      <span class="summary-type">&nbsp;</span>
183    </td><td class="summary">
184        <a name="cache"></a><span class="summary-name">cache</span> = <code title="Cache(max_age= DISCOVERY_DOC_MAX_AGE)">Cache(max_age= DISCOVERY_DOC_MAX_AGE)</code>
185    </td>
186  </tr>
187</table>
188<!-- ==================== NAVIGATION BAR ==================== -->
189<table class="navbar" border="0" width="100%" cellpadding="0"
190       bgcolor="#a0c0ff" cellspacing="0">
191  <tr valign="middle">
192  <!-- Home link -->
193      <th>&nbsp;&nbsp;&nbsp;<a
194        href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
195
196  <!-- Tree link -->
197      <th>&nbsp;&nbsp;&nbsp;<a
198        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
199
200  <!-- Index link -->
201      <th>&nbsp;&nbsp;&nbsp;<a
202        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
203
204  <!-- Help link -->
205      <th>&nbsp;&nbsp;&nbsp;<a
206        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
207
208      <th class="navbar" width="100%"></th>
209  </tr>
210</table>
211<table border="0" cellpadding="0" cellspacing="0" width="100%%">
212  <tr>
213    <td align="left" class="footer">
214    Generated by Epydoc 3.0.1 on Fri Oct  2 20:46:22 2020
215    </td>
216    <td align="right" class="footer">
217      <a target="mainFrame" href="http://epydoc.sourceforge.net"
218        >http://epydoc.sourceforge.net</a>
219    </td>
220  </tr>
221</table>
222
223<script type="text/javascript">
224  <!--
225  // Private objects are initially displayed (because if
226  // javascript is turned off then we want them to be
227  // visible); but by default, we want to hide them.  So hide
228  // them unless we have a cookie that says to show them.
229  checkCookie();
230  // -->
231</script>
232</body>
233</html>
234