Current File : /opt/imunify360/venv/lib/python3.11/site-packages/lockfile-0.12.2.dist-info//DESCRIPTION.rst
Note: This package is **deprecated**. It is highly preferred that instead of
using this code base that instead `fasteners`_ or `oslo.concurrency`_ is
used instead. For any questions or comments or further help needed
please email `openstack-dev`_ and prefix your email subject
with ``[oslo][pylockfile]`` (for a faster response).
The lockfile package exports a LockFile class which provides a simple API for
locking files. Unlike the Windows msvcrt.locking function, the fcntl.lockf
and flock functions, and the deprecated posixfile module, the API is
identical across both Unix (including Linux and Mac) and Windows platforms.
The lock mechanism relies on the atomic nature of the link (on Unix) and
mkdir (on Windows) system calls. An implementation based on SQLite is also
provided, more as a demonstration of the possibilities it provides than as
production-quality code.
Note: In version 0.9 the API changed in two significant ways:
* It changed from a module defining several classes to a package containing
several modules, each defining a single class.
* Where classes had been named SomethingFileLock before the last two words
have been reversed, so that class is now SomethingLockFile.
The previous module-level definitions of LinkFileLock, MkdirFileLock and
SQLiteFileLock will be retained until the 1.0 release.
To install:
python setup.py install
* Documentation: http://docs.openstack.org/developer/pylockfile
* Source: http://git.openstack.org/cgit/openstack/pylockfile
* Bugs: http://bugs.launchpad.net/pylockfile
