locker.LockFile Class Reference

Lock a file. More...

Inheritance diagram for locker.LockFile:

Collaboration diagram for locker.LockFile:

Public Member Functions
def	__init__
def	__del__ (self)
def	__enter__ (self)
def	__exit__ (self, type, value, traceback)

Public Attributes
	name
	temporary
	file
	log

Detailed Description

Lock a file.

The file for the lock is created if it doesn't exists and it the "temporary" argument is set to True it will also be deleted when the lock is not needed. The unlocking is done in the destructor (RAII pattern).

Definition at line 63 of file locker.py.

Constructor & Destructor Documentation

def locker.LockFile.__init__	(		self,
			name,
			temporary = False
	)

Definition at line 64 of file locker.py.

    def __init__(self, name, temporary = False):
        self.name = name
        self.temporary = temporary
        self.file = None
        self.log = logging.getLogger("LockFile")
        self.log.info("%s - Locking on %s", time.strftime("%Y-%m-%d_%H:%M:%S"), self.name)
        if not os.path.exists(name):
            mode = "w"
        else:
            self.temporary = False # I do not want to delete a file I didn't create
            mode = "r+"
        try:
            self.file = open(self.name, mode)
            lock(self.file)
        except:
            self.log.warning("Cannot acquire lock on %s", self.name)

def locker.LockFile.__del__

(

self

)

Definition at line 81 of file locker.py.

    def __del__(self):
        if self.file:
            unlock(self.file)
            self.file.close()
            if self.temporary:
                try:
                    os.remove(self.name)
                except:
                    pass
            self.log.info("%s - Lock on %s released", time.strftime("%Y-%m-%d_%H:%M:%S"), self.name)
            self.file = None # Don't unlock twice!

Member Function Documentation

def locker.LockFile.__enter__

(

self

)

Definition at line 96 of file locker.py.

    def __enter__(self):
        return self

def locker.LockFile.__exit__	(		self,
			type,
			value,
			traceback
	)

Definition at line 99 of file locker.py.

    def __exit__(self, type, value, traceback):
        self.__del__()

Member Data Documentation

locker.LockFile.file

Definition at line 67 of file locker.py.

locker.LockFile.log

Definition at line 68 of file locker.py.

locker.LockFile.name

Definition at line 65 of file locker.py.

locker.LockFile.temporary

Definition at line 66 of file locker.py.

---

The documentation for this class was generated from the following file:

• GaudiPolicy/scripts/locker.py