Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An extended version of portalocker to lock files in Python using the with statement
Python
Branch: master
Failed to load latest commit information.
docs updated docs
portalocker added python 3x compatibility with full tests and docs
tests Small PEP-8 change
.gitignore
.travis.yml oops... tox configs dont work in travis
CHANGELOG added python 3.3 support
LICENSE added initial version
MANIFEST.in renamed readme
README.rst updated badges
pytest.ini added python 3x compatibility with full tests and docs
setup.cfg updated docs
setup.py updated docs
test_requirements.txt added python 3x compatibility with full tests and docs
tox.ini added python 3x compatibility with full tests and docs

README.rst

portalocker - Cross-platform locking library

Test Status Coverage Status Code Health

Overview

Portalocker is a library to provide an easy API to file locking.

Originally created as a Python Recipe by Jonathan Feinberg and Lowell Alleman http://code.activestate.com/recipes/65203-portalocker-cross-platform-posixnt-api-for-flock-s/

The module is currently maintained by Rick van Hattem <Wolph@wol.ph>. The project resides at https://github.com/WoLpH/portalocker . Bugs and feature requests can be submitted there. Patches are also very welcome.

Links

Examples

To make sure your cache generation scripts don't race, use the Lock class:

>>> import portalocker
>>> with portalocker.Lock('somefile', timeout=1) as fh:
    print >>fh, 'writing some stuff to my cache...'

To lock a file exclusively, use the lock method:

>>> import portalocker
>>> file = open('somefile', 'r+')
>>> portalocker.lock(file, portalocker.LOCK_EX)
>>> file.seek(12)
>>> file.write('foo')
>>> file.close()

There is no explicit need to unlock the file as it is automatically unlocked after file.close(). If you still feel the need to manually unlock a file than you can do it like this:

>>> portalocker.unlock(file)

Do note that your data might still be in a buffer so it is possible that your data is not available until you flush() or close().

Changelog

See CHANGELOG file

License

see the LICENSE file

Something went wrong with that request. Please try again.