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

import asyncio
import aiorwlock
loop = asyncio.get_event_loop()


@asyncio.coroutine
def go():
    rwlock = aiorwlock.RWLock(loop=loop)
    with (yield from rwlock.writer_lock):
        # or same way you can acquire reader lock
        # with (yield from rwlock.reader_lock): pass
        print("inside writer_lock")
        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 (yield from 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 (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.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.3.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

aiorwlock-0.3.0-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

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