Skip to main content

A minimal lock file mechanism

Project description

A minimal, no-dependencies lock file mechanism, creating a temporary file to signal that a
specific file should not be touched by other scripts, or instances of the same script.

Created for [Europe 1° Warmer](https://www.onedegreewarmer.eu/).

This is module does _not_ implement OS level file locking. For that, see e.g. the built-in [lockfile](https://pythonhosted.org/lockfile/lockfile.html) module, [zc.lockfile](https://pypi.org/project/zc.lockfile/), or other similar projects.

## Installation

```sh
pip install tmplockfile
```

## Usage

```python3
from tmplockfile import LockFile, ResourceLocked

with LockFile("data.csv") as lockfile:
# Do things involving data.csv here
#
# A lock-file is temporarily placed in the same directory,
# in a way that avoids the most obvious race conditions.
# The variable `lockfile` contains the name of the lock-file,
# e.g. `data.csv~lock`.

except ResourceLocked:
print("Another script is currently working on data.csv. Try again later!")
```

## Changelog

- 0.0.3

- Don't crash when no lockfile could be created


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tmplockfile, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size tmplockfile-0.0.3-py2-none-any.whl (4.2 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size tmplockfile-0.0.3.tar.gz (2.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page