Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Issue #12767: documenting threading.Condition.notify

This commit is contained in:
Eli Bendersky 2011-11-12 20:44:25 +02:00
parent 3714c1ebfd
commit d44af82e62
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Doc/library/threading.rst
View File

@ -634,20 +634,21 @@ the call as often as necessary.
.. versionadded:: 3.2
.. method:: notify()
.. method:: notify(n=1)
Wake up a thread waiting on this condition, if any. If the calling thread
has not acquired the lock when this method is called, a
By default, wake up one thread waiting on this condition, if any. If the
calling thread has not acquired the lock when this method is called, a
:exc:`RuntimeError` is raised.
This method wakes up one of the threads waiting for the condition
variable, if any are waiting; it is a no-op if no threads are waiting.
This method wakes up at most *n* of the threads waiting for the condition
variable; it is a no-op if no threads are waiting.
The current implementation wakes up exactly one thread, if any are
waiting. However, it's not safe to rely on this behavior. A future,
optimized implementation may occasionally wake up more than one thread.
The current implementation wakes up exactly *n* threads, if at least *n*
threads are waiting. However, it's not safe to rely on this behavior.
A future, optimized implementation may occasionally wake up more than
*n* threads.
Note: the awakened thread does not actually return from its :meth:`wait`
Note: an awakened thread does not actually return from its :meth:`wait`
call until it can reacquire the lock. Since :meth:`notify` does not
release the lock, its caller should.