filelock 3.0.8

A platform independent file lock.

=======

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>

Download-URL: https://github.com/benediktschmitt/py-filelock/archive/master.zip
Description: py-filelock
===========

.. image:: https://travis-ci.org/benediktschmitt/py-filelock.svg?branch=master
:target: https://travis-ci.org/benediktschmitt/py-filelock

`Similar Libraries <#similar-libraries>`_
~ `Installation <#installation>`_
~ `Documentation <#documentation>`_
~ `Contributions <#contributions>`_
~ `License <#license>`_

This package contains a single module, which implements a platform independent
file lock in Python, which provides a simple way of inter-process communication:

.. code-block:: python

from filelock import Timeout, FileLock

lock = FileLock("high_ground.txt.lock")
with lock:
open("high_ground.txt", "a").write("You were the chosen one.")

**Don't use** a *FileLock* to lock the file you want to write to, instead create a separate
*.lock* file as shown above.

.. image:: https://raw.githubusercontent.com/benediktschmitt/py-filelock/master/example/example.gif

`Animated example <https://github.com/benediktschmitt/py-filelock/blob/master/example/example.gif>`_

Similar libraries
-----------------

Perhaps you are looking for something like

* https://pypi.python.org/pypi/pid/2.1.1
* https://docs.python.org/3.6/library/msvcrt.html#msvcrt.locking
* or https://docs.python.org/3/library/fcntl.html#fcntl.flock

Installation
------------

*py-filelock* is available via PyPi:

.. code-block:: bash

$ pip3 install filelock

Documentation
-------------

The documentation for the API is available on
`readthedocs.org <https://filelock.readthedocs.io/>`_.

Examples
^^^^^^^^

A *FileLock* is used to indicate another process of your application that a resource or working
directory is currently used. To do so, create a *FileLock* first:

.. code-block:: python

from filelock import Timeout, FileLock

file_path = "high_ground.txt"
lock_path = "high_ground.txt.lock"

lock = FileLock(lock_path, timeout=1)

The lock object supports multiple ways for acquiring the lock, including the ones used to acquire
standard Python thread locks:

.. code-block:: python

with lock:
open(file_path, "a").write("Hello there!")

lock.acquire()
try:
open(file_path, "a").write("General Kenobi!")
finally:
lock.release()

The *acquire()* method accepts also a *timeout* parameter. If the lock cannot be acquired
within *timeout* seconds, a *Timeout* exception is raised.:

.. code-block:: python

try:
with lock.acquire(timeout=10):
open(file_path, "a").write("I have a bad feeling about this.")
except Timeout:
print("Another instance of this application currently holds the lock.")

The lock objects are recursive locks, which means that once acquired, they will not block on
successive lock requests:

.. code-block:: python

def cite1():
with lock:
open(file_path, "a").write("I hate it when he does that.")

def cite2():
with lock:
open(file_path, "a").write("You don't want to sell me death sticks.")

# The lock is acquired here.
with lock:
cite1()
cite2()

# And released here.

FileLock vs SoftFileLock
^^^^^^^^^^^^^^^^^^^^^^^^

The *FileLock* is platform dependent while the *SoftFileLock* is not. Use the *FileLock* if all
instances of your application are running on the same host and a *SoftFileLock* otherwise.

The *SoftFileLock* only watches the existence of the lock file. This makes it ultra portable, but
also more prone to dead locks if the application crashes. You can simply delete the lock file in
such cases.

Contributions
-------------

Contributions are always welcome. Never hesitate to open a new issue.

License
-------

This package is `public domain <LICENSE.rst>`_.

Platform: UNKNOWN
Classifier: License :: Public Domain
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Topic :: System
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries