mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Clarify the return type of Event.wait when timeout is used (GH-104168)

This commit is contained in:
Phil Elson 2024-02-26 10:53:20 +01:00 committed by GitHub
parent 915d7dd090
commit 37f5d06b1b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Doc/library/threading.rst
View File

@ -987,18 +987,15 @@ method. The :meth:`~Event.wait` method blocks until the flag is true.
.. method:: wait(timeout=None) .. method:: wait(timeout=None)
Block until the internal flag is true. If the internal flag is true on Block as long as the internal flag is false and the timeout, if given,
entry, return immediately. Otherwise, block until another thread calls has not expired. The return value represents the
:meth:`.set` to set the flag to true, or until the optional timeout occurs. reason that this blocking method returned; ``True`` if returning because
the internal flag is set to true, or ``False`` if a timeout is given and
the the internal flag did not become true within the given wait time.
When the timeout argument is present and not ``None``, it should be a When the timeout argument is present and not ``None``, it should be a
floating point number specifying a timeout for the operation in seconds floating point number specifying a timeout for the operation in seconds,
(or fractions thereof). or fractions thereof.
This method returns ``True`` if and only if the internal flag has been set to
true, either before the wait call or after the wait starts, so it will
always return ``True`` except if a timeout is given and the operation
times out.
.. versionchanged:: 3.1 .. versionchanged:: 3.1
Previously, the method always returned ``None``. Previously, the method always returned ``None``.