Skip to main content

Wraps the portalocker recipe for easy usage

Project description

Linux Test Status Windows Tests 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.

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 customize the opening and locking a manual approach is also possible:

>>> 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portalocker-0.6.1.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

portalocker-0.6.1-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file portalocker-0.6.1.tar.gz.

File metadata

File hashes

Hashes for portalocker-0.6.1.tar.gz
Algorithm Hash digest
SHA256 a2291c070126ecb060f7d8e61226ffcf6017c9be207348a4c6e1ef15c58eca7c
MD5 7a3c0251b202d9445c3ad3ba8beb1374
BLAKE2b-256 972b25d16eaed61cdad8ddda5933f69a8dd4920355fe7b97aa59f9656bdb1021

See more details on using hashes here.

File details

Details for the file portalocker-0.6.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for portalocker-0.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bfe9ff0563da090f0a4f88cf649a20f9992c6dcaeefd27c552fb5c3c74634ed8
MD5 97427f3427e740ee851c9bd263b92c88
BLAKE2b-256 7bf28fe32eb13e05c89d6c4352c88cd8057b95240f14e075895ea7051a959642

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page