Skip to main content

NFS-safe file locking with timeouts for POSIX and Windows

Project description

NFS-safe file locking with timeouts for POSIX and Windows.

The flufl.lock library provides an NFS-safe file-based locking algorithm influenced by the GNU/Linux open(2) manpage, under the description of the O_EXCL option.

[…] O_EXCL is broken on NFS file systems, programs which rely on it for performing locking tasks will contain a race condition. The solution for performing atomic file locking using a lockfile is to create a unique file on the same fs (e.g., incorporating hostname and pid), use link(2) to make a link to the lockfile. If link() returns 0, the lock is successful. Otherwise, use stat(2) on the unique file to check if its link count has increased to 2, in which case the lock is also successful.

The assumption made here is that there will be no outside interference, e.g. no agent external to this code will ever link() to the specific lock files used.

Lock objects support lock-breaking so that you can’t wedge a process forever. This is especially helpful in a web environment, but may not be appropriate for all applications.

Locks have a lifetime, which is the maximum length of time the process expects to retain the lock. It is important to pick a good number here because other processes will not break an existing lock until the expected lifetime has expired. Too long and other processes will hang; too short and you’ll end up trampling on existing process locks – and possibly corrupting data. In a distributed (NFS) environment, you also need to make sure that your clocks are properly synchronized.

Author

flufl.lock is Copyright (C) 2007-2025 Barry Warsaw <barry@python.org>

Licensed under the terms of the Apache License Version 2.0. See the LICENSE file for details.

Project details

Project details


Download files

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

Source Distribution

flufl_lock-8.2.0.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

flufl_lock-8.2.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file flufl_lock-8.2.0.tar.gz.

File metadata

  • Download URL: flufl_lock-8.2.0.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for flufl_lock-8.2.0.tar.gz
Algorithm Hash digest
SHA256 15b333c35fab1a36b223840057258aeb4cd79f0fbaf82c144f23cdf6cf14d5e3
MD5 892b25737891ad71e7c03f1f4ea1cd3d
BLAKE2b-256 907880f98f67deb8ba9b67e00a91ceb1ded5a7b8eb2b7801b89625d3396fc9d4

See more details on using hashes here.

File details

Details for the file flufl_lock-8.2.0-py3-none-any.whl.

File metadata

  • Download URL: flufl_lock-8.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for flufl_lock-8.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59361e277a50efceff288b8e9d36dd43254ad11a88d42d7716195b848a3fce7c
MD5 b4cda01c6a2b4330e65ce8c43a2b1003
BLAKE2b-256 8ea115e07d6c8b33485c4eed49a170faea16d4c6c4fd9f2cb6242adfaed180e7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page