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