Premiere version : mise en route du suivi.
[auf_roundup.git] / roundup / backends / .svn / text-base / locking.py.svn-base
1 #! /usr/bin/env python
2 # Copyright (c) 2002 ekit.com Inc (http://www.ekit-inc.com/)
3 #
4 # Permission is hereby granted, free of charge, to any person obtaining a copy
5 # of this software and associated documentation files (the "Software"), to deal
6 # in the Software without restriction, including without limitation the rights
7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 # copies of the Software, and to permit persons to whom the Software is
9 # furnished to do so, subject to the following conditions:
10 #
11 #   The above copyright notice and this permission notice shall be included in
12 #   all copies or substantial portions of the Software.
13 #
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 # SOFTWARE.
21
22 # $Id: locking.py,v 1.8 2004-02-11 23:55:09 richard Exp $
23
24 '''This module provides a generic interface to acquire and release
25 exclusive access to a file.
26
27 It should work on Unix and Windows.
28 '''
29 __docformat__ = 'restructuredtext'
30
31 from roundup.backends import portalocker
32
33 def acquire_lock(path, block=1):
34     '''Acquire a lock for the given path
35     '''
36     file = open(path, 'w')
37     if block:
38         portalocker.lock(file, portalocker.LOCK_EX)
39     else:
40         portalocker.lock(file, portalocker.LOCK_EX|portalocker.LOCK_NB)
41     return file
42
43 def release_lock(file):
44     '''Release our lock on the given path
45     '''
46     portalocker.unlock(file)