Usage¶

Exclusive blocking lock:

from flockcontext import FlockOpen

with FlockOpen('/tmp/my.lock', 'w') as lock:
    lock.fd.write('Locked\n')

Exclusive non-blocking lock:

from flockcontext import FlockOpen

try:
    with FlockOpen('/tmp/my.lock', 'w', blocking=False) as lock:
        lock.fd.write('Locked\n')
except IOError as e:
    print('Can not acquire lock')

Shared blocking lock:

from flockcontext import Flock

with FlockOpen('/tmp/my.lock', 'w', exclusive=False) as lock:
    lock.fd.write('Locked\n')

Acquire and release within context:

from flockcontext import FlockOpen

with FlockOpen('/tmp/my.lock', 'w') as lock:
    print('Lock acquired')
    lock.fd.write('Locked\n')

    lock.release()
    print('Lock released')

    lock.acquire()
    print('Lock acquired')
    lock.fd.write('Locked\n')

Locking alredy opened file:

from flockcontext import Flock

with open('/tmp/my.lock', 'w') as fd:
    with Flock(fd):
        fd.write('Locked\n')

License¶

• Free software: BSD license

FlockOpen exemples¶

Exclusive blocking lock:: python

from flockcontext import FlockOpen

with FlockOpen(‘/tmp/my.lock’, ‘w’) as lock:

lock.fd.write(‘Lockedn’)

Exclusive non-blocking lock:: python

from flockcontext import FlockOpen

try:

with FlockOpen(‘/tmp/my.lock’, ‘w’, blocking=False) as lock:

lock.fd.write(‘Lockedn’)

except IOError as e:

print(‘Can not acquire lock’)

Shared blocking lock:: python

from flockcontext import Flock

with FlockOpen(‘/tmp/my.lock’, ‘w’, exclusive=False) as lock:

lock.fd.write(‘Lockedn’)

Acquire and release within context:: python

from flockcontext import FlockOpen

with FlockOpen(‘/tmp/my.lock’, ‘w’) as lock:

print(‘Lock acquired’) lock.fd.write(‘Lockedn’)

lock.release() print(‘Lock released’)

lock.acquire() print(‘Lock acquired’) lock.fd.write(‘Lockedn’)

Flock exemples¶

Blocking lock:: python

from flockcontext import Flock

with open(‘/tmp/my.lock’, ‘w’) as fd:

with Flock(fd):

fd.write(‘Lockedn’)

Non blocking lock:: python

from flockcontext import Flock

with open(‘/tmp/my.lock’, ‘w’) as fd:

try:

with Flock(fd, blocking=False):

fd.write(‘Lockedn’)

except IOError as e:

print(‘Can not acquire lock’)

Shared lock:: python

from flockcontext import Flock

with open(‘/tmp/my.lock’, ‘w’) as fd:

with Flock(fd, exclusive=False):

fd.write(‘Lockedn’)

Acquire and release within context:: python

from flockcontext import Flock

with open(‘/tmp/my.lock’, ‘w’) as fd:

with Flock(fd) as lock:

print(‘Lock acquired’) fd.write(‘Lockedn’)

lock.release() print(‘Lock released’)

lock.acquire() print(‘Lock acquired’) fd.write(‘Lockedn’)

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up flockcontext for local development.

1. Fork the flockcontext repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/flockcontext.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv flockcontext
   $ cd flockcontext/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 flockcontext tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/AntoineCezar/flockcontext/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_flock

Development Lead¶

• Antoine Cezar <antoine@cezar.fr>

Contributors¶

• Mathieu Leplatre <contact@mathieu-leplatre.info>