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