Skip to main content

Wraps the portalocker recipe for easy usage

Project description

Test Status Coverage Status Code Health Requirements Status

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/

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().

Contact

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

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for portalocker-0.5.tar.gz
Algorithm Hash digest
SHA256 1cd45e4f1a1289ea054ba61ed88328029096e6d35afa264a31c56f4507e14f1e
MD5 ad147b19d1e40b2f8df25c9a97a613e9
BLAKE2b-256 63aa30d2bb5027bf245c7500f0cf251226ca880a877d2f9f8d77273b4bd4be69

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