############################################
portalocker - Cross-platform locking library
############################################
.. image:: https://github.com/WoLpH/portalocker/actions/workflows/python-package.yml/badge.svg?branch=master
:alt: Linux Test Status
:target: https://github.com/WoLpH/portalocker/actions/
.. image:: https://ci.appveyor.com/api/projects/status/mgqry98hgpy4prhh?svg=true
:alt: Windows Tests Status
:target: https://ci.appveyor.com/project/WoLpH/portalocker
.. image:: https://coveralls.io/repos/WoLpH/portalocker/badge.svg?branch=master
:alt: Coverage Status
:target: https://coveralls.io/r/WoLpH/portalocker?branch=master
Overview
--------
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:
- https://en.wikipedia.org/wiki/File_locking
- http://stackoverflow.com/questions/39292051/portalocker-does-not-seem-to-lock
- https://stackoverflow.com/questions/12062466/mandatory-file-lock-on-linux
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.
Security contact information
------------------------------------------------------------------------------
To report a security vulnerability, please use the
`Tidelift security contact <https://tidelift.com/security>`_.
Tidelift will coordinate the fix and disclosure.
Redis Locks
-----------
This library now features a lock based on Redis which allows for locks across
multiple threads, processes and even distributed locks across multiple
computers.
It is an extremely reliable Redis lock that is based on pubsub.
As opposed to most Redis locking systems based on key/value pairs,
this locking method is based on the pubsub system. The big advantage is
that if the connection gets killed due to network issues, crashing
processes or otherwise, it will still immediately unlock instead of
waiting for a lock timeout.
First make sure you have everything installed correctly:
::
pip install "portalocker[redis]"
Usage is really easy:
::
import portalocker
lock = portalocker.RedisLock('some_lock_channel_name')
with lock:
print('do something here')
The API is essentially identical to the other ``Lock`` classes so in addition
to the ``with`` statement you can also use ``lock.acquire(...)``.
Python 2
--------
Python 2 was supported in versions before Portalocker 2.0. If you are still
using
Python 2,
you can run this to install:
::
pip install "portalocker<2"
Tips
----
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
fh.flush()
os.fsync(fh.fileno())
Links
-----
* Documentation
- http://portalocker.readthedocs.org/en/latest/
* Source
- https://github.com/WoLpH/portalocker
* Bug reports
- https://github.com/WoLpH/portalocker/issues
* Package homepage
- https://pypi.python.org/pypi/portalocker
* My blog
- http://w.wol.ph/
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('writing some stuff to my cache...', file=fh)
To customize the opening and locking a manual approach is also possible:
>>> import portalocker
>>> file = open('somefile', 'r+')
>>> portalocker.lock(file, portalocker.LockFlags.EXCLUSIVE)
>>> file.seek(12)
>>> file.write('foo')
>>> file.close()
Explicitly unlocking is not needed in most cases but omitting it has been known
to cause issues:
https://github.com/AzureAD/microsoft-authentication-extensions-for-python/issues/42#issuecomment-601108266
If needed, it 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()`.
To create a cross platform bounded semaphore across multiple processes you can
use the `BoundedSemaphore` class which functions somewhat similar to
`threading.BoundedSemaphore`:
>>> import portalocker
>>> n = 2
>>> timeout = 0.1
>>> semaphore_a = portalocker.BoundedSemaphore(n, timeout=timeout)
>>> semaphore_b = portalocker.BoundedSemaphore(n, timeout=timeout)
>>> semaphore_c = portalocker.BoundedSemaphore(n, timeout=timeout)
>>> semaphore_a.acquire()
<portalocker.utils.Lock object at ...>
>>> semaphore_b.acquire()
<portalocker.utils.Lock object at ...>
>>> semaphore_c.acquire()
Traceback (most recent call last):
...
portalocker.exceptions.AlreadyLocked
More examples can be found in the
`tests <http://portalocker.readthedocs.io/en/latest/_modules/tests/tests.html>`_.
Versioning
----------
This library follows `Semantic Versioning <http://semver.org/>`_.
Changelog
---------
Every release has a ``git tag`` with a commit message for the tag
explaining what was added and/or changed. The list of tags/releases
including the commit messages can be found here:
https://github.com/WoLpH/portalocker/releases
License
-------
See the `LICENSE <https://github.com/WoLpH/portalocker/blob/develop/LICENSE>`_ file.
Raw data
{
"_id": null,
"home_page": null,
"name": "portalocker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "locking, locks, with, statement, windows, linux, unix",
"author": null,
"author_email": "Rick van Hattem <wolph@wol.ph>",
"download_url": "https://files.pythonhosted.org/packages/ed/d3/c6c64067759e87af98cc668c1cc75171347d0f1577fab7ca3749134e3cd4/portalocker-2.10.1.tar.gz",
"platform": "any",
"description": "############################################\nportalocker - Cross-platform locking library\n############################################\n\n.. image:: https://github.com/WoLpH/portalocker/actions/workflows/python-package.yml/badge.svg?branch=master\n :alt: Linux Test Status\n :target: https://github.com/WoLpH/portalocker/actions/\n\n.. image:: https://ci.appveyor.com/api/projects/status/mgqry98hgpy4prhh?svg=true\n :alt: Windows Tests Status\n :target: https://ci.appveyor.com/project/WoLpH/portalocker\n\n.. image:: https://coveralls.io/repos/WoLpH/portalocker/badge.svg?branch=master\n :alt: Coverage Status\n :target: https://coveralls.io/r/WoLpH/portalocker?branch=master\n\nOverview\n--------\n\nPortalocker is a library to provide an easy API to file locking.\n\nAn important detail to note is that on Linux and Unix systems the locks are\nadvisory by default. By specifying the `-o mand` option to the mount command it\nis possible to enable mandatory file locking on Linux. This is generally not\nrecommended however. For more information about the subject:\n\n - https://en.wikipedia.org/wiki/File_locking\n - http://stackoverflow.com/questions/39292051/portalocker-does-not-seem-to-lock\n - https://stackoverflow.com/questions/12062466/mandatory-file-lock-on-linux\n\nThe module is currently maintained by Rick van Hattem <Wolph@wol.ph>.\nThe project resides at https://github.com/WoLpH/portalocker . Bugs and feature\nrequests can be submitted there. Patches are also very welcome.\n\nSecurity contact information\n------------------------------------------------------------------------------\n\nTo report a security vulnerability, please use the\n`Tidelift security contact <https://tidelift.com/security>`_.\nTidelift will coordinate the fix and disclosure.\n\nRedis Locks\n-----------\n\nThis library now features a lock based on Redis which allows for locks across\nmultiple threads, processes and even distributed locks across multiple\ncomputers.\n\nIt is an extremely reliable Redis lock that is based on pubsub.\n\nAs opposed to most Redis locking systems based on key/value pairs,\nthis locking method is based on the pubsub system. The big advantage is\nthat if the connection gets killed due to network issues, crashing\nprocesses or otherwise, it will still immediately unlock instead of\nwaiting for a lock timeout.\n\nFirst make sure you have everything installed correctly:\n\n::\n\n pip install \"portalocker[redis]\"\n\nUsage is really easy:\n\n::\n\n import portalocker\n\n lock = portalocker.RedisLock('some_lock_channel_name')\n\n with lock:\n print('do something here')\n\nThe API is essentially identical to the other ``Lock`` classes so in addition\nto the ``with`` statement you can also use ``lock.acquire(...)``.\n\nPython 2\n--------\n\nPython 2 was supported in versions before Portalocker 2.0. If you are still\nusing\nPython 2,\nyou can run this to install:\n\n::\n\n pip install \"portalocker<2\"\n\nTips\n----\n\nOn some networked filesystems it might be needed to force a `os.fsync()` before\nclosing the file so it's actually written before another client reads the file.\nEffectively this comes down to:\n\n::\n\n with portalocker.Lock('some_file', 'rb+', timeout=60) as fh:\n # do what you need to do\n ...\n\n # flush and sync to filesystem\n fh.flush()\n os.fsync(fh.fileno())\n\nLinks\n-----\n\n* Documentation\n - http://portalocker.readthedocs.org/en/latest/\n* Source\n - https://github.com/WoLpH/portalocker\n* Bug reports\n - https://github.com/WoLpH/portalocker/issues\n* Package homepage\n - https://pypi.python.org/pypi/portalocker\n* My blog\n - http://w.wol.ph/\n\nExamples\n--------\n\nTo make sure your cache generation scripts don't race, use the `Lock` class:\n\n>>> import portalocker\n>>> with portalocker.Lock('somefile', timeout=1) as fh:\n... print('writing some stuff to my cache...', file=fh)\n\nTo customize the opening and locking a manual approach is also possible:\n\n>>> import portalocker\n>>> file = open('somefile', 'r+')\n>>> portalocker.lock(file, portalocker.LockFlags.EXCLUSIVE)\n>>> file.seek(12)\n>>> file.write('foo')\n>>> file.close()\n\nExplicitly unlocking is not needed in most cases but omitting it has been known\nto cause issues:\nhttps://github.com/AzureAD/microsoft-authentication-extensions-for-python/issues/42#issuecomment-601108266\n\nIf needed, it can be done through:\n\n>>> portalocker.unlock(file)\n\nDo note that your data might still be in a buffer so it is possible that your\ndata is not available until you `flush()` or `close()`.\n\nTo create a cross platform bounded semaphore across multiple processes you can\nuse the `BoundedSemaphore` class which functions somewhat similar to\n`threading.BoundedSemaphore`:\n\n>>> import portalocker\n>>> n = 2\n>>> timeout = 0.1\n\n>>> semaphore_a = portalocker.BoundedSemaphore(n, timeout=timeout)\n>>> semaphore_b = portalocker.BoundedSemaphore(n, timeout=timeout)\n>>> semaphore_c = portalocker.BoundedSemaphore(n, timeout=timeout)\n\n>>> semaphore_a.acquire()\n<portalocker.utils.Lock object at ...>\n>>> semaphore_b.acquire()\n<portalocker.utils.Lock object at ...>\n>>> semaphore_c.acquire()\nTraceback (most recent call last):\n ...\nportalocker.exceptions.AlreadyLocked\n\n\nMore examples can be found in the\n`tests <http://portalocker.readthedocs.io/en/latest/_modules/tests/tests.html>`_.\n\n\nVersioning\n----------\n\nThis library follows `Semantic Versioning <http://semver.org/>`_.\n\n\nChangelog\n---------\n\nEvery release has a ``git tag`` with a commit message for the tag\nexplaining what was added and/or changed. The list of tags/releases\nincluding the commit messages can be found here:\nhttps://github.com/WoLpH/portalocker/releases\n\nLicense\n-------\n\nSee the `LICENSE <https://github.com/WoLpH/portalocker/blob/develop/LICENSE>`_ file.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Wraps the portalocker recipe for easy usage",
"version": "2.10.1",
"project_urls": {
"bugs": "https://github.com/wolph/portalocker/issues",
"documentation": "https://portalocker.readthedocs.io/en/latest/",
"repository": "https://github.com/wolph/portalocker/"
},
"split_keywords": [
"locking",
" locks",
" with",
" statement",
" windows",
" linux",
" unix"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bfba70a4214956182e0d7a9099ab17d50bfcba1056188e9b14f35b9e2b62a0d",
"md5": "3ad37408a781c56ab55c3ae0b0c6651c",
"sha256": "53a5984ebc86a025552264b459b46a2086e269b21823cb572f8f28ee759e45bf"
},
"downloads": -1,
"filename": "portalocker-2.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3ad37408a781c56ab55c3ae0b0c6651c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18423,
"upload_time": "2024-07-13T23:15:32",
"upload_time_iso_8601": "2024-07-13T23:15:32.602303Z",
"url": "https://files.pythonhosted.org/packages/9b/fb/a70a4214956182e0d7a9099ab17d50bfcba1056188e9b14f35b9e2b62a0d/portalocker-2.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "edd3c6c64067759e87af98cc668c1cc75171347d0f1577fab7ca3749134e3cd4",
"md5": "b6b9d372351f2df6b2c62315f9cb8b87",
"sha256": "ef1bf844e878ab08aee7e40184156e1151f228f103aa5c6bd0724cc330960f8f"
},
"downloads": -1,
"filename": "portalocker-2.10.1.tar.gz",
"has_sig": false,
"md5_digest": "b6b9d372351f2df6b2c62315f9cb8b87",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 40891,
"upload_time": "2024-07-13T23:15:34",
"upload_time_iso_8601": "2024-07-13T23:15:34.860123Z",
"url": "https://files.pythonhosted.org/packages/ed/d3/c6c64067759e87af98cc668c1cc75171347d0f1577fab7ca3749134e3cd4/portalocker-2.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 23:15:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wolph",
"github_project": "portalocker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"tox": true,
"lcname": "portalocker"
}
JSON
