diff options
| author | Victor Stinner <victor.stinner@gmail.com> | 2015-02-26 10:39:16 +0100 |
|---|---|---|
| committer | Victor Stinner <victor.stinner@gmail.com> | 2015-02-26 10:39:16 +0100 |
| commit | 6a02b052abb7a9d022c5ef948a8305792f99334a (patch) | |
| tree | 1ccaac874e2c1d62ac265283c68e195adde39ca6 | |
| parent | 6d952d68205cd5324bbb213bf0f0e660bfd62924 (diff) | |
| download | cpython-6a02b052abb7a9d022c5ef948a8305792f99334a.tar.gz | |
asyncio doc: lock classes are not thread safe
| -rw-r--r-- | Doc/library/asyncio-sync.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst index f53c7d0808..622ff5fd66 100644 --- a/Doc/library/asyncio-sync.rst +++ b/Doc/library/asyncio-sync.rst @@ -54,6 +54,8 @@ Lock Locks also support the context management protocol. ``(yield from lock)`` should be used as context manager expression. + This class is :ref:`not thread safe <asyncio-multithreading>`. + Usage:: lock = Lock() @@ -117,6 +119,8 @@ Event method. The :meth:`wait` method blocks until the flag is true. The flag is initially false. + This class is :ref:`not thread safe <asyncio-multithreading>`. + .. method:: clear() Reset the internal flag to false. Subsequently, coroutines calling @@ -160,6 +164,8 @@ Condition object, and it is used as the underlying lock. Otherwise, a new :class:`Lock` object is created and used as the underlying lock. + This class is :ref:`not thread safe <asyncio-multithreading>`. + .. coroutinemethod:: acquire() Acquire the underlying lock. @@ -252,6 +258,8 @@ Semaphore defaults to ``1``. If the value given is less than ``0``, :exc:`ValueError` is raised. + This class is :ref:`not thread safe <asyncio-multithreading>`. + .. coroutinemethod:: acquire() Acquire a semaphore. @@ -279,8 +287,8 @@ BoundedSemaphore .. class:: BoundedSemaphore(value=1, \*, loop=None) - A bounded semaphore implementation. Inherit from :class:`Semaphore`. + A bounded semaphore implementation. Inherit from :class:`Semaphore`. - This raises :exc:`ValueError` in :meth:`~Semaphore.release` if it would - increase the value above the initial value. + This raises :exc:`ValueError` in :meth:`~Semaphore.release` if it would + increase the value above the initial value. |