From 709370b2198e09f1dbe195fe8813602a3125b7f6 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Wed, 8 Sep 2021 23:29:05 -0700 Subject: Add doctests to some of this stuff. --- lockfile.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'lockfile.py') diff --git a/lockfile.py b/lockfile.py index 34279ba..1e0516b 100644 --- a/lockfile.py +++ b/lockfile.py @@ -28,7 +28,14 @@ class LockFileContents: class LockFile(object): """A file locking mechanism that has context-manager support so you - can use it in a with statement. + can use it in a with statement. e.g. + + with LockFile('./foo.lock'): + # do a bunch of stuff... if the process dies we have a signal + # handler to do cleanup. Other code (in this process or another) + # that tries to take the same lockfile will block. There is also + # some logic for detecting stale locks. + """ def __init__( -- cgit v1.3