Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / oauth2client.locked_file.LockedFile-class.html
blob: 1d1d322adf3f84bdb7c62c7ef90ea2405ea0b576 [file] [log] [blame]
Joe Gregorio66212032012-06-14 09:10:14 -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.locked_file.LockedFile</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 <a href="oauth2client.locked_file-module.html">Module&nbsp;locked_file</a> ::
39 Class&nbsp;LockedFile
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.locked_file.LockedFile-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class LockedFile</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_oauth2cl_44" name="uml_class_diagram_for_oauth2cl_44">
59<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#__init__" title="Construct a LockedFile." alt="" coords="17,39,441,57"/>
60<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#filename" title="Return the filename we were constructed with." alt="" coords="17,57,441,76"/>
61<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#file_handle" title="Return the file_handle to the opened file." alt="" coords="17,76,441,95"/>
62<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#is_locked" title="Return whether we successfully locked the file." alt="" coords="17,95,441,113"/>
63<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#open_and_lock" title="Open the file, trying to lock it." alt="" coords="17,113,441,132"/>
64<area shape="rect" id="node212" href="oauth2client.locked_file.LockedFile-class.html#unlock_and_close" title="Unlock and close a file." alt="" coords="17,132,441,151"/>
65<area shape="rect" id="node1" href="oauth2client.locked_file.LockedFile-class.html" title="Represent a file that has exclusive access." alt="" coords="5,6,453,157"/>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]66</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]67 <img src="uml_class_diagram_for_oauth2cl_44.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_44" ismap="ismap" class="graph-without-title" />
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]68</center>
69</center>
70<hr />
71<pre class="literalblock">
72Represent a file that has exclusive access.
73
74</pre>
75
76<!-- ==================== INSTANCE METHODS ==================== -->
77<a name="section-InstanceMethods"></a>
78<table class="summary" border="1" cellpadding="3"
79 cellspacing="0" width="100%" bgcolor="white">
80<tr bgcolor="#70b0f0" class="table-header">
81 <td colspan="2" class="table-header">
82 <table border="0" cellpadding="0" cellspacing="0" width="100%">
83 <tr valign="top">
84 <td align="left"><span class="table-header">Instance Methods</span></td>
85 <td align="right" valign="top"
86 ><span class="options">[<a href="#section-InstanceMethods"
87 class="privatelink" onclick="toggle_private();"
88 >hide private</a>]</span></td>
89 </tr>
90 </table>
91 </td>
92</tr>
93<tr>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type">&nbsp;</span>
96 </td><td class="summary">
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
98 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]99 <td><span class="summary-sig"><a href="oauth2client.locked_file.LockedFile-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
100 <span class="summary-sig-arg">filename</span>,
101 <span class="summary-sig-arg">mode</span>,
102 <span class="summary-sig-arg">fallback_mode</span>,
103 <span class="summary-sig-arg">use_native_locking</span>=<span class="summary-sig-default">True</span>)</span><br />
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]104 Construct a LockedFile.</td>
105 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]106 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.__init__">source&nbsp;code</a></span>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114<tr>
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a name="filename"></a><span class="summary-sig-name">filename</span>(<span class="summary-sig-arg">self</span>)</span><br />
121 Return the filename we were constructed with.</td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.filename">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 name="file_handle"></a><span class="summary-sig-name">file_handle</span>(<span class="summary-sig-arg">self</span>)</span><br />
138 Return the file_handle to the opened file.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.file_handle">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <td><span class="summary-sig"><a name="is_locked"></a><span class="summary-sig-name">is_locked</span>(<span class="summary-sig-arg">self</span>)</span><br />
155 Return whether we successfully locked the file.</td>
156 <td align="right" valign="top">
157 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.is_locked">source&nbsp;code</a></span>
158
159 </td>
160 </tr>
161 </table>
162
163 </td>
164 </tr>
165<tr>
166 <td width="15%" align="right" valign="top" class="summary">
167 <span class="summary-type">&nbsp;</span>
168 </td><td class="summary">
169 <table width="100%" cellpadding="0" cellspacing="0" border="0">
170 <tr>
171 <td><span class="summary-sig"><a href="oauth2client.locked_file.LockedFile-class.html#open_and_lock" class="summary-sig-name">open_and_lock</a>(<span class="summary-sig-arg">self</span>,
172 <span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">0</span>,
173 <span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">0.05</span>)</span><br />
174 Open the file, trying to lock it.</td>
175 <td align="right" valign="top">
176 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.open_and_lock">source&nbsp;code</a></span>
177
178 </td>
179 </tr>
180 </table>
181
182 </td>
183 </tr>
184<tr>
185 <td width="15%" align="right" valign="top" class="summary">
186 <span class="summary-type">&nbsp;</span>
187 </td><td class="summary">
188 <table width="100%" cellpadding="0" cellspacing="0" border="0">
189 <tr>
190 <td><span class="summary-sig"><a name="unlock_and_close"></a><span class="summary-sig-name">unlock_and_close</span>(<span class="summary-sig-arg">self</span>)</span><br />
191 Unlock and close a file.</td>
192 <td align="right" valign="top">
193 <span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.unlock_and_close">source&nbsp;code</a></span>
194
195 </td>
196 </tr>
197 </table>
198
199 </td>
200 </tr>
201 <tr>
202 <td colspan="2" class="summary">
203 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
204 <code>__delattr__</code>,
205 <code>__format__</code>,
206 <code>__getattribute__</code>,
207 <code>__hash__</code>,
208 <code>__new__</code>,
209 <code>__reduce__</code>,
210 <code>__reduce_ex__</code>,
211 <code>__repr__</code>,
212 <code>__setattr__</code>,
213 <code>__sizeof__</code>,
214 <code>__str__</code>,
215 <code>__subclasshook__</code>
216 </p>
217 </td>
218 </tr>
219</table>
220<!-- ==================== PROPERTIES ==================== -->
221<a name="section-Properties"></a>
222<table class="summary" border="1" cellpadding="3"
223 cellspacing="0" width="100%" bgcolor="white">
224<tr bgcolor="#70b0f0" class="table-header">
225 <td colspan="2" class="table-header">
226 <table border="0" cellpadding="0" cellspacing="0" width="100%">
227 <tr valign="top">
228 <td align="left"><span class="table-header">Properties</span></td>
229 <td align="right" valign="top"
230 ><span class="options">[<a href="#section-Properties"
231 class="privatelink" onclick="toggle_private();"
232 >hide private</a>]</span></td>
233 </tr>
234 </table>
235 </td>
236</tr>
237 <tr>
238 <td colspan="2" class="summary">
239 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
240 <code>__class__</code>
241 </p>
242 </td>
243 </tr>
244</table>
245<!-- ==================== METHOD DETAILS ==================== -->
246<a name="section-MethodDetails"></a>
247<table class="details" border="1" cellpadding="3"
248 cellspacing="0" width="100%" bgcolor="white">
249<tr bgcolor="#70b0f0" class="table-header">
250 <td colspan="2" class="table-header">
251 <table border="0" cellpadding="0" cellspacing="0" width="100%">
252 <tr valign="top">
253 <td align="left"><span class="table-header">Method Details</span></td>
254 <td align="right" valign="top"
255 ><span class="options">[<a href="#section-MethodDetails"
256 class="privatelink" onclick="toggle_private();"
257 >hide private</a>]</span></td>
258 </tr>
259 </table>
260 </td>
261</tr>
262</table>
263<a name="__init__"></a>
264<div>
265<table class="details" border="1" cellpadding="3"
266 cellspacing="0" width="100%" bgcolor="white">
267<tr><td>
268 <table width="100%" cellpadding="0" cellspacing="0" border="0">
269 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]270 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
271 <span class="sig-arg">filename</span>,
272 <span class="sig-arg">mode</span>,
273 <span class="sig-arg">fallback_mode</span>,
274 <span class="sig-arg">use_native_locking</span>=<span class="sig-default">True</span>)</span>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]275 <br /><em class="fname">(Constructor)</em>
276 </h3>
277 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]278 ><span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]279 </td>
280 </tr></table>
281
282 <pre class="literalblock">
283Construct a LockedFile.
284
285Args:
286 filename: string, The path of the file to open.
287 mode: string, The mode to try to open the file with.
288 fallback_mode: string, The mode to use if locking fails.
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame]289 use_native_locking: bool, Whether or not fcntl/win32 locking is used.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]290
291</pre>
292 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]293 <dt>Decorators:</dt>
294 <dd><ul class="nomargin-top">
295 <li><code>@util.positional(4)</code></li>
296 </ul></dd>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]297 <dt>Overrides:
298 object.__init__
299 </dt>
300 </dl>
301</td></tr></table>
302</div>
303<a name="open_and_lock"></a>
304<div>
305<table class="details" border="1" cellpadding="3"
306 cellspacing="0" width="100%" bgcolor="white">
307<tr><td>
308 <table width="100%" cellpadding="0" cellspacing="0" border="0">
309 <tr valign="top"><td>
310 <h3 class="epydoc"><span class="sig"><span class="sig-name">open_and_lock</span>(<span class="sig-arg">self</span>,
311 <span class="sig-arg">timeout</span>=<span class="sig-default">0</span>,
312 <span class="sig-arg">delay</span>=<span class="sig-default">0.05</span>)</span>
313 </h3>
314 </td><td align="right" valign="top"
315 ><span class="codelink"><a href="oauth2client.locked_file-pysrc.html#LockedFile.open_and_lock">source&nbsp;code</a></span>&nbsp;
316 </td>
317 </tr></table>
318
319 <pre class="literalblock">
320Open the file, trying to lock it.
321
322Args:
323 timeout: float, The number of seconds to try to acquire the lock.
324 delay: float, The number of seconds to wait between retry attempts.
325
326Raises:
327 AlreadyLockedException: if the lock is already acquired.
328 IOError: if the open fails.
329
330</pre>
331 <dl class="fields">
332 </dl>
333</td></tr></table>
334</div>
335<br />
336<!-- ==================== NAVIGATION BAR ==================== -->
337<table class="navbar" border="0" width="100%" cellpadding="0"
338 bgcolor="#a0c0ff" cellspacing="0">
339 <tr valign="middle">
340
341 <!-- Tree link -->
342 <th>&nbsp;&nbsp;&nbsp;<a
343 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
344
345 <!-- Index link -->
346 <th>&nbsp;&nbsp;&nbsp;<a
347 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
348
349 <!-- Help link -->
350 <th>&nbsp;&nbsp;&nbsp;<a
351 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
352
353 <th class="navbar" width="100%"></th>
354 </tr>
355</table>
356<table border="0" cellpadding="0" cellspacing="0" width="100%%">
357 <tr>
358 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]359 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:46 2013
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]360 </td>
361 <td align="right" class="footer">
362 <a target="mainFrame" href="http://epydoc.sourceforge.net"
363 >http://epydoc.sourceforge.net</a>
364 </td>
365 </tr>
366</table>
367
368<script type="text/javascript">
369 <!--
370 // Private objects are initially displayed (because if
371 // javascript is turned off then we want them to be
372 // visible); but by default, we want to hide them. So hide
373 // them unless we have a cookie that says to show them.
374 checkCookie();
375 // -->
376</script>
377</body>
378</html>