Skip to main content

Read write lock for asyncio.

Project description

https://travis-ci.org/aio-libs/aiorwlock.svg?branch=master https://coveralls.io/repos/jettify/aiorwlock/badge.png?branch=master

Read write lock for asyncio . A RWLock maintains a pair of associated locks, one for read-only operations and one for writing. The read lock may be held simultaneously by multiple reader tasks, so long as there are no writers. The write lock is exclusive.

Whether or not a read-write lock will improve performance over the use of a mutual exclusion lock depends on the frequency that the data is read compared to being modified. For example, a collection that is initially populated with data and thereafter infrequently modified, while being frequently searched is an ideal candidate for the use of a read-write lock. However, if updates become frequent then the data spends most of its time being exclusively locked and there is little, if any increase in concurrency.

Implementation is almost direct port from this patch.

Example with async def

Requires Python 3.5+

import asyncio
import aiorwlock
loop = asyncio.get_event_loop()


async def go():
    rwlock = aiorwlock.RWLock(loop=loop)
    async with rwlock.writer:
        # or same way you can acquire reader lock
        # async with rwlock.reader: pass
        print("inside writer")
        yield from asyncio.sleep(0.1, loop=loop)

loop.run_until_complete(go())

Old-school way

Requires Python 3.3+

import asyncio
import aiorwlock
loop = asyncio.get_event_loop()


@asyncio.coroutine
def go():
    rwlock = aiorwlock.RWLock(loop=loop)
    with (yield from rwlock.writer):
        # or same way you can acquire reader lock
        # with (yield from rwlock.reader): pass
        print("inside writer")
        yield from asyncio.sleep(0.1, loop=loop)

loop.run_until_complete(go())

Fast path

By default RWLock switches context on lock acquiring. That allows to other waiting tasks get the lock even if task that holds the lock doesn’t contain context switches (await fut statements).

The default behavior can be switched off by fast argument: RWLock(fast=True).

Long story short: lock is safe by default, but if you sure you have context switches (await, async with, async for or yield from statements) inside locked code you may want to use fast=True for minor speedup.

License

aiorwlock is offered under the Apache 2 license.

Changes

0.4.0 (2015-09-20)

  • Support Python 3.5 and async with statement

  • rename .reader_lock -> .reader, .writer_lock -> .writer. Backward compatibility is preserved.

0.3.0 (2014-02-11)

  • Add .locked property

0.2.0 (2014-02-09)

  • Make .release() non-coroutine

0.1.0 (2014-12-22)

  • Initial release

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

aiorwlock-0.4.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

aiorwlock-0.4.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file aiorwlock-0.4.0.tar.gz.

File metadata

  • Download URL: aiorwlock-0.4.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for aiorwlock-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4247c575dfb396c4afc6e25fad715a56029013ccf1e3b3c22e972df7ae06bbc2
MD5 6f4e04392886b0e08ec51c4548a1be85
BLAKE2b-256 f66cdd20872ca1c31f8cf3cd5bccb66888472ec5e2a38a68ca0e13429b51d1e3

See more details on using hashes here.

Provenance

File details

Details for the file aiorwlock-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aiorwlock-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca4dead49899e0c6a32d7582e31c33dcf5cf9aadda16c0c5eb84e9badc899109
MD5 c9d2ceef575ee23c13ef906debe9dfa3
BLAKE2b-256 df22b9686ff4dbd61a7da5aecd57a1b7d940e961f0a4538cd6985096b1c125a3

See more details on using hashes here.

Provenance

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