Skip to main content

RwLock: Reader-Writer lock

Project description

Python Version Pypi Version Code size in bytes

Coverage

License

RwLock: Reader-Writer lock

Introduction

We can simply protect a shared resource by a lock. But the performance is not good because each reader should run one-by-one.

A Reader-Writer lock can improve the performance by let readers running simultaneously.

By the way, a writer should wait until all readers done. In a frequently read situation, a new reader after the writer can also increase the read count, let read count never decrease to 0. This will starve writer.

RwLock:

  1. Let readers running simultaneously.
  2. Exclude "multiple readers" and each writer.
  3. provide a flag "write_first" to prevent starve writer.

After 1.6.0, RwLock can support multi-thread(default) and multi-process. For multi-process scenario, use rwlock = RwLock(cross_process=True)

Version control

  • cy-rwlock XX.YY.ZZ
    1. XX.YY match the latest git tag.
    2. ZZ will increase automatically when new commit appear in master branch.
    3. XX: Update when change architecture
    4. YY: Update when add or modify some features
    5. ZZ: Update when bugfix or minor changes.

Usage

Install

  1. pip install cy_rwlock
  2. download latest version from https://pypi.org/project/cy_rwlock/#files

Example


from rwlock import RwLock

rwlock = RwLock()

### READER
rwlock.acquire_r()
# read...
rwlock.release_r()

# OR
with rwlock.lock_r():
    # read...

### WRITER
rwlock.acquire_w()
# write...
rwlock.release_w()

# OR
with rwlock.lock_w():
    # write...

Unittest

  • local(windows)
    • run scripts\run.bat
  • github
    • auto run when push

Deploy

  • PyPI version
    • convertd from git tag
  • local(windows)
    • run scripts\deploy.bat
  • github -> PyPI
    • When release in github

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

cy_rwlock-1.7.6.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cy_rwlock-1.7.6-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file cy_rwlock-1.7.6.tar.gz.

File metadata

  • Download URL: cy_rwlock-1.7.6.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

File hashes

Hashes for cy_rwlock-1.7.6.tar.gz
Algorithm Hash digest
SHA256 03ddd09f643c8c4bad794c5c199883e0f7ba44057b2a2887c4ad334cededc698
MD5 7cadfc5f34f2400086124422ac6fecc0
BLAKE2b-256 3aecc8a476e46f3798612cb9faffc442e9a7656b3c81475c2c4e21b081d485b4

See more details on using hashes here.

File details

Details for the file cy_rwlock-1.7.6-py3-none-any.whl.

File metadata

  • Download URL: cy_rwlock-1.7.6-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.1

File hashes

Hashes for cy_rwlock-1.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d5cbac81691a2b9096375c958c47778ef8aa1ff6389f9c0105d3623a542d21e8
MD5 214dea3373618d6428638bae9eb9ef7e
BLAKE2b-256 a6872d5f4194c056094189d2c6aaa5e3a59cf58e8258d4a3729bad37dd5b4841

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page