You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ORPA-pyOpenRPA/Resources/WPy32-3720/python-3.7.2/Lib/site-packages/locket-0.2.0.dist-info/METADATA

73 lines
2.3 KiB

Metadata-Version: 2.0
Name: locket
Version: 0.2.0
Summary: File-based locks for Python for Linux and Windows
Home-page: http://github.com/mwilliamson/locket.py
Author: Michael Williamson
Author-email: mike@zwobble.org
License: UNKNOWN
Keywords: lock filelock lockfile process
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
locket.py
=========
Locket implements a lock that can be used by multiple processes provided they use the same path.
.. code-block:: python
import locket
# Wait for lock
with locket.lock_file("path/to/lock/file"):
perform_action()
# Raise error if lock cannot be acquired immediately
with locket.lock_file("path/to/lock/file", timeout=0):
perform_action()
# Raise error if lock cannot be acquired after thirty seconds
with locket.lock_file("path/to/lock/file", timeout=30):
perform_action()
# Without context managers:
lock = locket.lock_file("path/to/lock/file")
try:
lock.acquire()
perform_action()
finally:
lock.release()
Locks largely behave as (non-reentrant) `Lock` instances from the `threading`
module in the standard library. Specifically, their behaviour is:
* Locks are uniquely identified by the file being locked,
both in the same process and across different processes.
* Locks are either in a locked or unlocked state.
* When the lock is unlocked, calling `acquire()` returns immediately and changes
the lock state to locked.
* When the lock is locked, calling `acquire()` will block until the lock state
changes to unlocked, or until the timeout expires.
* If a process holds a lock, any thread in that process can call `release()` to
change the state to unlocked.
* Behaviour of locks after `fork` is undefined.