roundup/backends/locking.py

   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.6 2003-02-20 22:56:49 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
  30 # portalocker has a 0xffff0000 constant, and I don't need to know about it
  31 # being positive in 2.4+ :)
  32 try:
  33     x=FutureWarning
  34     import warnings
  35     warnings.filterwarnings("ignore",
  36         r'hex/oct constants > sys\.maxint .*', FutureWarning,
  37         'portalocker', 0)
  38     del x
  39 except:
  40     pass
  41
  42 import portalocker
  43
  44 def acquire_lock(path, block=1):
  45     '''Acquire a lock for the given path
  46     '''
  47     import portalocker
  48     file = open(path, 'w')
  49     if block:
  50         portalocker.lock(file, portalocker.LOCK_EX)
  51     else:
  52         portalocker.lock(file, portalocker.LOCK_EX|portalocker.LOCK_NB)
  53     return file
  54
  55 def release_lock(file):
  56     '''Release our lock on the given path
  57     '''
  58     portalocker.unlock(file)