Antoine Pitrou | 64a467d | 2010-12-12 20:34:49 +0000 | [diff] [blame] | 1 | :mod:`threading` --- Thread-based parallelism |
| 2 | ============================================= |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
| 4 | .. module:: threading |
Antoine Pitrou | 64a467d | 2010-12-12 20:34:49 +0000 | [diff] [blame] | 5 | :synopsis: Thread-based parallelism. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 6 | |
Raymond Hettinger | 1048094 | 2011-01-10 03:26:08 +0000 | [diff] [blame] | 7 | **Source code:** :source:`Lib/threading.py` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 8 | |
Raymond Hettinger | 4f707fd | 2011-01-10 19:54:11 +0000 | [diff] [blame] | 9 | -------------- |
| 10 | |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 11 | This module constructs higher-level threading interfaces on top of the lower |
| 12 | level :mod:`_thread` module. See also the :mod:`queue` module. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 13 | |
| 14 | The :mod:`dummy_threading` module is provided for situations where |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 15 | :mod:`threading` cannot be used because :mod:`_thread` is missing. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 16 | |
Benjamin Peterson | 8bdd545 | 2008-08-18 22:38:41 +0000 | [diff] [blame] | 17 | .. note:: |
| 18 | |
Benjamin Peterson | b3085c9 | 2008-09-01 23:09:31 +0000 | [diff] [blame] | 19 | While they are not listed below, the ``camelCase`` names used for some |
| 20 | methods and functions in this module in the Python 2.x series are still |
| 21 | supported by this module. |
Benjamin Peterson | 8bdd545 | 2008-08-18 22:38:41 +0000 | [diff] [blame] | 22 | |
Antoine Pitrou | 0034281 | 2011-01-06 16:31:28 +0000 | [diff] [blame] | 23 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 24 | This module defines the following functions: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 25 | |
| 26 | |
Benjamin Peterson | 672b803 | 2008-06-11 19:14:14 +0000 | [diff] [blame] | 27 | .. function:: active_count() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 | |
| 29 | Return the number of :class:`Thread` objects currently alive. The returned |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 30 | count is equal to the length of the list returned by :func:`.enumerate`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 31 | |
| 32 | |
Benjamin Peterson | 672b803 | 2008-06-11 19:14:14 +0000 | [diff] [blame] | 33 | .. function:: current_thread() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 34 | |
| 35 | Return the current :class:`Thread` object, corresponding to the caller's thread |
| 36 | of control. If the caller's thread of control was not created through the |
| 37 | :mod:`threading` module, a dummy thread object with limited functionality is |
| 38 | returned. |
| 39 | |
| 40 | |
Victor Stinner | 2a12974 | 2011-05-30 23:02:52 +0200 | [diff] [blame] | 41 | .. function:: get_ident() |
| 42 | |
| 43 | Return the 'thread identifier' of the current thread. This is a nonzero |
| 44 | integer. Its value has no direct meaning; it is intended as a magic cookie |
| 45 | to be used e.g. to index a dictionary of thread-specific data. Thread |
| 46 | identifiers may be recycled when a thread exits and another thread is |
| 47 | created. |
| 48 | |
| 49 | .. versionadded:: 3.3 |
| 50 | |
| 51 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 52 | .. function:: enumerate() |
| 53 | |
Benjamin Peterson | 672b803 | 2008-06-11 19:14:14 +0000 | [diff] [blame] | 54 | Return a list of all :class:`Thread` objects currently alive. The list |
| 55 | includes daemonic threads, dummy thread objects created by |
| 56 | :func:`current_thread`, and the main thread. It excludes terminated threads |
| 57 | and threads that have not yet been started. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 58 | |
| 59 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 60 | .. function:: settrace(func) |
| 61 | |
| 62 | .. index:: single: trace function |
| 63 | |
| 64 | Set a trace function for all threads started from the :mod:`threading` module. |
| 65 | The *func* will be passed to :func:`sys.settrace` for each thread, before its |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame^] | 66 | :meth:`~Thread.run` method is called. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 67 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 68 | |
| 69 | .. function:: setprofile(func) |
| 70 | |
| 71 | .. index:: single: profile function |
| 72 | |
| 73 | Set a profile function for all threads started from the :mod:`threading` module. |
| 74 | The *func* will be passed to :func:`sys.setprofile` for each thread, before its |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame^] | 75 | :meth:`~Thread.run` method is called. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 76 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 77 | |
| 78 | .. function:: stack_size([size]) |
| 79 | |
| 80 | Return the thread stack size used when creating new threads. The optional |
| 81 | *size* argument specifies the stack size to be used for subsequently created |
| 82 | threads, and must be 0 (use platform or configured default) or a positive |
Serhiy Storchaka | f8def28 | 2013-02-16 17:29:56 +0200 | [diff] [blame] | 83 | integer value of at least 32,768 (32 KiB). If changing the thread stack size is |
Georg Brandl | 9a13b43 | 2012-04-05 09:53:04 +0200 | [diff] [blame] | 84 | unsupported, a :exc:`RuntimeError` is raised. If the specified stack size is |
Serhiy Storchaka | f8def28 | 2013-02-16 17:29:56 +0200 | [diff] [blame] | 85 | invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32 KiB |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | is currently the minimum supported stack size value to guarantee sufficient |
| 87 | stack space for the interpreter itself. Note that some platforms may have |
| 88 | particular restrictions on values for the stack size, such as requiring a |
Serhiy Storchaka | f8def28 | 2013-02-16 17:29:56 +0200 | [diff] [blame] | 89 | minimum stack size > 32 KiB or requiring allocation in multiples of the system |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 90 | memory page size - platform documentation should be referred to for more |
Serhiy Storchaka | f8def28 | 2013-02-16 17:29:56 +0200 | [diff] [blame] | 91 | information (4 KiB pages are common; using multiples of 4096 for the stack size is |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 92 | the suggested approach in the absence of more specific information). |
| 93 | Availability: Windows, systems with POSIX threads. |
| 94 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 95 | |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 96 | This module also defines the following constant: |
| 97 | |
| 98 | .. data:: TIMEOUT_MAX |
| 99 | |
| 100 | The maximum value allowed for the *timeout* parameter of blocking functions |
| 101 | (:meth:`Lock.acquire`, :meth:`RLock.acquire`, :meth:`Condition.wait`, etc.). |
Georg Brandl | 6faee4e | 2010-09-21 14:48:28 +0000 | [diff] [blame] | 102 | Specifying a timeout greater than this value will raise an |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 103 | :exc:`OverflowError`. |
| 104 | |
Antoine Pitrou | adbc009 | 2010-04-19 14:05:51 +0000 | [diff] [blame] | 105 | .. versionadded:: 3.2 |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 106 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 107 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 108 | This module defines a number of classes, which are detailed in the sections |
| 109 | below. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 110 | |
| 111 | The design of this module is loosely based on Java's threading model. However, |
| 112 | where Java makes locks and condition variables basic behavior of every object, |
| 113 | they are separate objects in Python. Python's :class:`Thread` class supports a |
| 114 | subset of the behavior of Java's Thread class; currently, there are no |
| 115 | priorities, no thread groups, and threads cannot be destroyed, stopped, |
| 116 | suspended, resumed, or interrupted. The static methods of Java's Thread class, |
| 117 | when implemented, are mapped to module-level functions. |
| 118 | |
| 119 | All of the methods described below are executed atomically. |
| 120 | |
| 121 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 122 | Thread-Local Data |
| 123 | ----------------- |
| 124 | |
| 125 | Thread-local data is data whose values are thread specific. To manage |
| 126 | thread-local data, just create an instance of :class:`local` (or a |
| 127 | subclass) and store attributes on it:: |
| 128 | |
| 129 | mydata = threading.local() |
| 130 | mydata.x = 1 |
| 131 | |
| 132 | The instance's values will be different for separate threads. |
| 133 | |
| 134 | |
| 135 | .. class:: local() |
| 136 | |
| 137 | A class that represents thread-local data. |
| 138 | |
| 139 | For more details and extensive examples, see the documentation string of the |
| 140 | :mod:`_threading_local` module. |
| 141 | |
| 142 | |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 143 | .. _thread-objects: |
| 144 | |
| 145 | Thread Objects |
| 146 | -------------- |
| 147 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 148 | The :class:`Thread` class represents an activity that is run in a separate |
| 149 | thread of control. There are two ways to specify the activity: by passing a |
| 150 | callable object to the constructor, or by overriding the :meth:`~Thread.run` |
| 151 | method in a subclass. No other methods (except for the constructor) should be |
| 152 | overridden in a subclass. In other words, *only* override the |
| 153 | :meth:`~Thread.__init__` and :meth:`~Thread.run` methods of this class. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 154 | |
| 155 | Once a thread object is created, its activity must be started by calling the |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 156 | thread's :meth:`~Thread.start` method. This invokes the :meth:`~Thread.run` |
| 157 | method in a separate thread of control. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 158 | |
| 159 | Once the thread's activity is started, the thread is considered 'alive'. It |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 160 | stops being alive when its :meth:`~Thread.run` method terminates -- either |
| 161 | normally, or by raising an unhandled exception. The :meth:`~Thread.is_alive` |
| 162 | method tests whether the thread is alive. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 163 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 164 | Other threads can call a thread's :meth:`~Thread.join` method. This blocks |
| 165 | the calling thread until the thread whose :meth:`~Thread.join` method is |
| 166 | called is terminated. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 167 | |
| 168 | A thread has a name. The name can be passed to the constructor, and read or |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 169 | changed through the :attr:`~Thread.name` attribute. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 170 | |
| 171 | A thread can be flagged as a "daemon thread". The significance of this flag is |
| 172 | that the entire Python program exits when only daemon threads are left. The |
| 173 | initial value is inherited from the creating thread. The flag can be set |
Antoine Pitrou | 61d85ba | 2012-04-10 22:51:26 +0200 | [diff] [blame] | 174 | through the :attr:`~Thread.daemon` property or the *daemon* constructor |
| 175 | argument. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 176 | |
Antoine Pitrou | 38b8254 | 2013-02-15 21:27:18 +0100 | [diff] [blame] | 177 | .. note:: |
| 178 | Daemon threads are abruptly stopped at shutdown. Their resources (such |
| 179 | as open files, database transactions, etc.) may not be released properly. |
| 180 | If you want your threads to stop gracefully, make them non-daemonic and |
| 181 | use a suitable signalling mechanism such as an :class:`Event`. |
| 182 | |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 183 | There is a "main thread" object; this corresponds to the initial thread of |
| 184 | control in the Python program. It is not a daemon thread. |
| 185 | |
| 186 | There is the possibility that "dummy thread objects" are created. These are |
| 187 | thread objects corresponding to "alien threads", which are threads of control |
| 188 | started outside the threading module, such as directly from C code. Dummy |
| 189 | thread objects have limited functionality; they are always considered alive and |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 190 | daemonic, and cannot be :meth:`~Thread.join`\ ed. They are never deleted, |
| 191 | since it is impossible to detect the termination of alien threads. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 192 | |
| 193 | |
Ezio Melotti | 8b61611 | 2012-09-08 20:49:18 +0300 | [diff] [blame] | 194 | .. class:: Thread(group=None, target=None, name=None, args=(), kwargs={}, *, \ |
| 195 | daemon=None) |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 196 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 197 | This constructor should always be called with keyword arguments. Arguments |
| 198 | are: |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 199 | |
| 200 | *group* should be ``None``; reserved for future extension when a |
| 201 | :class:`ThreadGroup` class is implemented. |
| 202 | |
| 203 | *target* is the callable object to be invoked by the :meth:`run` method. |
| 204 | Defaults to ``None``, meaning nothing is called. |
| 205 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 206 | *name* is the thread name. By default, a unique name is constructed of the |
| 207 | form "Thread-*N*" where *N* is a small decimal number. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 208 | |
| 209 | *args* is the argument tuple for the target invocation. Defaults to ``()``. |
| 210 | |
| 211 | *kwargs* is a dictionary of keyword arguments for the target invocation. |
| 212 | Defaults to ``{}``. |
| 213 | |
Antoine Pitrou | 0bd4deb | 2011-02-25 22:07:43 +0000 | [diff] [blame] | 214 | If not ``None``, *daemon* explicitly sets whether the thread is daemonic. |
| 215 | If ``None`` (the default), the daemonic property is inherited from the |
| 216 | current thread. |
| 217 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 218 | If the subclass overrides the constructor, it must make sure to invoke the |
| 219 | base class constructor (``Thread.__init__()``) before doing anything else to |
| 220 | the thread. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 221 | |
Antoine Pitrou | 0bd4deb | 2011-02-25 22:07:43 +0000 | [diff] [blame] | 222 | .. versionchanged:: 3.3 |
| 223 | Added the *daemon* argument. |
| 224 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 225 | .. method:: start() |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 226 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 227 | Start the thread's activity. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 228 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 229 | It must be called at most once per thread object. It arranges for the |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 230 | object's :meth:`~Thread.run` method to be invoked in a separate thread |
| 231 | of control. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 232 | |
Brian Curtin | bd0c897 | 2011-01-31 19:35:02 +0000 | [diff] [blame] | 233 | This method will raise a :exc:`RuntimeError` if called more than once |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 234 | on the same thread object. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 235 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 236 | .. method:: run() |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 237 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 238 | Method representing the thread's activity. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 239 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 240 | You may override this method in a subclass. The standard :meth:`run` |
| 241 | method invokes the callable object passed to the object's constructor as |
| 242 | the *target* argument, if any, with sequential and keyword arguments taken |
| 243 | from the *args* and *kwargs* arguments, respectively. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 244 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 245 | .. method:: join(timeout=None) |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 246 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 247 | Wait until the thread terminates. This blocks the calling thread until |
| 248 | the thread whose :meth:`~Thread.join` method is called terminates -- either |
| 249 | normally or through an unhandled exception --, or until the optional |
| 250 | timeout occurs. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 251 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 252 | When the *timeout* argument is present and not ``None``, it should be a |
| 253 | floating point number specifying a timeout for the operation in seconds |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 254 | (or fractions thereof). As :meth:`~Thread.join` always returns ``None``, |
| 255 | you must call :meth:`~Thread.is_alive` after :meth:`~Thread.join` to |
| 256 | decide whether a timeout happened -- if the thread is still alive, the |
| 257 | :meth:`~Thread.join` call timed out. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 258 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 259 | When the *timeout* argument is not present or ``None``, the operation will |
| 260 | block until the thread terminates. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 261 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 262 | A thread can be :meth:`~Thread.join`\ ed many times. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 263 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 264 | :meth:`~Thread.join` raises a :exc:`RuntimeError` if an attempt is made |
| 265 | to join the current thread as that would cause a deadlock. It is also |
| 266 | an error to :meth:`~Thread.join` a thread before it has been started |
| 267 | and attempts to do so raise the same exception. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 268 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 269 | .. attribute:: name |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 270 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 271 | A string used for identification purposes only. It has no semantics. |
| 272 | Multiple threads may be given the same name. The initial name is set by |
| 273 | the constructor. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 274 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 275 | .. method:: getName() |
| 276 | setName() |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 277 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 278 | Old getter/setter API for :attr:`~Thread.name`; use it directly as a |
| 279 | property instead. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 280 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 281 | .. attribute:: ident |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 282 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 283 | The 'thread identifier' of this thread or ``None`` if the thread has not |
| 284 | been started. This is a nonzero integer. See the |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 285 | :func:`_thread.get_ident()` function. Thread identifiers may be recycled |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 286 | when a thread exits and another thread is created. The identifier is |
| 287 | available even after the thread has exited. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 288 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 289 | .. method:: is_alive() |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 290 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 291 | Return whether the thread is alive. |
Georg Brandl | 770b0be | 2009-01-02 20:10:05 +0000 | [diff] [blame] | 292 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 293 | This method returns ``True`` just before the :meth:`~Thread.run` method |
| 294 | starts until just after the :meth:`~Thread.run` method terminates. The |
| 295 | module function :func:`.enumerate` returns a list of all alive threads. |
Georg Brandl | 770b0be | 2009-01-02 20:10:05 +0000 | [diff] [blame] | 296 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 297 | .. attribute:: daemon |
Georg Brandl | 770b0be | 2009-01-02 20:10:05 +0000 | [diff] [blame] | 298 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 299 | A boolean value indicating whether this thread is a daemon thread (True) |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 300 | or not (False). This must be set before :meth:`~Thread.start` is called, |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 301 | otherwise :exc:`RuntimeError` is raised. Its initial value is inherited |
| 302 | from the creating thread; the main thread is not a daemon thread and |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 303 | therefore all threads created in the main thread default to |
| 304 | :attr:`~Thread.daemon` = ``False``. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 305 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 306 | The entire Python program exits when no alive non-daemon threads are left. |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 307 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 308 | .. method:: isDaemon() |
| 309 | setDaemon() |
Georg Brandl | a971c65 | 2008-11-07 09:39:56 +0000 | [diff] [blame] | 310 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 311 | Old getter/setter API for :attr:`~Thread.daemon`; use it directly as a |
| 312 | property instead. |
Georg Brandl | 770b0be | 2009-01-02 20:10:05 +0000 | [diff] [blame] | 313 | |
| 314 | |
Antoine Pitrou | d6d17c5 | 2011-02-28 22:04:51 +0000 | [diff] [blame] | 315 | .. impl-detail:: |
| 316 | |
Ezio Melotti | 6d043fc | 2013-01-18 19:58:47 +0200 | [diff] [blame] | 317 | In CPython, due to the :term:`Global Interpreter Lock`, only one thread |
Antoine Pitrou | d6d17c5 | 2011-02-28 22:04:51 +0000 | [diff] [blame] | 318 | can execute Python code at once (even though certain performance-oriented |
| 319 | libraries might overcome this limitation). |
Ezio Melotti | 6d043fc | 2013-01-18 19:58:47 +0200 | [diff] [blame] | 320 | If you want your application to make better use of the computational |
Antoine Pitrou | d6d17c5 | 2011-02-28 22:04:51 +0000 | [diff] [blame] | 321 | resources of multi-core machines, you are advised to use |
| 322 | :mod:`multiprocessing` or :class:`concurrent.futures.ProcessPoolExecutor`. |
| 323 | However, threading is still an appropriate model if you want to run |
| 324 | multiple I/O-bound tasks simultaneously. |
| 325 | |
| 326 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 327 | .. _lock-objects: |
| 328 | |
| 329 | Lock Objects |
| 330 | ------------ |
| 331 | |
| 332 | A primitive lock is a synchronization primitive that is not owned by a |
| 333 | particular thread when locked. In Python, it is currently the lowest level |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 334 | synchronization primitive available, implemented directly by the :mod:`_thread` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 335 | extension module. |
| 336 | |
| 337 | A primitive lock is in one of two states, "locked" or "unlocked". It is created |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 338 | in the unlocked state. It has two basic methods, :meth:`~Lock.acquire` and |
| 339 | :meth:`~Lock.release`. When the state is unlocked, :meth:`~Lock.acquire` |
| 340 | changes the state to locked and returns immediately. When the state is locked, |
| 341 | :meth:`~Lock.acquire` blocks until a call to :meth:`~Lock.release` in another |
| 342 | thread changes it to unlocked, then the :meth:`~Lock.acquire` call resets it |
| 343 | to locked and returns. The :meth:`~Lock.release` method should only be |
| 344 | called in the locked state; it changes the state to unlocked and returns |
| 345 | immediately. If an attempt is made to release an unlocked lock, a |
| 346 | :exc:`RuntimeError` will be raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 347 | |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 348 | Locks also support the :ref:`context manager protocol <with-locks>`. |
| 349 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 350 | When more than one thread is blocked in :meth:`~Lock.acquire` waiting for the |
| 351 | state to turn to unlocked, only one thread proceeds when a :meth:`~Lock.release` |
| 352 | call resets the state to unlocked; which one of the waiting threads proceeds |
| 353 | is not defined, and may vary across implementations. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 354 | |
| 355 | All methods are executed atomically. |
| 356 | |
| 357 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 358 | .. class:: Lock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 359 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 360 | The class implementing primitive lock objects. Once a thread has acquired a |
| 361 | lock, subsequent attempts to acquire it block, until it is released; any |
| 362 | thread may release it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 363 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 364 | .. versionchanged:: 3.3 |
| 365 | Changed from a factory function to a class. |
Antoine Pitrou | 810023d | 2010-12-15 22:59:16 +0000 | [diff] [blame] | 366 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 367 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 368 | .. method:: acquire(blocking=True, timeout=-1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 369 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 370 | Acquire a lock, blocking or non-blocking. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 371 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 372 | When invoked with the *blocking* argument set to ``True`` (the default), |
| 373 | block until the lock is unlocked, then set it to locked and return ``True``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 374 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 375 | When invoked with the *blocking* argument set to ``False``, do not block. |
| 376 | If a call with *blocking* set to ``True`` would block, return ``False`` |
| 377 | immediately; otherwise, set the lock to locked and return ``True``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 378 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 379 | When invoked with the floating-point *timeout* argument set to a positive |
| 380 | value, block for at most the number of seconds specified by *timeout* |
| 381 | and as long as the lock cannot be acquired. A negative *timeout* argument |
| 382 | specifies an unbounded wait. It is forbidden to specify a *timeout* |
| 383 | when *blocking* is false. |
| 384 | |
| 385 | The return value is ``True`` if the lock is acquired successfully, |
| 386 | ``False`` if not (for example if the *timeout* expired). |
| 387 | |
| 388 | .. versionchanged:: 3.2 |
| 389 | The *timeout* parameter is new. |
| 390 | |
| 391 | .. versionchanged:: 3.2 |
| 392 | Lock acquires can now be interrupted by signals on POSIX. |
| 393 | |
| 394 | |
| 395 | .. method:: release() |
| 396 | |
| 397 | Release a lock. This can be called from any thread, not only the thread |
| 398 | which has acquired the lock. |
| 399 | |
| 400 | When the lock is locked, reset it to unlocked, and return. If any other threads |
| 401 | are blocked waiting for the lock to become unlocked, allow exactly one of them |
| 402 | to proceed. |
| 403 | |
| 404 | When invoked on an unlocked lock, a :exc:`RuntimeError` is raised. |
| 405 | |
| 406 | There is no return value. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 407 | |
| 408 | |
| 409 | .. _rlock-objects: |
| 410 | |
| 411 | RLock Objects |
| 412 | ------------- |
| 413 | |
| 414 | A reentrant lock is a synchronization primitive that may be acquired multiple |
| 415 | times by the same thread. Internally, it uses the concepts of "owning thread" |
| 416 | and "recursion level" in addition to the locked/unlocked state used by primitive |
| 417 | locks. In the locked state, some thread owns the lock; in the unlocked state, |
| 418 | no thread owns it. |
| 419 | |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 420 | To lock the lock, a thread calls its :meth:`~RLock.acquire` method; this |
| 421 | returns once the thread owns the lock. To unlock the lock, a thread calls |
| 422 | its :meth:`~Lock.release` method. :meth:`~Lock.acquire`/:meth:`~Lock.release` |
| 423 | call pairs may be nested; only the final :meth:`~Lock.release` (the |
| 424 | :meth:`~Lock.release` of the outermost pair) resets the lock to unlocked and |
| 425 | allows another thread blocked in :meth:`~Lock.acquire` to proceed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 426 | |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 427 | Reentrant locks also support the :ref:`context manager protocol <with-locks>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 428 | |
| 429 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 430 | .. class:: RLock() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 431 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 432 | This class implements reentrant lock objects. A reentrant lock must be |
| 433 | released by the thread that acquired it. Once a thread has acquired a |
| 434 | reentrant lock, the same thread may acquire it again without blocking; the |
| 435 | thread must release it once for each time it has acquired it. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 436 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 437 | Note that ``RLock`` is actually a factory function which returns an instance |
| 438 | of the most efficient version of the concrete RLock class that is supported |
| 439 | by the platform. |
Antoine Pitrou | adbc009 | 2010-04-19 14:05:51 +0000 | [diff] [blame] | 440 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 441 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 442 | .. method:: acquire(blocking=True, timeout=-1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 443 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 444 | Acquire a lock, blocking or non-blocking. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 445 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 446 | When invoked without arguments: if this thread already owns the lock, increment |
| 447 | the recursion level by one, and return immediately. Otherwise, if another |
| 448 | thread owns the lock, block until the lock is unlocked. Once the lock is |
| 449 | unlocked (not owned by any thread), then grab ownership, set the recursion level |
| 450 | to one, and return. If more than one thread is blocked waiting until the lock |
| 451 | is unlocked, only one at a time will be able to grab ownership of the lock. |
| 452 | There is no return value in this case. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 453 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 454 | When invoked with the *blocking* argument set to true, do the same thing as when |
| 455 | called without arguments, and return true. |
| 456 | |
| 457 | When invoked with the *blocking* argument set to false, do not block. If a call |
| 458 | without an argument would block, return false immediately; otherwise, do the |
| 459 | same thing as when called without arguments, and return true. |
| 460 | |
| 461 | When invoked with the floating-point *timeout* argument set to a positive |
| 462 | value, block for at most the number of seconds specified by *timeout* |
| 463 | and as long as the lock cannot be acquired. Return true if the lock has |
| 464 | been acquired, false if the timeout has elapsed. |
| 465 | |
| 466 | .. versionchanged:: 3.2 |
| 467 | The *timeout* parameter is new. |
| 468 | |
| 469 | |
| 470 | .. method:: release() |
| 471 | |
| 472 | Release a lock, decrementing the recursion level. If after the decrement it is |
| 473 | zero, reset the lock to unlocked (not owned by any thread), and if any other |
| 474 | threads are blocked waiting for the lock to become unlocked, allow exactly one |
| 475 | of them to proceed. If after the decrement the recursion level is still |
| 476 | nonzero, the lock remains locked and owned by the calling thread. |
| 477 | |
| 478 | Only call this method when the calling thread owns the lock. A |
| 479 | :exc:`RuntimeError` is raised if this method is called when the lock is |
| 480 | unlocked. |
| 481 | |
| 482 | There is no return value. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 483 | |
| 484 | |
| 485 | .. _condition-objects: |
| 486 | |
| 487 | Condition Objects |
| 488 | ----------------- |
| 489 | |
| 490 | A condition variable is always associated with some kind of lock; this can be |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 491 | passed in or one will be created by default. Passing one in is useful when |
| 492 | several condition variables must share the same lock. The lock is part of |
| 493 | the condition object: you don't have to track it separately. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 494 | |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 495 | A condition variable obeys the :ref:`context manager protocol <with-locks>`: |
| 496 | using the ``with`` statement acquires the associated lock for the duration of |
| 497 | the enclosed block. The :meth:`~Condition.acquire` and |
| 498 | :meth:`~Condition.release` methods also call the corresponding methods of |
| 499 | the associated lock. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 500 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 501 | Other methods must be called with the associated lock held. The |
| 502 | :meth:`~Condition.wait` method releases the lock, and then blocks until |
| 503 | another thread awakens it by calling :meth:`~Condition.notify` or |
| 504 | :meth:`~Condition.notify_all`. Once awakened, :meth:`~Condition.wait` |
| 505 | re-acquires the lock and returns. It is also possible to specify a timeout. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 506 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 507 | The :meth:`~Condition.notify` method wakes up one of the threads waiting for |
| 508 | the condition variable, if any are waiting. The :meth:`~Condition.notify_all` |
| 509 | method wakes up all threads waiting for the condition variable. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 510 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 511 | Note: the :meth:`~Condition.notify` and :meth:`~Condition.notify_all` methods |
| 512 | don't release the lock; this means that the thread or threads awakened will |
| 513 | not return from their :meth:`~Condition.wait` call immediately, but only when |
| 514 | the thread that called :meth:`~Condition.notify` or :meth:`~Condition.notify_all` |
| 515 | finally relinquishes ownership of the lock. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 516 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 517 | The typical programming style using condition variables uses the lock to |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 518 | synchronize access to some shared state; threads that are interested in a |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 519 | particular change of state call :meth:`~Condition.wait` repeatedly until they |
| 520 | see the desired state, while threads that modify the state call |
| 521 | :meth:`~Condition.notify` or :meth:`~Condition.notify_all` when they change |
| 522 | the state in such a way that it could possibly be a desired state for one |
| 523 | of the waiters. For example, the following code is a generic |
| 524 | producer-consumer situation with unlimited buffer capacity:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 525 | |
| 526 | # Consume one item |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 527 | with cv: |
| 528 | while not an_item_is_available(): |
| 529 | cv.wait() |
| 530 | get_an_available_item() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 531 | |
| 532 | # Produce one item |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 533 | with cv: |
| 534 | make_an_item_available() |
Antoine Pitrou | f6cd9b2 | 2012-04-11 19:37:56 +0200 | [diff] [blame] | 535 | cv.notify() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 536 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 537 | The ``while`` loop checking for the application's condition is necessary |
| 538 | because :meth:`~Condition.wait` can return after an arbitrary long time, |
Antoine Pitrou | f6cd9b2 | 2012-04-11 19:37:56 +0200 | [diff] [blame] | 539 | and the condition which prompted the :meth:`~Condition.notify` call may |
| 540 | no longer hold true. This is inherent to multi-threaded programming. The |
| 541 | :meth:`~Condition.wait_for` method can be used to automate the condition |
| 542 | checking, and eases the computation of timeouts:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 543 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 544 | # Consume an item |
| 545 | with cv: |
| 546 | cv.wait_for(an_item_is_available) |
| 547 | get_an_available_item() |
Kristján Valur Jónsson | 6331520 | 2010-11-18 12:46:39 +0000 | [diff] [blame] | 548 | |
Antoine Pitrou | 126aef7 | 2012-04-10 22:24:05 +0200 | [diff] [blame] | 549 | To choose between :meth:`~Condition.notify` and :meth:`~Condition.notify_all`, |
| 550 | consider whether one state change can be interesting for only one or several |
| 551 | waiting threads. E.g. in a typical producer-consumer situation, adding one |
| 552 | item to the buffer only needs to wake up one consumer thread. |
| 553 | |
| 554 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 555 | .. class:: Condition(lock=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 556 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 557 | This class implements condition variable objects. A condition variable |
| 558 | allows one or more threads to wait until they are notified by another thread. |
| 559 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 560 | If the *lock* argument is given and not ``None``, it must be a :class:`Lock` |
| 561 | or :class:`RLock` object, and it is used as the underlying lock. Otherwise, |
| 562 | a new :class:`RLock` object is created and used as the underlying lock. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 563 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 564 | .. versionchanged:: 3.3 |
| 565 | changed from a factory function to a class. |
| 566 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 567 | .. method:: acquire(*args) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 568 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 569 | Acquire the underlying lock. This method calls the corresponding method on |
| 570 | the underlying lock; the return value is whatever that method returns. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 571 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 572 | .. method:: release() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 573 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 574 | Release the underlying lock. This method calls the corresponding method on |
| 575 | the underlying lock; there is no return value. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 576 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 577 | .. method:: wait(timeout=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 578 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 579 | Wait until notified or until a timeout occurs. If the calling thread has |
| 580 | not acquired the lock when this method is called, a :exc:`RuntimeError` is |
| 581 | raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 582 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 583 | This method releases the underlying lock, and then blocks until it is |
| 584 | awakened by a :meth:`notify` or :meth:`notify_all` call for the same |
| 585 | condition variable in another thread, or until the optional timeout |
| 586 | occurs. Once awakened or timed out, it re-acquires the lock and returns. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 587 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 588 | When the *timeout* argument is present and not ``None``, it should be a |
| 589 | floating point number specifying a timeout for the operation in seconds |
| 590 | (or fractions thereof). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 591 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 592 | When the underlying lock is an :class:`RLock`, it is not released using |
| 593 | its :meth:`release` method, since this may not actually unlock the lock |
| 594 | when it was acquired multiple times recursively. Instead, an internal |
| 595 | interface of the :class:`RLock` class is used, which really unlocks it |
| 596 | even when it has been recursively acquired several times. Another internal |
| 597 | interface is then used to restore the recursion level when the lock is |
| 598 | reacquired. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 599 | |
Georg Brandl | b9a4391 | 2010-10-28 09:03:20 +0000 | [diff] [blame] | 600 | The return value is ``True`` unless a given *timeout* expired, in which |
| 601 | case it is ``False``. |
| 602 | |
| 603 | .. versionchanged:: 3.2 |
| 604 | Previously, the method always returned ``None``. |
| 605 | |
Kristján Valur Jónsson | 6331520 | 2010-11-18 12:46:39 +0000 | [diff] [blame] | 606 | .. method:: wait_for(predicate, timeout=None) |
| 607 | |
| 608 | Wait until a condition evaluates to True. *predicate* should be a |
| 609 | callable which result will be interpreted as a boolean value. |
| 610 | A *timeout* may be provided giving the maximum time to wait. |
| 611 | |
| 612 | This utility method may call :meth:`wait` repeatedly until the predicate |
| 613 | is satisfied, or until a timeout occurs. The return value is |
| 614 | the last return value of the predicate and will evaluate to |
| 615 | ``False`` if the method timed out. |
| 616 | |
| 617 | Ignoring the timeout feature, calling this method is roughly equivalent to |
| 618 | writing:: |
| 619 | |
| 620 | while not predicate(): |
| 621 | cv.wait() |
| 622 | |
| 623 | Therefore, the same rules apply as with :meth:`wait`: The lock must be |
| 624 | held when called and is re-aquired on return. The predicate is evaluated |
| 625 | with the lock held. |
| 626 | |
Kristján Valur Jónsson | 6331520 | 2010-11-18 12:46:39 +0000 | [diff] [blame] | 627 | .. versionadded:: 3.2 |
| 628 | |
Eli Bendersky | d44af82 | 2011-11-12 20:44:25 +0200 | [diff] [blame] | 629 | .. method:: notify(n=1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 630 | |
Eli Bendersky | d44af82 | 2011-11-12 20:44:25 +0200 | [diff] [blame] | 631 | By default, wake up one thread waiting on this condition, if any. If the |
| 632 | calling thread has not acquired the lock when this method is called, a |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 633 | :exc:`RuntimeError` is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 634 | |
Eli Bendersky | d44af82 | 2011-11-12 20:44:25 +0200 | [diff] [blame] | 635 | This method wakes up at most *n* of the threads waiting for the condition |
| 636 | variable; it is a no-op if no threads are waiting. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 637 | |
Eli Bendersky | d44af82 | 2011-11-12 20:44:25 +0200 | [diff] [blame] | 638 | The current implementation wakes up exactly *n* threads, if at least *n* |
| 639 | threads are waiting. However, it's not safe to rely on this behavior. |
| 640 | A future, optimized implementation may occasionally wake up more than |
| 641 | *n* threads. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 642 | |
Eli Bendersky | d44af82 | 2011-11-12 20:44:25 +0200 | [diff] [blame] | 643 | Note: an awakened thread does not actually return from its :meth:`wait` |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 644 | call until it can reacquire the lock. Since :meth:`notify` does not |
| 645 | release the lock, its caller should. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 646 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 647 | .. method:: notify_all() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 648 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 649 | Wake up all threads waiting on this condition. This method acts like |
| 650 | :meth:`notify`, but wakes up all waiting threads instead of one. If the |
| 651 | calling thread has not acquired the lock when this method is called, a |
| 652 | :exc:`RuntimeError` is raised. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 653 | |
| 654 | |
| 655 | .. _semaphore-objects: |
| 656 | |
| 657 | Semaphore Objects |
| 658 | ----------------- |
| 659 | |
| 660 | This is one of the oldest synchronization primitives in the history of computer |
| 661 | science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 662 | used the names ``P()`` and ``V()`` instead of :meth:`~Semaphore.acquire` and |
| 663 | :meth:`~Semaphore.release`). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 664 | |
| 665 | A semaphore manages an internal counter which is decremented by each |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 666 | :meth:`~Semaphore.acquire` call and incremented by each :meth:`~Semaphore.release` |
| 667 | call. The counter can never go below zero; when :meth:`~Semaphore.acquire` |
| 668 | finds that it is zero, it blocks, waiting until some other thread calls |
| 669 | :meth:`~Semaphore.release`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 670 | |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 671 | Semaphores also support the :ref:`context manager protocol <with-locks>`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 672 | |
| 673 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 674 | .. class:: Semaphore(value=1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 675 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 676 | This class implements semaphore objects. A semaphore manages a counter |
| 677 | representing the number of :meth:`release` calls minus the number of |
| 678 | :meth:`acquire` calls, plus an initial value. The :meth:`acquire` method |
| 679 | blocks if necessary until it can return without making the counter negative. |
| 680 | If not given, *value* defaults to 1. |
| 681 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 682 | The optional argument gives the initial *value* for the internal counter; it |
| 683 | defaults to ``1``. If the *value* given is less than 0, :exc:`ValueError` is |
| 684 | raised. |
| 685 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 686 | .. versionchanged:: 3.3 |
| 687 | changed from a factory function to a class. |
| 688 | |
Antoine Pitrou | 0454af9 | 2010-04-17 23:51:58 +0000 | [diff] [blame] | 689 | .. method:: acquire(blocking=True, timeout=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 690 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 691 | Acquire a semaphore. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 692 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 693 | When invoked without arguments: if the internal counter is larger than |
| 694 | zero on entry, decrement it by one and return immediately. If it is zero |
| 695 | on entry, block, waiting until some other thread has called |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 696 | :meth:`~Semaphore.release` to make it larger than zero. This is done |
| 697 | with proper interlocking so that if multiple :meth:`acquire` calls are |
| 698 | blocked, :meth:`~Semaphore.release` will wake exactly one of them up. |
| 699 | The implementation may pick one at random, so the order in which |
| 700 | blocked threads are awakened should not be relied on. Returns |
| 701 | true (or blocks indefinitely). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 702 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 703 | When invoked with *blocking* set to false, do not block. If a call |
Antoine Pitrou | 0454af9 | 2010-04-17 23:51:58 +0000 | [diff] [blame] | 704 | without an argument would block, return false immediately; otherwise, |
| 705 | do the same thing as when called without arguments, and return true. |
| 706 | |
| 707 | When invoked with a *timeout* other than None, it will block for at |
| 708 | most *timeout* seconds. If acquire does not complete successfully in |
| 709 | that interval, return false. Return true otherwise. |
| 710 | |
| 711 | .. versionchanged:: 3.2 |
| 712 | The *timeout* parameter is new. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 713 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 714 | .. method:: release() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 715 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 716 | Release a semaphore, incrementing the internal counter by one. When it |
| 717 | was zero on entry and another thread is waiting for it to become larger |
| 718 | than zero again, wake up that thread. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 719 | |
| 720 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 721 | .. class:: BoundedSemaphore(value=1) |
| 722 | |
| 723 | Class implementing bounded semaphore objects. A bounded semaphore checks to |
| 724 | make sure its current value doesn't exceed its initial value. If it does, |
| 725 | :exc:`ValueError` is raised. In most situations semaphores are used to guard |
| 726 | resources with limited capacity. If the semaphore is released too many times |
| 727 | it's a sign of a bug. If not given, *value* defaults to 1. |
| 728 | |
| 729 | .. versionchanged:: 3.3 |
| 730 | changed from a factory function to a class. |
| 731 | |
| 732 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 733 | .. _semaphore-examples: |
| 734 | |
| 735 | :class:`Semaphore` Example |
| 736 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 737 | |
| 738 | Semaphores are often used to guard resources with limited capacity, for example, |
Georg Brandl | a572476 | 2011-01-06 19:28:18 +0000 | [diff] [blame] | 739 | a database server. In any situation where the size of the resource is fixed, |
| 740 | you should use a bounded semaphore. Before spawning any worker threads, your |
| 741 | main thread would initialize the semaphore:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 742 | |
| 743 | maxconnections = 5 |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 744 | # ... |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 745 | pool_sema = BoundedSemaphore(value=maxconnections) |
| 746 | |
| 747 | Once spawned, worker threads call the semaphore's acquire and release methods |
| 748 | when they need to connect to the server:: |
| 749 | |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 750 | with pool_sema: |
| 751 | conn = connectdb() |
| 752 | try: |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 753 | # ... use connection ... |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 754 | finally: |
| 755 | conn.close() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 756 | |
| 757 | The use of a bounded semaphore reduces the chance that a programming error which |
| 758 | causes the semaphore to be released more than it's acquired will go undetected. |
| 759 | |
| 760 | |
| 761 | .. _event-objects: |
| 762 | |
| 763 | Event Objects |
| 764 | ------------- |
| 765 | |
| 766 | This is one of the simplest mechanisms for communication between threads: one |
| 767 | thread signals an event and other threads wait for it. |
| 768 | |
| 769 | An event object manages an internal flag that can be set to true with the |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 770 | :meth:`~Event.set` method and reset to false with the :meth:`~Event.clear` |
| 771 | method. The :meth:`~Event.wait` method blocks until the flag is true. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 772 | |
| 773 | |
| 774 | .. class:: Event() |
| 775 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 776 | Class implementing event objects. An event manages a flag that can be set to |
| 777 | true with the :meth:`~Event.set` method and reset to false with the |
| 778 | :meth:`clear` method. The :meth:`wait` method blocks until the flag is true. |
| 779 | The flag is initially false. |
| 780 | |
| 781 | .. versionchanged:: 3.3 |
| 782 | changed from a factory function to a class. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 783 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 784 | .. method:: is_set() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 785 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 786 | Return true if and only if the internal flag is true. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 787 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 788 | .. method:: set() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 789 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 790 | Set the internal flag to true. All threads waiting for it to become true |
| 791 | are awakened. Threads that call :meth:`wait` once the flag is true will |
| 792 | not block at all. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 793 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 794 | .. method:: clear() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 795 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 796 | Reset the internal flag to false. Subsequently, threads calling |
Georg Brandl | 502d9a5 | 2009-07-26 15:02:41 +0000 | [diff] [blame] | 797 | :meth:`wait` will block until :meth:`.set` is called to set the internal |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 798 | flag to true again. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 799 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 800 | .. method:: wait(timeout=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 801 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 802 | Block until the internal flag is true. If the internal flag is true on |
| 803 | entry, return immediately. Otherwise, block until another thread calls |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 804 | :meth:`.set` to set the flag to true, or until the optional timeout occurs. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 805 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 806 | When the timeout argument is present and not ``None``, it should be a |
| 807 | floating point number specifying a timeout for the operation in seconds |
| 808 | (or fractions thereof). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 809 | |
Charles-François Natali | ded0348 | 2012-01-07 18:24:56 +0100 | [diff] [blame] | 810 | This method returns true if and only if the internal flag has been set to |
| 811 | true, either before the wait call or after the wait starts, so it will |
| 812 | always return ``True`` except if a timeout is given and the operation |
| 813 | times out. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 814 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 815 | .. versionchanged:: 3.1 |
| 816 | Previously, the method always returned ``None``. |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 817 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 818 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 819 | .. _timer-objects: |
| 820 | |
| 821 | Timer Objects |
| 822 | ------------- |
| 823 | |
| 824 | This class represents an action that should be run only after a certain amount |
| 825 | of time has passed --- a timer. :class:`Timer` is a subclass of :class:`Thread` |
| 826 | and as such also functions as an example of creating custom threads. |
| 827 | |
Serhiy Storchaka | 9e0ae53 | 2013-08-24 00:23:38 +0300 | [diff] [blame^] | 828 | Timers are started, as with threads, by calling their :meth:`~Timer.start` |
| 829 | method. The timer can be stopped (before its action has begun) by calling the |
| 830 | :meth:`~Timer.cancel` method. The interval the timer will wait before |
| 831 | executing its action may not be exactly the same as the interval specified by |
| 832 | the user. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 833 | |
| 834 | For example:: |
| 835 | |
| 836 | def hello(): |
Collin Winter | c79461b | 2007-09-01 23:34:30 +0000 | [diff] [blame] | 837 | print("hello, world") |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 838 | |
| 839 | t = Timer(30.0, hello) |
| 840 | t.start() # after 30 seconds, "hello, world" will be printed |
| 841 | |
| 842 | |
R David Murray | 19aeb43 | 2013-03-30 17:19:38 -0400 | [diff] [blame] | 843 | .. class:: Timer(interval, function, args=None, kwargs=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 844 | |
| 845 | Create a timer that will run *function* with arguments *args* and keyword |
| 846 | arguments *kwargs*, after *interval* seconds have passed. |
R David Murray | 19aeb43 | 2013-03-30 17:19:38 -0400 | [diff] [blame] | 847 | If *args* is None (the default) then an empty list will be used. |
| 848 | If *kwargs* is None (the default) then an empty dict will be used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 849 | |
R David Murray | ef4d286 | 2012-10-06 14:35:35 -0400 | [diff] [blame] | 850 | .. versionchanged:: 3.3 |
| 851 | changed from a factory function to a class. |
| 852 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 853 | .. method:: cancel() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 854 | |
Georg Brandl | 7a72b3a | 2009-07-26 14:48:09 +0000 | [diff] [blame] | 855 | Stop the timer, and cancel the execution of the timer's action. This will |
| 856 | only work if the timer is still in its waiting stage. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 857 | |
| 858 | |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 859 | Barrier Objects |
| 860 | --------------- |
| 861 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 862 | .. versionadded:: 3.2 |
| 863 | |
| 864 | This class provides a simple synchronization primitive for use by a fixed number |
| 865 | of threads that need to wait for each other. Each of the threads tries to pass |
Antoine Pitrou | 2c9f104 | 2012-04-10 22:35:53 +0200 | [diff] [blame] | 866 | the barrier by calling the :meth:`~Barrier.wait` method and will block until |
| 867 | all of the threads have made the call. At this points, the threads are released |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 868 | simultanously. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 869 | |
| 870 | The barrier can be reused any number of times for the same number of threads. |
| 871 | |
| 872 | As an example, here is a simple way to synchronize a client and server thread:: |
| 873 | |
| 874 | b = Barrier(2, timeout=5) |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 875 | |
| 876 | def server(): |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 877 | start_server() |
| 878 | b.wait() |
| 879 | while True: |
| 880 | connection = accept_connection() |
| 881 | process_server_connection(connection) |
| 882 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 883 | def client(): |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 884 | b.wait() |
| 885 | while True: |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 886 | connection = make_connection() |
| 887 | process_client_connection(connection) |
| 888 | |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 889 | |
| 890 | .. class:: Barrier(parties, action=None, timeout=None) |
| 891 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 892 | Create a barrier object for *parties* number of threads. An *action*, when |
| 893 | provided, is a callable to be called by one of the threads when they are |
| 894 | released. *timeout* is the default timeout value if none is specified for |
| 895 | the :meth:`wait` method. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 896 | |
| 897 | .. method:: wait(timeout=None) |
| 898 | |
| 899 | Pass the barrier. When all the threads party to the barrier have called |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 900 | this function, they are all released simultaneously. If a *timeout* is |
Ezio Melotti | e130a52 | 2011-10-19 10:58:56 +0300 | [diff] [blame] | 901 | provided, it is used in preference to any that was supplied to the class |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 902 | constructor. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 903 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 904 | The return value is an integer in the range 0 to *parties* -- 1, different |
Raymond Hettinger | 5cee47f | 2011-01-11 19:59:46 +0000 | [diff] [blame] | 905 | for each thread. This can be used to select a thread to do some special |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 906 | housekeeping, e.g.:: |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 907 | |
| 908 | i = barrier.wait() |
| 909 | if i == 0: |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 910 | # Only one thread needs to print this |
| 911 | print("passed the barrier") |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 912 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 913 | If an *action* was provided to the constructor, one of the threads will |
| 914 | have called it prior to being released. Should this call raise an error, |
| 915 | the barrier is put into the broken state. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 916 | |
| 917 | If the call times out, the barrier is put into the broken state. |
| 918 | |
| 919 | This method may raise a :class:`BrokenBarrierError` exception if the |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 920 | barrier is broken or reset while a thread is waiting. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 921 | |
| 922 | .. method:: reset() |
| 923 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 924 | Return the barrier to the default, empty state. Any threads waiting on it |
| 925 | will receive the :class:`BrokenBarrierError` exception. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 926 | |
| 927 | Note that using this function may can require some external |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 928 | synchronization if there are other threads whose state is unknown. If a |
| 929 | barrier is broken it may be better to just leave it and create a new one. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 930 | |
| 931 | .. method:: abort() |
| 932 | |
| 933 | Put the barrier into a broken state. This causes any active or future |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 934 | calls to :meth:`wait` to fail with the :class:`BrokenBarrierError`. Use |
| 935 | this for example if one of the needs to abort, to avoid deadlocking the |
| 936 | application. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 937 | |
| 938 | It may be preferable to simply create the barrier with a sensible |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 939 | *timeout* value to automatically guard against one of the threads going |
| 940 | awry. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 941 | |
| 942 | .. attribute:: parties |
| 943 | |
| 944 | The number of threads required to pass the barrier. |
| 945 | |
| 946 | .. attribute:: n_waiting |
| 947 | |
| 948 | The number of threads currently waiting in the barrier. |
| 949 | |
| 950 | .. attribute:: broken |
| 951 | |
| 952 | A boolean that is ``True`` if the barrier is in the broken state. |
| 953 | |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 954 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 955 | .. exception:: BrokenBarrierError |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 956 | |
Georg Brandl | 5bc1686 | 2010-10-28 13:07:50 +0000 | [diff] [blame] | 957 | This exception, a subclass of :exc:`RuntimeError`, is raised when the |
| 958 | :class:`Barrier` object is reset or broken. |
Kristján Valur Jónsson | 3be0003 | 2010-10-28 09:43:10 +0000 | [diff] [blame] | 959 | |
| 960 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 961 | .. _with-locks: |
| 962 | |
| 963 | Using locks, conditions, and semaphores in the :keyword:`with` statement |
| 964 | ------------------------------------------------------------------------ |
| 965 | |
| 966 | All of the objects provided by this module that have :meth:`acquire` and |
| 967 | :meth:`release` methods can be used as context managers for a :keyword:`with` |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 968 | statement. The :meth:`acquire` method will be called when the block is |
| 969 | entered, and :meth:`release` will be called when the block is exited. Hence, |
| 970 | the following snippet:: |
| 971 | |
| 972 | with some_lock: |
| 973 | # do something... |
| 974 | |
| 975 | is equivalent to:: |
| 976 | |
| 977 | some_lock.acquire() |
| 978 | try: |
| 979 | # do something... |
| 980 | finally: |
| 981 | some_lock.release() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 982 | |
| 983 | Currently, :class:`Lock`, :class:`RLock`, :class:`Condition`, |
| 984 | :class:`Semaphore`, and :class:`BoundedSemaphore` objects may be used as |
Antoine Pitrou | b96a354 | 2012-04-10 22:47:55 +0200 | [diff] [blame] | 985 | :keyword:`with` statement context managers. |