Skip to main content

Wraps the portalocker recipe for easy usage

Project description

Linux Test Status Windows Tests Status Coverage Status


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

An important detail to note is that on Linux and Unix systems the locks are advisory by default. By specifying the -o mand option to the mount command it is possible to enable mandatory file locking on Linux. This is generally not recommended however. For more information about the subject:

The module is currently maintained by Rick van Hattem <>. The project resides at . Bugs and feature requests can be submitted there. Patches are also very welcome.


On some networked filesystems it might be needed to force a os.fsync() before closing the file so it’s actually written before another client reads the file. Effectively this comes down to:

with portalocker.Lock('some_file', 'rb+', timeout=60) as fh:
    # do what you need to do

    # flush and sync to filesystem


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.write('foo')
>>> file.close()

Explicitly unlocking might not be needed in all cases:

But can be done through:

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

More examples can be found in the tests.


See the changelog page.


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.

Files for portalocker, version 1.7.0
Filename, size File type Python version Upload date Hashes
Filename, size portalocker-1.7.0-py2.py3-none-any.whl (15.0 kB) File type Wheel Python version 3.8 Upload date Hashes View
Filename, size portalocker-1.7.0.tar.gz (14.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page