semvec/pypi-packages huggingface dataset:
flockfile 0.1.2
A simple lock file class based on file locking.
License: MIT
Requires Python: >=2.7
Keywords: Lock,Flock

# flockfile

Just a simple python lock file class using file locks.

## Installation

```bash
pip install flockfile
```

## Usage

```python
from flockfile import FlockFile, FileNotLocked

# init the class using a file name
# optionally, the directory can be set to something other than /tmp
lock = FlockFile("myscriptname", lock_dir="/tmp")


# lock the file
lock.lock()
# if this is unsuccessful, exception FileNotLocked will be raised.

# the following class method can be used to check lock status
assert lock.check_lock()

# unlock and delete file
lock.unlock()
```

## Questions or Issues?

Please report as a Gitlab issue: https://gitlab.com/rveach/flockfile/issues