Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0cd347ab3554116339fa7408f783518885727375 / . / docs / epy / oauth2client.locked_file-pysrc.html
blob: 7c7a65bd77d80c7b3d59c6574d6678db68a2c827 [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</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 Module&nbsp;locked_file
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.locked_file-pysrc.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<h1 class="epydoc">Source Code for <a href="oauth2client.locked_file-module.html">Module oauth2client.locked_file</a></h1>
55<pre class="py-src">
56<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Copyright 2011 Google Inc. All Rights Reserved.</tt> </tt>
57<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"> </tt>
58<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-docstring">"""Locked file interface that should work on Unix and Windows pythons.</tt> </tt>
59<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
60<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring">This module first tries to use fcntl locking to ensure serialized access</tt> </tt>
61<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring">to a file, then falls back on a lock file if that is unavialable.</tt> </tt>
62<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
63<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring">Usage:</tt> </tt>
64<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> f = LockedFile('filename', 'r+b', 'rb')</tt> </tt>
65<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring"> f.open_and_lock()</tt> </tt>
66<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring"> if f.is_locked():</tt> </tt>
67<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring"> print 'Acquired filename with r+b mode'</tt> </tt>
68<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring"> f.file_handle().write('locked data')</tt> </tt>
69<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring"> else:</tt> </tt>
70<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring"> print 'Aquired filename with rb mode'</tt> </tt>
71<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring"> f.unlock_and_close()</tt> </tt>
72<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
73<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"> </tt>
74<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'cache@google.com (David T McWherter)'</tt> </tt>
75<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"> </tt>
76<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">errno</tt> </tt>
77<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
78<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt>
79<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">time</tt> </tt>
80<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]81<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package oauth2client=oauth2client-module.html"><a title="oauth2client" class="py-name" href="#" onclick="return doclink('link-0', 'oauth2client', 'link-0');">oauth2client</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Module oauth2client.util=oauth2client.util-module.html"><a title="oauth2client.util" class="py-name" href="#" onclick="return doclink('link-1', 'util', 'link-1');">util</a></tt> </tt>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]82<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]83<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt id="link-2" class="py-name" targets="Variable apiclient.discovery.logger=apiclient.discovery-module.html#logger,Variable oauth2client.appengine.logger=oauth2client.appengine-module.html#logger,Variable oauth2client.client.logger=oauth2client.client-module.html#logger,Variable oauth2client.crypt.logger=oauth2client.crypt-module.html#logger,Variable oauth2client.gce.logger=oauth2client.gce-module.html#logger,Variable oauth2client.locked_file.logger=oauth2client.locked_file-module.html#logger,Variable oauth2client.multistore_file.logger=oauth2client.multistore_file-module.html#logger,Variable oauth2client.util.logger=oauth2client.util-module.html#logger"><a title="apiclient.discovery.logger
84oauth2client.appengine.logger
85oauth2client.client.logger
86oauth2client.crypt.logger
87oauth2client.gce.logger
88oauth2client.locked_file.logger
89oauth2client.multistore_file.logger
90oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-2', 'logger', 'link-2');">logger</a></tt> <tt class="py-op">=</tt> <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">getLogger</tt><tt class="py-op">(</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]91<a name="CredentialsFileSymbolicLinkError"></a><div id="CredentialsFileSymbolicLinkError-def"><a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]92<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]93<a name="L31"></a><tt class="py-lineno"> 31</tt> <a class="py-toggle" href="#" id="CredentialsFileSymbolicLinkError-toggle" onclick="return toggle('CredentialsFileSymbolicLinkError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file.CredentialsFileSymbolicLinkError-class.html">CredentialsFileSymbolicLinkError</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
94</div><div id="CredentialsFileSymbolicLinkError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="CredentialsFileSymbolicLinkError-expanded"><a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> <tt class="py-docstring">"""Credentials files must not be symbolic links."""</tt> </tt>
95</div><a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> </tt>
96<a name="AlreadyLockedException"></a><div id="AlreadyLockedException-def"><a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"> </tt>
97<a name="L35"></a><tt class="py-lineno"> 35</tt> <a class="py-toggle" href="#" id="AlreadyLockedException-toggle" onclick="return toggle('AlreadyLockedException');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file.AlreadyLockedException-class.html">AlreadyLockedException</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
98</div><div id="AlreadyLockedException-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="AlreadyLockedException-expanded"><a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> <tt class="py-docstring">"""Trying to lock a file that has already been locked by the LockedFile."""</tt> </tt>
99<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
100</div><a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> </tt>
101<a name="validate_file"></a><div id="validate_file-def"><a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> </tt>
102<a name="L40"></a><tt class="py-lineno"> 40</tt> <a class="py-toggle" href="#" id="validate_file-toggle" onclick="return toggle('validate_file');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file-module.html#validate_file">validate_file</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
103</div><div id="validate_file-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="validate_file-expanded"><a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">path</tt><tt class="py-op">.</tt><tt class="py-name">islink</tt><tt class="py-op">(</tt><tt id="link-3" class="py-name" targets="Method oauth2client.locked_file.LockedFile.filename()=oauth2client.locked_file.LockedFile-class.html#filename,Method oauth2client.locked_file._Opener.filename()=oauth2client.locked_file._Opener-class.html#filename"><a title="oauth2client.locked_file.LockedFile.filename
104oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-3', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
105<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-4" class="py-name" targets="Class oauth2client.file.CredentialsFileSymbolicLinkError=oauth2client.file.CredentialsFileSymbolicLinkError-class.html,Class oauth2client.locked_file.CredentialsFileSymbolicLinkError=oauth2client.locked_file.CredentialsFileSymbolicLinkError-class.html"><a title="oauth2client.file.CredentialsFileSymbolicLinkError
106oauth2client.locked_file.CredentialsFileSymbolicLinkError" class="py-name" href="#" onclick="return doclink('link-4', 'CredentialsFileSymbolicLinkError', 'link-4');">CredentialsFileSymbolicLinkError</a></tt><tt class="py-op">(</tt> </tt>
107<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-string">'File: %s is a symbolic link.'</tt> <tt class="py-op">%</tt> <tt id="link-5" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
108oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-5', 'filename', 'link-3');">filename</a></tt><tt class="py-op">)</tt> </tt>
109</div><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> </tt>
110<a name="_Opener"></a><div id="_Opener-def"><a name="L45"></a><tt class="py-lineno"> 45</tt> <a class="py-toggle" href="#" id="_Opener-toggle" onclick="return toggle('_Opener');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html">_Opener</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
111</div><div id="_Opener-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_Opener-expanded"><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> <tt class="py-docstring">"""Base class for different locking primitives."""</tt> </tt>
112<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> </tt>
113<a name="_Opener.__init__"></a><div id="_Opener.__init__-def"><a name="L48"></a><tt class="py-lineno"> 48</tt> <a class="py-toggle" href="#" id="_Opener.__init__-toggle" onclick="return toggle('_Opener.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">mode</tt><tt class="py-op">,</tt> <tt class="py-param">fallback_mode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
114</div><div id="_Opener.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.__init__-expanded"><a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-docstring">"""Create an Opener.</tt> </tt>
115<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
116<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
117<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, The pathname of the file.</tt> </tt>
118<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> mode: string, The preferred mode to access the file with.</tt> </tt>
119<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> fallback_mode: string, The mode to use if locking fails.</tt> </tt>
120<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
121<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
122<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> <tt class="py-op">=</tt> <tt id="link-6" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
123oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-6', 'filename', 'link-3');">filename</a></tt> </tt>
124<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mode</tt> <tt class="py-op">=</tt> <tt class="py-name">mode</tt> </tt>
125<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt> <tt class="py-op">=</tt> <tt class="py-name">fallback_mode</tt> </tt>
126<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
127</div><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> </tt>
128<a name="_Opener.is_locked"></a><div id="_Opener.is_locked-def"><a name="L62"></a><tt class="py-lineno"> 62</tt> <a class="py-toggle" href="#" id="_Opener.is_locked-toggle" onclick="return toggle('_Opener.is_locked');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#is_locked">is_locked</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
129</div><div id="_Opener.is_locked-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.is_locked-expanded"><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> <tt class="py-docstring">"""Was the file locked."""</tt> </tt>
130<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> </tt>
131</div><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> </tt>
132<a name="_Opener.file_handle"></a><div id="_Opener.file_handle-def"><a name="L66"></a><tt class="py-lineno"> 66</tt> <a class="py-toggle" href="#" id="_Opener.file_handle-toggle" onclick="return toggle('_Opener.file_handle');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#file_handle">file_handle</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
133</div><div id="_Opener.file_handle-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.file_handle-expanded"><a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-docstring">"""The file handle to the file. Valid only after opened."""</tt> </tt>
134<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> </tt>
135</div><a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> </tt>
136<a name="_Opener.filename"></a><div id="_Opener.filename-def"><a name="L70"></a><tt class="py-lineno"> 70</tt> <a class="py-toggle" href="#" id="_Opener.filename-toggle" onclick="return toggle('_Opener.filename');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#filename">filename</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
137</div><div id="_Opener.filename-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.filename-expanded"><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-docstring">"""The filename that is being locked."""</tt> </tt>
138<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]139</div><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]140<a name="_Opener.open_and_lock"></a><div id="_Opener.open_and_lock-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="_Opener.open_and_lock-toggle" onclick="return toggle('_Opener.open_and_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#open_and_lock">open_and_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout</tt><tt class="py-op">,</tt> <tt class="py-param">delay</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
141</div><div id="_Opener.open_and_lock-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.open_and_lock-expanded"><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-docstring">"""Open the file and lock it.</tt> </tt>
142<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
143<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
144<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> timeout: float, How long to try to lock for.</tt> </tt>
145<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> delay: float, How long to wait between retries.</tt> </tt>
146<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
147<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
148</div><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> </tt>
149<a name="_Opener.unlock_and_close"></a><div id="_Opener.unlock_and_close-def"><a name="L83"></a><tt class="py-lineno"> 83</tt> <a class="py-toggle" href="#" id="_Opener.unlock_and_close-toggle" onclick="return toggle('_Opener.unlock_and_close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Opener-class.html#unlock_and_close">unlock_and_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
150</div><div id="_Opener.unlock_and_close-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Opener.unlock_and_close-expanded"><a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-docstring">"""Unlock and close the file."""</tt> </tt>
151<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt>
152</div></div><a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt>
153<a name="_PosixOpener"></a><div id="_PosixOpener-def"><a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> </tt>
154<a name="L88"></a><tt class="py-lineno"> 88</tt> <a class="py-toggle" href="#" id="_PosixOpener-toggle" onclick="return toggle('_PosixOpener');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file._PosixOpener-class.html">_PosixOpener</a><tt class="py-op">(</tt><tt class="py-base-class">_Opener</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
155</div><div id="_PosixOpener-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_PosixOpener-expanded"><a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-docstring">"""Lock files using Posix advisory lock files."""</tt> </tt>
156<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt>
157<a name="_PosixOpener.open_and_lock"></a><div id="_PosixOpener.open_and_lock-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="_PosixOpener.open_and_lock-toggle" onclick="return toggle('_PosixOpener.open_and_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._PosixOpener-class.html#open_and_lock">open_and_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout</tt><tt class="py-op">,</tt> <tt class="py-param">delay</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
158</div><div id="_PosixOpener.open_and_lock-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_PosixOpener.open_and_lock-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-docstring">"""Open the file and lock it.</tt> </tt>
159<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
160<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> Tries to create a .lock file next to the file we're trying to open.</tt> </tt>
161<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
162<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
163<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> timeout: float, How long to try to lock for.</tt> </tt>
164<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> delay: float, How long to wait between retries.</tt> </tt>
165<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
166<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
167<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> AlreadyLockedException: if the lock is already acquired.</tt> </tt>
168<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> IOError: if the open fails.</tt> </tt>
169<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> CredentialsFileSymbolicLinkError if the file is a symbolic link.</tt> </tt>
170<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
171<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
172<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-7" class="py-name" targets="Class oauth2client.locked_file.AlreadyLockedException=oauth2client.locked_file.AlreadyLockedException-class.html"><a title="oauth2client.locked_file.AlreadyLockedException" class="py-name" href="#" onclick="return doclink('link-7', 'AlreadyLockedException', 'link-7');">AlreadyLockedException</a></tt><tt class="py-op">(</tt><tt class="py-string">'File %s is already locked'</tt> <tt class="py-op">%</tt> </tt>
173<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
174<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
175<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> </tt>
176<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt id="link-8" class="py-name" targets="Function oauth2client.locked_file.validate_file()=oauth2client.locked_file-module.html#validate_file"><a title="oauth2client.locked_file.validate_file" class="py-name" href="#" onclick="return doclink('link-8', 'validate_file', 'link-8');">validate_file</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
177<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
178<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mode</tt><tt class="py-op">)</tt> </tt>
179<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
180<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-comment"># If we can't access with _mode, try _fallback_mode and don't lock.</tt> </tt>
181<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">errno</tt> <tt class="py-op">==</tt> <tt class="py-name">errno</tt><tt class="py-op">.</tt><tt class="py-name">EACCES</tt><tt class="py-op">:</tt> </tt>
182<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
183<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
184<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> </tt>
185<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> <tt class="py-name">lock_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method oauth2client.locked_file._PosixOpener._posix_lockfile()=oauth2client.locked_file._PosixOpener-class.html#_posix_lockfile"><a title="oauth2client.locked_file._PosixOpener._posix_lockfile" class="py-name" href="#" onclick="return doclink('link-9', '_posix_lockfile', 'link-9');">_posix_lockfile</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
186<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"> <tt class="py-name">start_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
187<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
188<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
189<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_lock_fd</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">lock_filename</tt><tt class="py-op">,</tt> </tt>
190<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">O_CREAT</tt><tt class="py-op">|</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">O_EXCL</tt><tt class="py-op">|</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">O_RDWR</tt><tt class="py-op">)</tt> </tt>
191<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
192<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt class="py-keyword">break</tt> </tt>
193<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> </tt>
194<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">OSError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
195<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">errno</tt> <tt class="py-op">!=</tt> <tt class="py-name">errno</tt><tt class="py-op">.</tt><tt class="py-name">EEXIST</tt><tt class="py-op">:</tt> </tt>
196<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
197<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">start_time</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">timeout</tt><tt class="py-op">:</tt> </tt>
198<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt id="link-10" class="py-name"><a title="apiclient.discovery.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]199oauth2client.appengine.logger
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]200oauth2client.client.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]201oauth2client.crypt.logger
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]202oauth2client.gce.logger
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]203oauth2client.locked_file.logger
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]204oauth2client.multistore_file.logger
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]205oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-10', 'logger', 'link-2');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Could not acquire lock %s in %s seconds'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
206<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-name">lock_filename</tt><tt class="py-op">,</tt> <tt class="py-name">timeout</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
207<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> <tt class="py-comment"># Close the file and open in fallback_mode.</tt> </tt>
208<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
209<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
210<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
211<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
212<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-name">delay</tt><tt class="py-op">)</tt> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]213</div><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]214<a name="_PosixOpener.unlock_and_close"></a><div id="_PosixOpener.unlock_and_close-def"><a name="L141"></a><tt class="py-lineno">141</tt> <a class="py-toggle" href="#" id="_PosixOpener.unlock_and_close-toggle" onclick="return toggle('_PosixOpener.unlock_and_close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._PosixOpener-class.html#unlock_and_close">unlock_and_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
215</div><div id="_PosixOpener.unlock_and_close-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_PosixOpener.unlock_and_close-expanded"><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-docstring">"""Unlock a file by removing the .lock file, and close the handle."""</tt> </tt>
216<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
217<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-name">lock_filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="oauth2client.locked_file._PosixOpener._posix_lockfile" class="py-name" href="#" onclick="return doclink('link-11', '_posix_lockfile', 'link-9');">_posix_lockfile</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
218<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">unlink</tt><tt class="py-op">(</tt><tt class="py-name">lock_filename</tt><tt class="py-op">)</tt> </tt>
219<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_lock_fd</tt><tt class="py-op">)</tt> </tt>
220<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
221<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_lock_fd</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
222<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
223<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
224</div><a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> </tt>
225<a name="_PosixOpener._posix_lockfile"></a><div id="_PosixOpener._posix_lockfile-def"><a name="L152"></a><tt class="py-lineno">152</tt> <a class="py-toggle" href="#" id="_PosixOpener._posix_lockfile-toggle" onclick="return toggle('_PosixOpener._posix_lockfile');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._PosixOpener-class.html#_posix_lockfile">_posix_lockfile</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
226</div><div id="_PosixOpener._posix_lockfile-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_PosixOpener._posix_lockfile-expanded"><a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-docstring">"""The name of the lock file to use for posix locking."""</tt> </tt>
227<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s.lock'</tt> <tt class="py-op">%</tt> <tt id="link-12" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
228oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-12', 'filename', 'link-3');">filename</a></tt> </tt>
229</div></div><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> </tt>
230<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> </tt>
231<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
232<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">fcntl</tt> </tt>
233<a name="_FcntlOpener"></a><div id="_FcntlOpener-def"><a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> </tt>
234<a name="L160"></a><tt class="py-lineno">160</tt> <a class="py-toggle" href="#" id="_FcntlOpener-toggle" onclick="return toggle('_FcntlOpener');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file._FcntlOpener-class.html">_FcntlOpener</a><tt class="py-op">(</tt><tt class="py-base-class">_Opener</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
235</div><div id="_FcntlOpener-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_FcntlOpener-expanded"><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-docstring">"""Open, lock, and unlock a file using fcntl.lockf."""</tt> </tt>
236<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> </tt>
237<a name="_FcntlOpener.open_and_lock"></a><div id="_FcntlOpener.open_and_lock-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="_FcntlOpener.open_and_lock-toggle" onclick="return toggle('_FcntlOpener.open_and_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._FcntlOpener-class.html#open_and_lock">open_and_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout</tt><tt class="py-op">,</tt> <tt class="py-param">delay</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
238</div><div id="_FcntlOpener.open_and_lock-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_FcntlOpener.open_and_lock-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-docstring">"""Open the file and lock it.</tt> </tt>
239<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
240<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
241<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> timeout: float, How long to try to lock for.</tt> </tt>
242<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> delay: float, How long to wait between retries</tt> </tt>
243<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
244<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
245<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> AlreadyLockedException: if the lock is already acquired.</tt> </tt>
246<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> IOError: if the open fails.</tt> </tt>
247<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> CredentialsFileSymbolicLinkError if the file is a symbolic link.</tt> </tt>
248<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
249<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
250<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-13" class="py-name"><a title="oauth2client.locked_file.AlreadyLockedException" class="py-name" href="#" onclick="return doclink('link-13', 'AlreadyLockedException', 'link-7');">AlreadyLockedException</a></tt><tt class="py-op">(</tt><tt class="py-string">'File %s is already locked'</tt> <tt class="py-op">%</tt> </tt>
251<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
252<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-name">start_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
253<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> </tt>
254<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt id="link-14" class="py-name"><a title="oauth2client.locked_file.validate_file" class="py-name" href="#" onclick="return doclink('link-14', 'validate_file', 'link-8');">validate_file</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
255<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
256<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mode</tt><tt class="py-op">)</tt> </tt>
257<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
258<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt class="py-comment"># If we can't access with _mode, try _fallback_mode and don't lock.</tt> </tt>
259<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">errno</tt> <tt class="py-op">==</tt> <tt class="py-name">errno</tt><tt class="py-op">.</tt><tt class="py-name">EACCES</tt><tt class="py-op">:</tt> </tt>
260<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
261<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
262<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> </tt>
263<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-comment"># We opened in _mode, try to lock the file.</tt> </tt>
264<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
265<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
266<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-name">fcntl</tt><tt class="py-op">.</tt><tt class="py-name">lockf</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">fcntl</tt><tt class="py-op">.</tt><tt class="py-name">LOCK_EX</tt><tt class="py-op">)</tt> </tt>
267<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
268<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
269<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
270<a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-comment"># If not retrying, then just pass on the error.</tt> </tt>
271<a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">timeout</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
272<a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
273<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">errno</tt> <tt class="py-op">!=</tt> <tt class="py-name">errno</tt><tt class="py-op">.</tt><tt class="py-name">EACCES</tt><tt class="py-op">:</tt> </tt>
274<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
275<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-comment"># We could not acquire the lock. Try again.</tt> </tt>
276<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">start_time</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">timeout</tt><tt class="py-op">:</tt> </tt>
277<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt id="link-15" class="py-name"><a title="apiclient.discovery.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]278oauth2client.appengine.logger
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]279oauth2client.client.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]280oauth2client.crypt.logger
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]281oauth2client.gce.logger
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]282oauth2client.locked_file.logger
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]283oauth2client.multistore_file.logger
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]284oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-15', 'logger', 'link-2');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Could not lock %s in %s seconds'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
285<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">timeout</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
286<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
287<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
288<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
289<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
290<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-name">delay</tt><tt class="py-op">)</tt> </tt>
291</div><a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> </tt>
292<a name="_FcntlOpener.unlock_and_close"></a><div id="_FcntlOpener.unlock_and_close-def"><a name="L211"></a><tt class="py-lineno">211</tt> <a class="py-toggle" href="#" id="_FcntlOpener.unlock_and_close-toggle" onclick="return toggle('_FcntlOpener.unlock_and_close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._FcntlOpener-class.html#unlock_and_close">unlock_and_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
293</div><div id="_FcntlOpener.unlock_and_close-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_FcntlOpener.unlock_and_close-expanded"><a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> <tt class="py-docstring">"""Close and unlock the file using the fcntl.lockf primitive."""</tt> </tt>
294<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
295<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-name">fcntl</tt><tt class="py-op">.</tt><tt class="py-name">lockf</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">fcntl</tt><tt class="py-op">.</tt><tt class="py-name">LOCK_UN</tt><tt class="py-op">)</tt> </tt>
296<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
297<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
298<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
299</div></div><a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
300<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt id="link-16" class="py-name" targets="Class oauth2client.locked_file._FcntlOpener=oauth2client.locked_file._FcntlOpener-class.html"><a title="oauth2client.locked_file._FcntlOpener" class="py-name" href="#" onclick="return doclink('link-16', '_FcntlOpener', 'link-16');">_FcntlOpener</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]301<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]302<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> </tt>
303<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"><tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
304<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">pywintypes</tt> </tt>
305<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">win32con</tt> </tt>
306<a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-keyword">import</tt> <tt class="py-name">win32file</tt> </tt>
307<a name="_Win32Opener"></a><div id="_Win32Opener-def"><a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"> </tt>
308<a name="L227"></a><tt class="py-lineno">227</tt> <a class="py-toggle" href="#" id="_Win32Opener-toggle" onclick="return toggle('_Win32Opener');">-</a><tt class="py-line"> <tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file._Win32Opener-class.html">_Win32Opener</a><tt class="py-op">(</tt><tt class="py-base-class">_Opener</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
309</div><div id="_Win32Opener-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="_Win32Opener-expanded"><a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-docstring">"""Open, lock, and unlock a file using windows primitives."""</tt> </tt>
310<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> </tt>
311<a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> <tt class="py-comment"># Error #33:</tt> </tt>
312<a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"> <tt class="py-comment"># 'The process cannot access the file because another process'</tt> </tt>
313<a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-name">FILE_IN_USE_ERROR</tt> <tt class="py-op">=</tt> <tt class="py-number">33</tt> </tt>
314<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"> </tt>
315<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"> <tt class="py-comment"># Error #158:</tt> </tt>
316<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"> <tt class="py-comment"># 'The segment is already unlocked.'</tt> </tt>
317<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"> <tt class="py-name">FILE_ALREADY_UNLOCKED_ERROR</tt> <tt class="py-op">=</tt> <tt class="py-number">158</tt> </tt>
318<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> </tt>
319<a name="_Win32Opener.open_and_lock"></a><div id="_Win32Opener.open_and_lock-def"><a name="L238"></a><tt class="py-lineno">238</tt> <a class="py-toggle" href="#" id="_Win32Opener.open_and_lock-toggle" onclick="return toggle('_Win32Opener.open_and_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Win32Opener-class.html#open_and_lock">open_and_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout</tt><tt class="py-op">,</tt> <tt class="py-param">delay</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
320</div><div id="_Win32Opener.open_and_lock-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_Win32Opener.open_and_lock-expanded"><a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-docstring">"""Open the file and lock it.</tt> </tt>
321<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
322<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
323<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"><tt class="py-docstring"> timeout: float, How long to try to lock for.</tt> </tt>
324<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"><tt class="py-docstring"> delay: float, How long to wait between retries</tt> </tt>
325<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
326<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
327<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"><tt class="py-docstring"> AlreadyLockedException: if the lock is already acquired.</tt> </tt>
328<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"><tt class="py-docstring"> IOError: if the open fails.</tt> </tt>
329<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"><tt class="py-docstring"> CredentialsFileSymbolicLinkError if the file is a symbolic link.</tt> </tt>
330<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
331<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
332<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-17" class="py-name"><a title="oauth2client.locked_file.AlreadyLockedException" class="py-name" href="#" onclick="return doclink('link-17', 'AlreadyLockedException', 'link-7');">AlreadyLockedException</a></tt><tt class="py-op">(</tt><tt class="py-string">'File %s is already locked'</tt> <tt class="py-op">%</tt> </tt>
333<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
334<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-name">start_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
335<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> </tt>
336<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt id="link-18" class="py-name"><a title="oauth2client.locked_file.validate_file" class="py-name" href="#" onclick="return doclink('link-18', 'validate_file', 'link-8');">validate_file</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">)</tt> </tt>
337<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
338<a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_mode</tt><tt class="py-op">)</tt> </tt>
339<a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">IOError</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
340<a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-comment"># If we can't access with _mode, try _fallback_mode and don't lock.</tt> </tt>
341<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">errno</tt> <tt class="py-op">==</tt> <tt class="py-name">errno</tt><tt class="py-op">.</tt><tt class="py-name">EACCES</tt><tt class="py-op">:</tt> </tt>
342<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
343<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]344<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> </tt>
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]345<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-comment"># We opened in _mode, try to lock the file.</tt> </tt>
346<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> <tt class="py-keyword">while</tt> <tt class="py-name">True</tt><tt class="py-op">:</tt> </tt>
347<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
348<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-name">hfile</tt> <tt class="py-op">=</tt> <tt class="py-name">win32file</tt><tt class="py-op">.</tt><tt class="py-name">_get_osfhandle</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
349<a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-name">win32file</tt><tt class="py-op">.</tt><tt class="py-name">LockFileEx</tt><tt class="py-op">(</tt> </tt>
350<a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-name">hfile</tt><tt class="py-op">,</tt> </tt>
351<a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">win32con</tt><tt class="py-op">.</tt><tt class="py-name">LOCKFILE_FAIL_IMMEDIATELY</tt><tt class="py-op">|</tt> </tt>
352<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-name">win32con</tt><tt class="py-op">.</tt><tt class="py-name">LOCKFILE_EXCLUSIVE_LOCK</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">0x10000</tt><tt class="py-op">,</tt> </tt>
353<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"> <tt class="py-name">pywintypes</tt><tt class="py-op">.</tt><tt class="py-name">OVERLAPPED</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
354<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
355<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
356<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">pywintypes</tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
357<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">timeout</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
358<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">e</tt> </tt>
359<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> </tt>
360<a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> <tt class="py-comment"># If the error is not that the file is already in use, raise.</tt> </tt>
361<a name="L280"></a><tt class="py-lineno">280</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt id="link-19" class="py-name" targets="Variable oauth2client.locked_file._Win32Opener=oauth2client.locked_file-module.html#_Win32Opener"><a title="oauth2client.locked_file._Win32Opener" class="py-name" href="#" onclick="return doclink('link-19', '_Win32Opener', 'link-19');">_Win32Opener</a></tt><tt class="py-op">.</tt><tt class="py-name">FILE_IN_USE_ERROR</tt><tt class="py-op">:</tt> </tt>
362<a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
363<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> </tt>
364<a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> <tt class="py-comment"># We could not acquire the lock. Try again.</tt> </tt>
365<a name="L284"></a><tt class="py-lineno">284</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">start_time</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;=</tt> <tt class="py-name">timeout</tt><tt class="py-op">:</tt> </tt>
366<a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt id="link-20" class="py-name"><a title="apiclient.discovery.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]367oauth2client.appengine.logger
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame]368oauth2client.client.logger
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]369oauth2client.crypt.logger
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]370oauth2client.gce.logger
Joe Gregoriobf14cef2012-06-22 15:26:16 -0400[diff] [blame]371oauth2client.locked_file.logger
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]372oauth2client.multistore_file.logger
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]373oauth2client.util.logger" class="py-name" href="#" onclick="return doclink('link-20', 'logger', 'link-2');">logger</a></tt><tt class="py-op">.</tt><tt class="py-name">warn</tt><tt class="py-op">(</tt><tt class="py-string">'Could not lock %s in %s seconds'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
374<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">timeout</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
375<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
376<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
377<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">open</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fallback_mode</tt><tt class="py-op">)</tt> </tt>
378<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
379<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">sleep</tt><tt class="py-op">(</tt><tt class="py-name">delay</tt><tt class="py-op">)</tt> </tt>
380</div><a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"> </tt>
381<a name="_Win32Opener.unlock_and_close"></a><div id="_Win32Opener.unlock_and_close-def"><a name="L293"></a><tt class="py-lineno">293</tt> <a class="py-toggle" href="#" id="_Win32Opener.unlock_and_close-toggle" onclick="return toggle('_Win32Opener.unlock_and_close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file._Win32Opener-class.html#unlock_and_close">unlock_and_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
382</div><div id="_Win32Opener.unlock_and_close-collapsed" style="display:none;" pad="+++" indent="++++++++++"></div><div id="_Win32Opener.unlock_and_close-expanded"><a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-docstring">"""Close and unlock the file using the win32 primitive."""</tt> </tt>
383<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt><tt class="py-op">:</tt> </tt>
384<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
385<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-name">hfile</tt> <tt class="py-op">=</tt> <tt class="py-name">win32file</tt><tt class="py-op">.</tt><tt class="py-name">_get_osfhandle</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">fileno</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
386<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-name">win32file</tt><tt class="py-op">.</tt><tt class="py-name">UnlockFileEx</tt><tt class="py-op">(</tt><tt class="py-name">hfile</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-op">-</tt><tt class="py-number">0x10000</tt><tt class="py-op">,</tt> <tt class="py-name">pywintypes</tt><tt class="py-op">.</tt><tt class="py-name">OVERLAPPED</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
387<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-keyword">except</tt> <tt class="py-name">pywintypes</tt><tt class="py-op">.</tt><tt class="py-name">error</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
388<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> <tt class="py-op">!=</tt> <tt id="link-21" class="py-name"><a title="oauth2client.locked_file._Win32Opener" class="py-name" href="#" onclick="return doclink('link-21', '_Win32Opener', 'link-19');">_Win32Opener</a></tt><tt class="py-op">.</tt><tt class="py-name">FILE_ALREADY_UNLOCKED_ERROR</tt><tt class="py-op">:</tt> </tt>
389<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> </tt>
390<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_locked</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
391<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">:</tt> </tt>
392<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_fh</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
393</div></div><a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"><tt class="py-keyword">except</tt> <tt class="py-name">ImportError</tt><tt class="py-op">:</tt> </tt>
394<a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> <tt id="link-22" class="py-name"><a title="oauth2client.locked_file._Win32Opener" class="py-name" href="#" onclick="return doclink('link-22', '_Win32Opener', 'link-19');">_Win32Opener</a></tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
395<a name="LockedFile"></a><div id="LockedFile-def"><a name="L307"></a><tt class="py-lineno">307</tt> <tt class="py-line"> </tt>
396<a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> </tt>
397<a name="L309"></a><tt class="py-lineno">309</tt> <a class="py-toggle" href="#" id="LockedFile-toggle" onclick="return toggle('LockedFile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html">LockedFile</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
398</div><div id="LockedFile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="LockedFile-expanded"><a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"> <tt class="py-docstring">"""Represent a file that has exclusive access."""</tt> </tt>
399<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"> </tt>
400<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">util</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name" targets="Function oauth2client.util.positional()=oauth2client.util-module.html#positional"><a title="oauth2client.util.positional" class="py-name" href="#" onclick="return doclink('link-23', 'positional', 'link-23');">positional</a></tt><tt class="py-op">(</tt><tt class="py-number">4</tt><tt class="py-op">)</tt> </tt>
401<a name="LockedFile.__init__"></a><div id="LockedFile.__init__-def"><a name="L313"></a><tt class="py-lineno">313</tt> <a class="py-toggle" href="#" id="LockedFile.__init__-toggle" onclick="return toggle('LockedFile.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">mode</tt><tt class="py-op">,</tt> <tt class="py-param">fallback_mode</tt><tt class="py-op">,</tt> <tt class="py-param">use_native_locking</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
402</div><div id="LockedFile.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.__init__-expanded"><a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"> <tt class="py-docstring">"""Construct a LockedFile.</tt> </tt>
403<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
404<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
405<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"><tt class="py-docstring"> filename: string, The path of the file to open.</tt> </tt>
406<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"><tt class="py-docstring"> mode: string, The mode to try to open the file with.</tt> </tt>
407<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"><tt class="py-docstring"> fallback_mode: string, The mode to use if locking fails.</tt> </tt>
408<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"><tt class="py-docstring"> use_native_locking: bool, Whether or not fcntl/win32 locking is used.</tt> </tt>
409<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
410<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
411<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">opener</tt> <tt class="py-keyword">and</tt> <tt class="py-name">use_native_locking</tt><tt class="py-op">:</tt> </tt>
412<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-24" class="py-name"><a title="oauth2client.locked_file._Win32Opener" class="py-name" href="#" onclick="return doclink('link-24', '_Win32Opener', 'link-19');">_Win32Opener</a></tt><tt class="py-op">:</tt> </tt>
413<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt id="link-25" class="py-name"><a title="oauth2client.locked_file._Win32Opener" class="py-name" href="#" onclick="return doclink('link-25', '_Win32Opener', 'link-19');">_Win32Opener</a></tt><tt class="py-op">(</tt><tt id="link-26" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
414oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-26', 'filename', 'link-3');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">mode</tt><tt class="py-op">,</tt> <tt class="py-name">fallback_mode</tt><tt class="py-op">)</tt> </tt>
415<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-27" class="py-name"><a title="oauth2client.locked_file._FcntlOpener" class="py-name" href="#" onclick="return doclink('link-27', '_FcntlOpener', 'link-16');">_FcntlOpener</a></tt><tt class="py-op">:</tt> </tt>
416<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt id="link-28" class="py-name"><a title="oauth2client.locked_file._FcntlOpener" class="py-name" href="#" onclick="return doclink('link-28', '_FcntlOpener', 'link-16');">_FcntlOpener</a></tt><tt class="py-op">(</tt><tt id="link-29" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
417oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-29', 'filename', 'link-3');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">mode</tt><tt class="py-op">,</tt> <tt class="py-name">fallback_mode</tt><tt class="py-op">)</tt> </tt>
418<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> </tt>
419<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">opener</tt><tt class="py-op">:</tt> </tt>
420<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"> <tt class="py-name">opener</tt> <tt class="py-op">=</tt> <tt id="link-30" class="py-name" targets="Class oauth2client.locked_file._PosixOpener=oauth2client.locked_file._PosixOpener-class.html"><a title="oauth2client.locked_file._PosixOpener" class="py-name" href="#" onclick="return doclink('link-30', '_PosixOpener', 'link-30');">_PosixOpener</a></tt><tt class="py-op">(</tt><tt id="link-31" class="py-name"><a title="oauth2client.locked_file.LockedFile.filename
421oauth2client.locked_file._Opener.filename" class="py-name" href="#" onclick="return doclink('link-31', 'filename', 'link-3');">filename</a></tt><tt class="py-op">,</tt> <tt class="py-name">mode</tt><tt class="py-op">,</tt> <tt class="py-name">fallback_mode</tt><tt class="py-op">)</tt> </tt>
422<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> </tt>
423<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt> <tt class="py-op">=</tt> <tt class="py-name">opener</tt> </tt>
424</div><a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"> </tt>
425<a name="LockedFile.filename"></a><div id="LockedFile.filename-def"><a name="L334"></a><tt class="py-lineno">334</tt> <a class="py-toggle" href="#" id="LockedFile.filename-toggle" onclick="return toggle('LockedFile.filename');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#filename">filename</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
426</div><div id="LockedFile.filename-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.filename-expanded"><a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the filename we were constructed with."""</tt> </tt>
427<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt class="py-name">_filename</tt> </tt>
428</div><a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> </tt>
429<a name="LockedFile.file_handle"></a><div id="LockedFile.file_handle-def"><a name="L338"></a><tt class="py-lineno">338</tt> <a class="py-toggle" href="#" id="LockedFile.file_handle-toggle" onclick="return toggle('LockedFile.file_handle');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#file_handle">file_handle</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
430</div><div id="LockedFile.file_handle-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.file_handle-expanded"><a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"> <tt class="py-docstring">"""Return the file_handle to the opened file."""</tt> </tt>
431<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method oauth2client.locked_file.LockedFile.file_handle()=oauth2client.locked_file.LockedFile-class.html#file_handle,Method oauth2client.locked_file._Opener.file_handle()=oauth2client.locked_file._Opener-class.html#file_handle"><a title="oauth2client.locked_file.LockedFile.file_handle
432oauth2client.locked_file._Opener.file_handle" class="py-name" href="#" onclick="return doclink('link-32', 'file_handle', 'link-32');">file_handle</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
433</div><a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"> </tt>
434<a name="LockedFile.is_locked"></a><div id="LockedFile.is_locked-def"><a name="L342"></a><tt class="py-lineno">342</tt> <a class="py-toggle" href="#" id="LockedFile.is_locked-toggle" onclick="return toggle('LockedFile.is_locked');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#is_locked">is_locked</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
435</div><div id="LockedFile.is_locked-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.is_locked-expanded"><a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-docstring">"""Return whether we successfully locked the file."""</tt> </tt>
436<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Method oauth2client.locked_file.LockedFile.is_locked()=oauth2client.locked_file.LockedFile-class.html#is_locked,Method oauth2client.locked_file._Opener.is_locked()=oauth2client.locked_file._Opener-class.html#is_locked"><a title="oauth2client.locked_file.LockedFile.is_locked
437oauth2client.locked_file._Opener.is_locked" class="py-name" href="#" onclick="return doclink('link-33', 'is_locked', 'link-33');">is_locked</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
438</div><a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> </tt>
439<a name="LockedFile.open_and_lock"></a><div id="LockedFile.open_and_lock-def"><a name="L346"></a><tt class="py-lineno">346</tt> <a class="py-toggle" href="#" id="LockedFile.open_and_lock-toggle" onclick="return toggle('LockedFile.open_and_lock');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#open_and_lock">open_and_lock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">timeout</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">delay</tt><tt class="py-op">=</tt><tt class="py-number">0.05</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
440</div><div id="LockedFile.open_and_lock-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.open_and_lock-expanded"><a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> <tt class="py-docstring">"""Open the file, trying to lock it.</tt> </tt>
441<a name="L348"></a><tt class="py-lineno">348</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
442<a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt>
443<a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"><tt class="py-docstring"> timeout: float, The number of seconds to try to acquire the lock.</tt> </tt>
444<a name="L351"></a><tt class="py-lineno">351</tt> <tt class="py-line"><tt class="py-docstring"> delay: float, The number of seconds to wait between retry attempts.</tt> </tt>
445<a name="L352"></a><tt class="py-lineno">352</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
446<a name="L353"></a><tt class="py-lineno">353</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt>
447<a name="L354"></a><tt class="py-lineno">354</tt> <tt class="py-line"><tt class="py-docstring"> AlreadyLockedException: if the lock is already acquired.</tt> </tt>
448<a name="L355"></a><tt class="py-lineno">355</tt> <tt class="py-line"><tt class="py-docstring"> IOError: if the open fails.</tt> </tt>
449<a name="L356"></a><tt class="py-lineno">356</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
450<a name="L357"></a><tt class="py-lineno">357</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name" targets="Method oauth2client.locked_file.LockedFile.open_and_lock()=oauth2client.locked_file.LockedFile-class.html#open_and_lock,Method oauth2client.locked_file._FcntlOpener.open_and_lock()=oauth2client.locked_file._FcntlOpener-class.html#open_and_lock,Method oauth2client.locked_file._Opener.open_and_lock()=oauth2client.locked_file._Opener-class.html#open_and_lock,Method oauth2client.locked_file._PosixOpener.open_and_lock()=oauth2client.locked_file._PosixOpener-class.html#open_and_lock"><a title="oauth2client.locked_file.LockedFile.open_and_lock
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]451oauth2client.locked_file._FcntlOpener.open_and_lock
452oauth2client.locked_file._Opener.open_and_lock
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]453oauth2client.locked_file._PosixOpener.open_and_lock" class="py-name" href="#" onclick="return doclink('link-34', 'open_and_lock', 'link-34');">open_and_lock</a></tt><tt class="py-op">(</tt><tt class="py-name">timeout</tt><tt class="py-op">,</tt> <tt class="py-name">delay</tt><tt class="py-op">)</tt> </tt>
454</div><a name="L358"></a><tt class="py-lineno">358</tt> <tt class="py-line"> </tt>
455<a name="LockedFile.unlock_and_close"></a><div id="LockedFile.unlock_and_close-def"><a name="L359"></a><tt class="py-lineno">359</tt> <a class="py-toggle" href="#" id="LockedFile.unlock_and_close-toggle" onclick="return toggle('LockedFile.unlock_and_close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="oauth2client.locked_file.LockedFile-class.html#unlock_and_close">unlock_and_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
456</div><div id="LockedFile.unlock_and_close-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="LockedFile.unlock_and_close-expanded"><a name="L360"></a><tt class="py-lineno">360</tt> <tt class="py-line"> <tt class="py-docstring">"""Unlock and close a file."""</tt> </tt>
457<a name="L361"></a><tt class="py-lineno">361</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_opener</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Method oauth2client.locked_file.LockedFile.unlock_and_close()=oauth2client.locked_file.LockedFile-class.html#unlock_and_close,Method oauth2client.locked_file._FcntlOpener.unlock_and_close()=oauth2client.locked_file._FcntlOpener-class.html#unlock_and_close,Method oauth2client.locked_file._Opener.unlock_and_close()=oauth2client.locked_file._Opener-class.html#unlock_and_close,Method oauth2client.locked_file._PosixOpener.unlock_and_close()=oauth2client.locked_file._PosixOpener-class.html#unlock_and_close"><a title="oauth2client.locked_file.LockedFile.unlock_and_close
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]458oauth2client.locked_file._FcntlOpener.unlock_and_close
459oauth2client.locked_file._Opener.unlock_and_close
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]460oauth2client.locked_file._PosixOpener.unlock_and_close" class="py-name" href="#" onclick="return doclink('link-35', 'unlock_and_close', 'link-35');">unlock_and_close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
461</div></div><a name="L362"></a><tt class="py-lineno">362</tt> <tt class="py-line"> </tt><script type="text/javascript">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]462<!--
463expandto(location.href);
464// -->
465</script>
466</pre>
467<br />
468<!-- ==================== NAVIGATION BAR ==================== -->
469<table class="navbar" border="0" width="100%" cellpadding="0"
470 bgcolor="#a0c0ff" cellspacing="0">
471 <tr valign="middle">
472
473 <!-- Tree link -->
474 <th>&nbsp;&nbsp;&nbsp;<a
475 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
476
477 <!-- Index link -->
478 <th>&nbsp;&nbsp;&nbsp;<a
479 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
480
481 <!-- Help link -->
482 <th>&nbsp;&nbsp;&nbsp;<a
483 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
484
485 <th class="navbar" width="100%"></th>
486 </tr>
487</table>
488<table border="0" cellpadding="0" cellspacing="0" width="100%%">
489 <tr>
490 <td align="left" class="footer">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame^]491 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:48 2012
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]492 </td>
493 <td align="right" class="footer">
494 <a target="mainFrame" href="http://epydoc.sourceforge.net"
495 >http://epydoc.sourceforge.net</a>
496 </td>
497 </tr>
498</table>
499
500<script type="text/javascript">
501 <!--
502 // Private objects are initially displayed (because if
503 // javascript is turned off then we want them to be
504 // visible); but by default, we want to hide them. So hide
505 // them unless we have a cookie that says to show them.
506 checkCookie();
507 // -->
508</script>
509</body>
510</html>