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