Uranium
Application Framework
UM.LockFile.LockFile Class Reference

Public Member Functions

None __init__ (self, str filename, int timeout=10, str wait_msg="Waiting for lock file to disappear...")
 
None __enter__ (self)
 
None __exit__ (self, type exc_type, Exception exc_val, Any exc_tb)
 

Detailed Description

Manage a lock file for reading / writing in a directory.

example usage::

$ with LockFile("my_lock_file.lock"):
$   <do something in a directory>

Constructor & Destructor Documentation

◆ __init__()

None UM.LockFile.LockFile.__init__ (   self,
str  filename,
int   timeout = 10,
str   wait_msg = "Waiting for lock file to disappear..." 
)
Creates the locker instance that will hold the lock file.

:param filename: The name and path of the lockfile to create.
:param timeout: After this amount of seconds, the lock will break
regardless of the state of the file system.
:param wait_msg: A message to log when the thread is blocked by the lock.
It is intended that you modify this to better indicate what lock file is
blocking the thread.

Member Function Documentation

◆ __enter__()

None UM.LockFile.LockFile.__enter__ (   self)
Attempt to grab the lock file for personal use.

◆ __exit__()

None UM.LockFile.LockFile.__exit__ (   self,
type  exc_type,
Exception  exc_val,
Any  exc_tb 
)
Release the lock file so that other processes may use it.

:param exc_type: The type of exception that was raised during the
    ``with`` block, if any. Use ``None`` if no exception was raised.
:param exc_val: The exception instance that was raised during the
    ``with`` block, if any. Use ``None`` if no exception was raised.
:param exc_tb: The traceback frames at the time the exception occurred,
    if any. Use ``None`` if no exception was raised.

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