Add version{added,changed} for lock timeout support.

This commit is contained in:
Antoine Pitrou 2010-04-19 14:05:51 +00:00
parent 05a2f88126
commit adbc009779
2 changed files with 11 additions and 0 deletions

View File

@ -109,6 +109,8 @@ It defines the following constants and functions:
:meth:`Lock.acquire`. Specifiying a timeout greater than this value will :meth:`Lock.acquire`. Specifiying a timeout greater than this value will
raise an :exc:`OverflowError`. raise an :exc:`OverflowError`.
.. versionadded:: 3.2
Lock objects have the following methods: Lock objects have the following methods:
@ -132,6 +134,9 @@ Lock objects have the following methods:
The return value is ``True`` if the lock is acquired successfully, The return value is ``True`` if the lock is acquired successfully,
``False`` if not. ``False`` if not.
.. versionchanged:: 3.2
The *timeout* parameter is new.
.. method:: lock.release() .. method:: lock.release()
Releases the lock. The lock must have been acquired earlier, but not Releases the lock. The lock must have been acquired earlier, but not

View File

@ -164,6 +164,7 @@ This module also defines the following constant:
Specifiying a timeout greater than this value will raise an Specifiying a timeout greater than this value will raise an
:exc:`OverflowError`. :exc:`OverflowError`.
.. versionadded:: 3.2
Detailed interfaces for the objects are documented below. Detailed interfaces for the objects are documented below.
@ -382,6 +383,8 @@ All methods are executed atomically.
The return value is ``True`` if the lock is acquired successfully, The return value is ``True`` if the lock is acquired successfully,
``False`` if not (for example if the *timeout* expired). ``False`` if not (for example if the *timeout* expired).
.. versionchanged:: 3.2
The *timeout* parameter is new.
.. method:: Lock.release() .. method:: Lock.release()
@ -439,6 +442,9 @@ pair) resets the lock to unlocked and allows another thread blocked in
and as long as the lock cannot be acquired. Return true if the lock has and as long as the lock cannot be acquired. Return true if the lock has
been acquired, false if the timeout has elapsed. been acquired, false if the timeout has elapsed.
.. versionchanged:: 3.2
The *timeout* parameter is new.
.. method:: RLock.release() .. method:: RLock.release()