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

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

Uploaded Source

File details

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

File metadata

  • Download URL: portalocker-0.5.4.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for portalocker-0.5.4.tar.gz
Algorithm Hash digest
SHA256 fc8d164f0fb737939a6b1a35c6683bda6ea5704ee6c5d3bab3eb6d32b42f7779
MD5 5e7944066f8e709b22b1778aa3e0b170
BLAKE2b-256 8779aa2c9d2ac1c226182e092dc2dfd2aead88f3eac2263e52646a60014a7398

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