Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
scoder committed Aug 25, 2023
1 parent 50d9b69 commit 648ee72
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ This is a C-level implementation of a fast, re-entrant, optimistic lock for CPyt
It is a drop-in replacement for
`threading.RLock <https://docs.python.org/3/library/threading.html#threading.RLock>`_.
FastRLock is implemented in `Cython <https://cython.org>`_ and also provides a C-API
for direct use from Cython code via ``from fastrlock cimport rlock``.
for direct use from Cython code via ``from fastrlock cimport rlock`` or
``from cython.cimports.fastrlock import rlock``.

Under normal conditions, it is about 10x faster than threading.RLock in Python 2.7
Under normal conditions, it is about 10x faster than ``threading.RLock`` in Python 2.7
because it avoids all locking unless two or more threads try to acquire it at the
same time. Under congestion, it is still about 10% faster than RLock due to being
implemented in Cython.
Expand Down

0 comments on commit 648ee72

Please sign in to comment.