Skip to main content

Wraps the portalocker recipe for easy usage

Project description

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.

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.0.tar.gz (7.5 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for portalocker-0.6.0.tar.gz
Algorithm Hash digest
SHA256 39bd8a9ce75882e17fa8dd5d96a9d7c0800c31c9b2376458638ca20e32abf306
MD5 92ea919727ffa680842d300c4c0348e9
BLAKE2b-256 7b7972b68f28e6099de3941490580294902b6a1b0b2e05fb8ef4f2687b362af0

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