blob: 1f2b7630554d90d33aaee88fca22dae7a4e26f14 [file] [log] [blame]
Georg Brandl116aa622007-08-15 14:28:22 +00001:mod:`threading` --- Higher-level threading interface
2=====================================================
3
4.. module:: threading
5 :synopsis: Higher-level threading interface.
6
7
Georg Brandl2067bfd2008-05-25 13:05:15 +00008This module constructs higher-level threading interfaces on top of the lower
9level :mod:`_thread` module. See also the :mod:`queue` module.
Georg Brandl116aa622007-08-15 14:28:22 +000010
11The :mod:`dummy_threading` module is provided for situations where
Georg Brandl2067bfd2008-05-25 13:05:15 +000012:mod:`threading` cannot be used because :mod:`_thread` is missing.
Georg Brandl116aa622007-08-15 14:28:22 +000013
Benjamin Peterson8bdd5452008-08-18 22:38:41 +000014.. note::
15
Benjamin Petersonb3085c92008-09-01 23:09:31 +000016 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 Peterson8bdd5452008-08-18 22:38:41 +000019
Georg Brandl116aa622007-08-15 14:28:22 +000020This module defines the following functions and objects:
21
22
Benjamin Peterson672b8032008-06-11 19:14:14 +000023.. function:: active_count()
Georg Brandl116aa622007-08-15 14:28:22 +000024
25 Return the number of :class:`Thread` objects currently alive. The returned
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +000026 count is equal to the length of the list returned by :func:`.enumerate`.
Georg Brandl116aa622007-08-15 14:28:22 +000027
28
29.. function:: Condition()
30 :noindex:
31
32 A factory function that returns a new condition variable object. A condition
33 variable allows one or more threads to wait until they are notified by another
34 thread.
35
36
Benjamin Peterson672b8032008-06-11 19:14:14 +000037.. function:: current_thread()
Georg Brandl116aa622007-08-15 14:28:22 +000038
39 Return the current :class:`Thread` object, corresponding to the caller's thread
40 of control. If the caller's thread of control was not created through the
41 :mod:`threading` module, a dummy thread object with limited functionality is
42 returned.
43
44
45.. function:: enumerate()
46
Benjamin Peterson672b8032008-06-11 19:14:14 +000047 Return a list of all :class:`Thread` objects currently alive. The list
48 includes daemonic threads, dummy thread objects created by
49 :func:`current_thread`, and the main thread. It excludes terminated threads
50 and threads that have not yet been started.
Georg Brandl116aa622007-08-15 14:28:22 +000051
52
53.. function:: Event()
54 :noindex:
55
56 A factory function that returns a new event object. An event manages a flag
Georg Brandl502d9a52009-07-26 15:02:41 +000057 that can be set to true with the :meth:`~Event.set` method and reset to false
58 with the :meth:`clear` method. The :meth:`wait` method blocks until the flag
59 is true.
Georg Brandl116aa622007-08-15 14:28:22 +000060
61
62.. class:: local
63
64 A class that represents thread-local data. Thread-local data are data whose
65 values are thread specific. To manage thread-local data, just create an
66 instance of :class:`local` (or a subclass) and store attributes on it::
67
68 mydata = threading.local()
69 mydata.x = 1
70
71 The instance's values will be different for separate threads.
72
73 For more details and extensive examples, see the documentation string of the
74 :mod:`_threading_local` module.
75
Georg Brandl116aa622007-08-15 14:28:22 +000076
77.. function:: Lock()
78
79 A factory function that returns a new primitive lock object. Once a thread has
80 acquired it, subsequent attempts to acquire it block, until it is released; any
81 thread may release it.
82
83
84.. function:: RLock()
85
86 A factory function that returns a new reentrant lock object. A reentrant lock
87 must be released by the thread that acquired it. Once a thread has acquired a
88 reentrant lock, the same thread may acquire it again without blocking; the
89 thread must release it once for each time it has acquired it.
90
91
Georg Brandl7f01a132009-09-16 15:58:14 +000092.. function:: Semaphore(value=1)
Georg Brandl116aa622007-08-15 14:28:22 +000093 :noindex:
94
95 A factory function that returns a new semaphore object. A semaphore manages a
96 counter representing the number of :meth:`release` calls minus the number of
97 :meth:`acquire` calls, plus an initial value. The :meth:`acquire` method blocks
98 if necessary until it can return without making the counter negative. If not
99 given, *value* defaults to 1.
100
101
Georg Brandl7f01a132009-09-16 15:58:14 +0000102.. function:: BoundedSemaphore(value=1)
Georg Brandl116aa622007-08-15 14:28:22 +0000103
104 A factory function that returns a new bounded semaphore object. A bounded
105 semaphore checks to make sure its current value doesn't exceed its initial
106 value. If it does, :exc:`ValueError` is raised. In most situations semaphores
107 are used to guard resources with limited capacity. If the semaphore is released
108 too many times it's a sign of a bug. If not given, *value* defaults to 1.
109
110
111.. class:: Thread
112
113 A class that represents a thread of control. This class can be safely
114 subclassed in a limited fashion.
115
116
117.. class:: Timer
118
119 A thread that executes a function after a specified interval has passed.
120
121
122.. function:: settrace(func)
123
124 .. index:: single: trace function
125
126 Set a trace function for all threads started from the :mod:`threading` module.
127 The *func* will be passed to :func:`sys.settrace` for each thread, before its
128 :meth:`run` method is called.
129
Georg Brandl116aa622007-08-15 14:28:22 +0000130
131.. function:: setprofile(func)
132
133 .. index:: single: profile function
134
135 Set a profile function for all threads started from the :mod:`threading` module.
136 The *func* will be passed to :func:`sys.setprofile` for each thread, before its
137 :meth:`run` method is called.
138
Georg Brandl116aa622007-08-15 14:28:22 +0000139
140.. function:: stack_size([size])
141
142 Return the thread stack size used when creating new threads. The optional
143 *size* argument specifies the stack size to be used for subsequently created
144 threads, and must be 0 (use platform or configured default) or a positive
145 integer value of at least 32,768 (32kB). If changing the thread stack size is
146 unsupported, a :exc:`ThreadError` is raised. If the specified stack size is
147 invalid, a :exc:`ValueError` is raised and the stack size is unmodified. 32kB
148 is currently the minimum supported stack size value to guarantee sufficient
149 stack space for the interpreter itself. Note that some platforms may have
150 particular restrictions on values for the stack size, such as requiring a
151 minimum stack size > 32kB or requiring allocation in multiples of the system
152 memory page size - platform documentation should be referred to for more
153 information (4kB pages are common; using multiples of 4096 for the stack size is
154 the suggested approach in the absence of more specific information).
155 Availability: Windows, systems with POSIX threads.
156
Georg Brandl116aa622007-08-15 14:28:22 +0000157
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000158This module also defines the following constant:
159
160.. data:: TIMEOUT_MAX
161
162 The maximum value allowed for the *timeout* parameter of blocking functions
163 (:meth:`Lock.acquire`, :meth:`RLock.acquire`, :meth:`Condition.wait`, etc.).
164 Specifiying a timeout greater than this value will raise an
165 :exc:`OverflowError`.
166
167
Georg Brandl116aa622007-08-15 14:28:22 +0000168Detailed interfaces for the objects are documented below.
169
170The design of this module is loosely based on Java's threading model. However,
171where Java makes locks and condition variables basic behavior of every object,
172they are separate objects in Python. Python's :class:`Thread` class supports a
173subset of the behavior of Java's Thread class; currently, there are no
174priorities, no thread groups, and threads cannot be destroyed, stopped,
175suspended, resumed, or interrupted. The static methods of Java's Thread class,
176when implemented, are mapped to module-level functions.
177
178All of the methods described below are executed atomically.
179
180
Georg Brandla971c652008-11-07 09:39:56 +0000181.. _thread-objects:
182
183Thread Objects
184--------------
185
186This class represents an activity that is run in a separate thread of control.
187There are two ways to specify the activity: by passing a callable object to the
188constructor, or by overriding the :meth:`run` method in a subclass. No other
189methods (except for the constructor) should be overridden in a subclass. In
190other words, *only* override the :meth:`__init__` and :meth:`run` methods of
191this class.
192
193Once a thread object is created, its activity must be started by calling the
194thread's :meth:`start` method. This invokes the :meth:`run` method in a
195separate thread of control.
196
197Once the thread's activity is started, the thread is considered 'alive'. It
198stops being alive when its :meth:`run` method terminates -- either normally, or
199by raising an unhandled exception. The :meth:`is_alive` method tests whether the
200thread is alive.
201
202Other threads can call a thread's :meth:`join` method. This blocks the calling
203thread until the thread whose :meth:`join` method is called is terminated.
204
205A thread has a name. The name can be passed to the constructor, and read or
206changed through the :attr:`name` attribute.
207
208A thread can be flagged as a "daemon thread". The significance of this flag is
209that the entire Python program exits when only daemon threads are left. The
210initial value is inherited from the creating thread. The flag can be set
Benjamin Peterson5c6d7872009-02-06 02:40:07 +0000211through the :attr:`daemon` property.
Georg Brandla971c652008-11-07 09:39:56 +0000212
213There is a "main thread" object; this corresponds to the initial thread of
214control in the Python program. It is not a daemon thread.
215
216There is the possibility that "dummy thread objects" are created. These are
217thread objects corresponding to "alien threads", which are threads of control
218started outside the threading module, such as directly from C code. Dummy
219thread objects have limited functionality; they are always considered alive and
220daemonic, and cannot be :meth:`join`\ ed. They are never deleted, since it is
221impossible to detect the termination of alien threads.
222
223
224.. class:: Thread(group=None, target=None, name=None, args=(), kwargs={})
225
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000226 This constructor should always be called with keyword arguments. Arguments
227 are:
Georg Brandla971c652008-11-07 09:39:56 +0000228
229 *group* should be ``None``; reserved for future extension when a
230 :class:`ThreadGroup` class is implemented.
231
232 *target* is the callable object to be invoked by the :meth:`run` method.
233 Defaults to ``None``, meaning nothing is called.
234
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000235 *name* is the thread name. By default, a unique name is constructed of the
236 form "Thread-*N*" where *N* is a small decimal number.
Georg Brandla971c652008-11-07 09:39:56 +0000237
238 *args* is the argument tuple for the target invocation. Defaults to ``()``.
239
240 *kwargs* is a dictionary of keyword arguments for the target invocation.
241 Defaults to ``{}``.
242
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000243 If the subclass overrides the constructor, it must make sure to invoke the
244 base class constructor (``Thread.__init__()``) before doing anything else to
245 the thread.
Georg Brandla971c652008-11-07 09:39:56 +0000246
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000247 .. method:: start()
Georg Brandla971c652008-11-07 09:39:56 +0000248
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000249 Start the thread's activity.
Georg Brandla971c652008-11-07 09:39:56 +0000250
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000251 It must be called at most once per thread object. It arranges for the
252 object's :meth:`run` method to be invoked in a separate thread of control.
Georg Brandla971c652008-11-07 09:39:56 +0000253
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000254 This method will raise a :exc:`RuntimeException` if called more than once
255 on the same thread object.
Georg Brandla971c652008-11-07 09:39:56 +0000256
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000257 .. method:: run()
Georg Brandla971c652008-11-07 09:39:56 +0000258
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000259 Method representing the thread's activity.
Georg Brandla971c652008-11-07 09:39:56 +0000260
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000261 You may override this method in a subclass. The standard :meth:`run`
262 method invokes the callable object passed to the object's constructor as
263 the *target* argument, if any, with sequential and keyword arguments taken
264 from the *args* and *kwargs* arguments, respectively.
Georg Brandla971c652008-11-07 09:39:56 +0000265
Georg Brandl7f01a132009-09-16 15:58:14 +0000266 .. method:: join(timeout=None)
Georg Brandla971c652008-11-07 09:39:56 +0000267
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000268 Wait until the thread terminates. This blocks the calling thread until the
269 thread whose :meth:`join` method is called terminates -- either normally
270 or through an unhandled exception -- or until the optional timeout occurs.
Georg Brandla971c652008-11-07 09:39:56 +0000271
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000272 When the *timeout* argument is present and not ``None``, it should be a
273 floating point number specifying a timeout for the operation in seconds
274 (or fractions thereof). As :meth:`join` always returns ``None``, you must
275 call :meth:`is_alive` after :meth:`join` to decide whether a timeout
276 happened -- if the thread is still alive, the :meth:`join` call timed out.
Georg Brandla971c652008-11-07 09:39:56 +0000277
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000278 When the *timeout* argument is not present or ``None``, the operation will
279 block until the thread terminates.
Georg Brandla971c652008-11-07 09:39:56 +0000280
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000281 A thread can be :meth:`join`\ ed many times.
Georg Brandla971c652008-11-07 09:39:56 +0000282
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000283 :meth:`join` raises a :exc:`RuntimeError` if an attempt is made to join
284 the current thread as that would cause a deadlock. It is also an error to
285 :meth:`join` a thread before it has been started and attempts to do so
286 raises the same exception.
Georg Brandla971c652008-11-07 09:39:56 +0000287
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000288 .. attribute:: name
Georg Brandla971c652008-11-07 09:39:56 +0000289
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000290 A string used for identification purposes only. It has no semantics.
291 Multiple threads may be given the same name. The initial name is set by
292 the constructor.
Georg Brandla971c652008-11-07 09:39:56 +0000293
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000294 .. method:: getName()
295 setName()
Georg Brandla971c652008-11-07 09:39:56 +0000296
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000297 Old getter/setter API for :attr:`~Thread.name`; use it directly as a
298 property instead.
Georg Brandla971c652008-11-07 09:39:56 +0000299
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000300 .. attribute:: ident
Georg Brandla971c652008-11-07 09:39:56 +0000301
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000302 The 'thread identifier' of this thread or ``None`` if the thread has not
303 been started. This is a nonzero integer. See the
304 :func:`thread.get_ident()` function. Thread identifiers may be recycled
305 when a thread exits and another thread is created. The identifier is
306 available even after the thread has exited.
Georg Brandla971c652008-11-07 09:39:56 +0000307
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000308 .. method:: is_alive()
Georg Brandla971c652008-11-07 09:39:56 +0000309
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000310 Return whether the thread is alive.
Georg Brandl770b0be2009-01-02 20:10:05 +0000311
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000312 Roughly, a thread is alive from the moment the :meth:`start` method
313 returns until its :meth:`run` method terminates. The module function
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000314 :func:`.enumerate` returns a list of all alive threads.
Georg Brandl770b0be2009-01-02 20:10:05 +0000315
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000316 .. attribute:: daemon
Georg Brandl770b0be2009-01-02 20:10:05 +0000317
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000318 A boolean value indicating whether this thread is a daemon thread (True)
319 or not (False). This must be set before :meth:`start` is called,
320 otherwise :exc:`RuntimeError` is raised. Its initial value is inherited
321 from the creating thread; the main thread is not a daemon thread and
322 therefore all threads created in the main thread default to :attr:`daemon`
323 = ``False``.
Georg Brandla971c652008-11-07 09:39:56 +0000324
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000325 The entire Python program exits when no alive non-daemon threads are left.
Georg Brandla971c652008-11-07 09:39:56 +0000326
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000327 .. method:: isDaemon()
328 setDaemon()
Georg Brandla971c652008-11-07 09:39:56 +0000329
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000330 Old getter/setter API for :attr:`~Thread.daemon`; use it directly as a
331 property instead.
Georg Brandl770b0be2009-01-02 20:10:05 +0000332
333
Georg Brandl116aa622007-08-15 14:28:22 +0000334.. _lock-objects:
335
336Lock Objects
337------------
338
339A primitive lock is a synchronization primitive that is not owned by a
340particular thread when locked. In Python, it is currently the lowest level
Georg Brandl2067bfd2008-05-25 13:05:15 +0000341synchronization primitive available, implemented directly by the :mod:`_thread`
Georg Brandl116aa622007-08-15 14:28:22 +0000342extension module.
343
344A primitive lock is in one of two states, "locked" or "unlocked". It is created
345in the unlocked state. It has two basic methods, :meth:`acquire` and
346:meth:`release`. When the state is unlocked, :meth:`acquire` changes the state
347to locked and returns immediately. When the state is locked, :meth:`acquire`
348blocks until a call to :meth:`release` in another thread changes it to unlocked,
349then the :meth:`acquire` call resets it to locked and returns. The
350:meth:`release` method should only be called in the locked state; it changes the
351state to unlocked and returns immediately. If an attempt is made to release an
352unlocked lock, a :exc:`RuntimeError` will be raised.
353
354When more than one thread is blocked in :meth:`acquire` waiting for the state to
355turn to unlocked, only one thread proceeds when a :meth:`release` call resets
356the state to unlocked; which one of the waiting threads proceeds is not defined,
357and may vary across implementations.
358
359All methods are executed atomically.
360
361
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000362.. method:: Lock.acquire(blocking=True, timeout=-1)
Georg Brandl116aa622007-08-15 14:28:22 +0000363
364 Acquire a lock, blocking or non-blocking.
365
366 When invoked without arguments, block until the lock is unlocked, then set it to
367 locked, and return true.
368
369 When invoked with the *blocking* argument set to true, do the same thing as when
370 called without arguments, and return true.
371
372 When invoked with the *blocking* argument set to false, do not block. If a call
373 without an argument would block, return false immediately; otherwise, do the
374 same thing as when called without arguments, and return true.
375
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000376 When invoked with the floating-point *timeout* argument set to a positive
377 value, block for at most the number of seconds specified by *timeout*
378 and as long as the lock cannot be acquired. A negative *timeout* argument
379 specifies an unbounded wait. It is forbidden to specify a *timeout*
380 when *blocking* is false.
381
382 The return value is ``True`` if the lock is acquired successfully,
383 ``False`` if not (for example if the *timeout* expired).
384
Georg Brandl116aa622007-08-15 14:28:22 +0000385
386.. method:: Lock.release()
387
388 Release a lock.
389
390 When the lock is locked, reset it to unlocked, and return. If any other threads
391 are blocked waiting for the lock to become unlocked, allow exactly one of them
392 to proceed.
393
394 Do not call this method when the lock is unlocked.
395
396 There is no return value.
397
398
399.. _rlock-objects:
400
401RLock Objects
402-------------
403
404A reentrant lock is a synchronization primitive that may be acquired multiple
405times by the same thread. Internally, it uses the concepts of "owning thread"
406and "recursion level" in addition to the locked/unlocked state used by primitive
407locks. In the locked state, some thread owns the lock; in the unlocked state,
408no thread owns it.
409
410To lock the lock, a thread calls its :meth:`acquire` method; this returns once
411the thread owns the lock. To unlock the lock, a thread calls its
412:meth:`release` method. :meth:`acquire`/:meth:`release` call pairs may be
413nested; only the final :meth:`release` (the :meth:`release` of the outermost
414pair) resets the lock to unlocked and allows another thread blocked in
415:meth:`acquire` to proceed.
416
417
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000418.. method:: RLock.acquire(blocking=True, timeout=-1)
Georg Brandl116aa622007-08-15 14:28:22 +0000419
420 Acquire a lock, blocking or non-blocking.
421
422 When invoked without arguments: if this thread already owns the lock, increment
423 the recursion level by one, and return immediately. Otherwise, if another
424 thread owns the lock, block until the lock is unlocked. Once the lock is
425 unlocked (not owned by any thread), then grab ownership, set the recursion level
426 to one, and return. If more than one thread is blocked waiting until the lock
427 is unlocked, only one at a time will be able to grab ownership of the lock.
428 There is no return value in this case.
429
430 When invoked with the *blocking* argument set to true, do the same thing as when
431 called without arguments, and return true.
432
433 When invoked with the *blocking* argument set to false, do not block. If a call
434 without an argument would block, return false immediately; otherwise, do the
435 same thing as when called without arguments, and return true.
436
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000437 When invoked with the floating-point *timeout* argument set to a positive
438 value, block for at most the number of seconds specified by *timeout*
439 and as long as the lock cannot be acquired. Return true if the lock has
440 been acquired, false if the timeout has elapsed.
441
Georg Brandl116aa622007-08-15 14:28:22 +0000442
443.. method:: RLock.release()
444
445 Release a lock, decrementing the recursion level. If after the decrement it is
446 zero, reset the lock to unlocked (not owned by any thread), and if any other
447 threads are blocked waiting for the lock to become unlocked, allow exactly one
448 of them to proceed. If after the decrement the recursion level is still
449 nonzero, the lock remains locked and owned by the calling thread.
450
451 Only call this method when the calling thread owns the lock. A
452 :exc:`RuntimeError` is raised if this method is called when the lock is
453 unlocked.
454
455 There is no return value.
456
457
458.. _condition-objects:
459
460Condition Objects
461-----------------
462
463A condition variable is always associated with some kind of lock; this can be
464passed in or one will be created by default. (Passing one in is useful when
465several condition variables must share the same lock.)
466
467A condition variable has :meth:`acquire` and :meth:`release` methods that call
468the corresponding methods of the associated lock. It also has a :meth:`wait`
Georg Brandlf9926402008-06-13 06:32:25 +0000469method, and :meth:`notify` and :meth:`notify_all` methods. These three must only
Georg Brandl116aa622007-08-15 14:28:22 +0000470be called when the calling thread has acquired the lock, otherwise a
471:exc:`RuntimeError` is raised.
472
473The :meth:`wait` method releases the lock, and then blocks until it is awakened
Georg Brandlf9926402008-06-13 06:32:25 +0000474by a :meth:`notify` or :meth:`notify_all` call for the same condition variable in
Georg Brandl116aa622007-08-15 14:28:22 +0000475another thread. Once awakened, it re-acquires the lock and returns. It is also
476possible to specify a timeout.
477
478The :meth:`notify` method wakes up one of the threads waiting for the condition
Georg Brandlf9926402008-06-13 06:32:25 +0000479variable, if any are waiting. The :meth:`notify_all` method wakes up all threads
Georg Brandl116aa622007-08-15 14:28:22 +0000480waiting for the condition variable.
481
Georg Brandlf9926402008-06-13 06:32:25 +0000482Note: the :meth:`notify` and :meth:`notify_all` methods don't release the lock;
Georg Brandl116aa622007-08-15 14:28:22 +0000483this means that the thread or threads awakened will not return from their
484:meth:`wait` call immediately, but only when the thread that called
Georg Brandlf9926402008-06-13 06:32:25 +0000485:meth:`notify` or :meth:`notify_all` finally relinquishes ownership of the lock.
Georg Brandl116aa622007-08-15 14:28:22 +0000486
487Tip: the typical programming style using condition variables uses the lock to
488synchronize access to some shared state; threads that are interested in a
489particular change of state call :meth:`wait` repeatedly until they see the
490desired state, while threads that modify the state call :meth:`notify` or
Georg Brandlf9926402008-06-13 06:32:25 +0000491:meth:`notify_all` when they change the state in such a way that it could
Georg Brandl116aa622007-08-15 14:28:22 +0000492possibly be a desired state for one of the waiters. For example, the following
493code is a generic producer-consumer situation with unlimited buffer capacity::
494
495 # Consume one item
496 cv.acquire()
497 while not an_item_is_available():
498 cv.wait()
499 get_an_available_item()
500 cv.release()
501
502 # Produce one item
503 cv.acquire()
504 make_an_item_available()
505 cv.notify()
506 cv.release()
507
Georg Brandlf9926402008-06-13 06:32:25 +0000508To choose between :meth:`notify` and :meth:`notify_all`, consider whether one
Georg Brandl116aa622007-08-15 14:28:22 +0000509state change can be interesting for only one or several waiting threads. E.g.
510in a typical producer-consumer situation, adding one item to the buffer only
511needs to wake up one consumer thread.
512
513
Georg Brandl7f01a132009-09-16 15:58:14 +0000514.. class:: Condition(lock=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000515
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000516 If the *lock* argument is given and not ``None``, it must be a :class:`Lock`
517 or :class:`RLock` object, and it is used as the underlying lock. Otherwise,
518 a new :class:`RLock` object is created and used as the underlying lock.
Georg Brandl116aa622007-08-15 14:28:22 +0000519
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000520 .. method:: acquire(*args)
Georg Brandl116aa622007-08-15 14:28:22 +0000521
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000522 Acquire the underlying lock. This method calls the corresponding method on
523 the underlying lock; the return value is whatever that method returns.
Georg Brandl116aa622007-08-15 14:28:22 +0000524
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000525 .. method:: release()
Georg Brandl116aa622007-08-15 14:28:22 +0000526
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000527 Release the underlying lock. This method calls the corresponding method on
528 the underlying lock; there is no return value.
Georg Brandl116aa622007-08-15 14:28:22 +0000529
Georg Brandl7f01a132009-09-16 15:58:14 +0000530 .. method:: wait(timeout=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000531
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000532 Wait until notified or until a timeout occurs. If the calling thread has
533 not acquired the lock when this method is called, a :exc:`RuntimeError` is
534 raised.
Georg Brandl116aa622007-08-15 14:28:22 +0000535
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000536 This method releases the underlying lock, and then blocks until it is
537 awakened by a :meth:`notify` or :meth:`notify_all` call for the same
538 condition variable in another thread, or until the optional timeout
539 occurs. Once awakened or timed out, it re-acquires the lock and returns.
Georg Brandl116aa622007-08-15 14:28:22 +0000540
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000541 When the *timeout* argument is present and not ``None``, it should be a
542 floating point number specifying a timeout for the operation in seconds
543 (or fractions thereof).
Georg Brandl116aa622007-08-15 14:28:22 +0000544
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000545 When the underlying lock is an :class:`RLock`, it is not released using
546 its :meth:`release` method, since this may not actually unlock the lock
547 when it was acquired multiple times recursively. Instead, an internal
548 interface of the :class:`RLock` class is used, which really unlocks it
549 even when it has been recursively acquired several times. Another internal
550 interface is then used to restore the recursion level when the lock is
551 reacquired.
Georg Brandl116aa622007-08-15 14:28:22 +0000552
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000553 .. method:: notify()
Georg Brandl116aa622007-08-15 14:28:22 +0000554
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000555 Wake up a thread waiting on this condition, if any. If the calling thread
556 has not acquired the lock when this method is called, a
557 :exc:`RuntimeError` is raised.
Georg Brandl116aa622007-08-15 14:28:22 +0000558
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000559 This method wakes up one of the threads waiting for the condition
560 variable, if any are waiting; it is a no-op if no threads are waiting.
Georg Brandl116aa622007-08-15 14:28:22 +0000561
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000562 The current implementation wakes up exactly one thread, if any are
563 waiting. However, it's not safe to rely on this behavior. A future,
564 optimized implementation may occasionally wake up more than one thread.
Georg Brandl116aa622007-08-15 14:28:22 +0000565
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000566 Note: the awakened thread does not actually return from its :meth:`wait`
567 call until it can reacquire the lock. Since :meth:`notify` does not
568 release the lock, its caller should.
Georg Brandl116aa622007-08-15 14:28:22 +0000569
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000570 .. method:: notify_all()
Georg Brandl116aa622007-08-15 14:28:22 +0000571
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000572 Wake up all threads waiting on this condition. This method acts like
573 :meth:`notify`, but wakes up all waiting threads instead of one. If the
574 calling thread has not acquired the lock when this method is called, a
575 :exc:`RuntimeError` is raised.
Georg Brandl116aa622007-08-15 14:28:22 +0000576
577
578.. _semaphore-objects:
579
580Semaphore Objects
581-----------------
582
583This is one of the oldest synchronization primitives in the history of computer
584science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he
585used :meth:`P` and :meth:`V` instead of :meth:`acquire` and :meth:`release`).
586
587A semaphore manages an internal counter which is decremented by each
588:meth:`acquire` call and incremented by each :meth:`release` call. The counter
589can never go below zero; when :meth:`acquire` finds that it is zero, it blocks,
590waiting until some other thread calls :meth:`release`.
591
592
Georg Brandl7f01a132009-09-16 15:58:14 +0000593.. class:: Semaphore(value=1)
Georg Brandl116aa622007-08-15 14:28:22 +0000594
595 The optional argument gives the initial *value* for the internal counter; it
596 defaults to ``1``. If the *value* given is less than 0, :exc:`ValueError` is
597 raised.
598
Georg Brandl7f01a132009-09-16 15:58:14 +0000599 .. method:: acquire(blocking=True)
Georg Brandl116aa622007-08-15 14:28:22 +0000600
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000601 Acquire a semaphore.
Georg Brandl116aa622007-08-15 14:28:22 +0000602
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000603 When invoked without arguments: if the internal counter is larger than
604 zero on entry, decrement it by one and return immediately. If it is zero
605 on entry, block, waiting until some other thread has called
606 :meth:`release` to make it larger than zero. This is done with proper
607 interlocking so that if multiple :meth:`acquire` calls are blocked,
608 :meth:`release` will wake exactly one of them up. The implementation may
609 pick one at random, so the order in which blocked threads are awakened
610 should not be relied on. There is no return value in this case.
Georg Brandl116aa622007-08-15 14:28:22 +0000611
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000612 When invoked with *blocking* set to true, do the same thing as when called
613 without arguments, and return true.
Georg Brandl116aa622007-08-15 14:28:22 +0000614
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000615 When invoked with *blocking* set to false, do not block. If a call
616 without an argument would block, return false immediately; otherwise, do
617 the same thing as when called without arguments, and return true.
Georg Brandl116aa622007-08-15 14:28:22 +0000618
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000619 .. method:: release()
Georg Brandl116aa622007-08-15 14:28:22 +0000620
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000621 Release a semaphore, incrementing the internal counter by one. When it
622 was zero on entry and another thread is waiting for it to become larger
623 than zero again, wake up that thread.
Georg Brandl116aa622007-08-15 14:28:22 +0000624
625
626.. _semaphore-examples:
627
628:class:`Semaphore` Example
629^^^^^^^^^^^^^^^^^^^^^^^^^^
630
631Semaphores are often used to guard resources with limited capacity, for example,
632a database server. In any situation where the size of the resource size is
633fixed, you should use a bounded semaphore. Before spawning any worker threads,
634your main thread would initialize the semaphore::
635
636 maxconnections = 5
637 ...
638 pool_sema = BoundedSemaphore(value=maxconnections)
639
640Once spawned, worker threads call the semaphore's acquire and release methods
641when they need to connect to the server::
642
643 pool_sema.acquire()
644 conn = connectdb()
645 ... use connection ...
646 conn.close()
647 pool_sema.release()
648
649The use of a bounded semaphore reduces the chance that a programming error which
650causes the semaphore to be released more than it's acquired will go undetected.
651
652
653.. _event-objects:
654
655Event Objects
656-------------
657
658This is one of the simplest mechanisms for communication between threads: one
659thread signals an event and other threads wait for it.
660
661An event object manages an internal flag that can be set to true with the
Georg Brandl502d9a52009-07-26 15:02:41 +0000662:meth:`~Event.set` method and reset to false with the :meth:`clear` method. The
Georg Brandl116aa622007-08-15 14:28:22 +0000663:meth:`wait` method blocks until the flag is true.
664
665
666.. class:: Event()
667
668 The internal flag is initially false.
669
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000670 .. method:: is_set()
Georg Brandl116aa622007-08-15 14:28:22 +0000671
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000672 Return true if and only if the internal flag is true.
Georg Brandl116aa622007-08-15 14:28:22 +0000673
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000674 .. method:: set()
Georg Brandl116aa622007-08-15 14:28:22 +0000675
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000676 Set the internal flag to true. All threads waiting for it to become true
677 are awakened. Threads that call :meth:`wait` once the flag is true will
678 not block at all.
Georg Brandl116aa622007-08-15 14:28:22 +0000679
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000680 .. method:: clear()
Georg Brandl116aa622007-08-15 14:28:22 +0000681
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000682 Reset the internal flag to false. Subsequently, threads calling
Georg Brandl502d9a52009-07-26 15:02:41 +0000683 :meth:`wait` will block until :meth:`.set` is called to set the internal
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000684 flag to true again.
Georg Brandl116aa622007-08-15 14:28:22 +0000685
Georg Brandl7f01a132009-09-16 15:58:14 +0000686 .. method:: wait(timeout=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000687
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000688 Block until the internal flag is true. If the internal flag is true on
689 entry, return immediately. Otherwise, block until another thread calls
690 :meth:`set` to set the flag to true, or until the optional timeout occurs.
Georg Brandl116aa622007-08-15 14:28:22 +0000691
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000692 When the timeout argument is present and not ``None``, it should be a
693 floating point number specifying a timeout for the operation in seconds
694 (or fractions thereof).
Georg Brandl116aa622007-08-15 14:28:22 +0000695
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000696 This method returns the internal flag on exit, so it will always return
697 ``True`` except if a timeout is given and the operation times out.
Georg Brandl116aa622007-08-15 14:28:22 +0000698
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000699 .. versionchanged:: 3.1
700 Previously, the method always returned ``None``.
Benjamin Petersond23f8222009-04-05 19:13:16 +0000701
Georg Brandl116aa622007-08-15 14:28:22 +0000702
Georg Brandl116aa622007-08-15 14:28:22 +0000703.. _timer-objects:
704
705Timer Objects
706-------------
707
708This class represents an action that should be run only after a certain amount
709of time has passed --- a timer. :class:`Timer` is a subclass of :class:`Thread`
710and as such also functions as an example of creating custom threads.
711
712Timers are started, as with threads, by calling their :meth:`start` method. The
713timer can be stopped (before its action has begun) by calling the :meth:`cancel`
714method. The interval the timer will wait before executing its action may not be
715exactly the same as the interval specified by the user.
716
717For example::
718
719 def hello():
Collin Winterc79461b2007-09-01 23:34:30 +0000720 print("hello, world")
Georg Brandl116aa622007-08-15 14:28:22 +0000721
722 t = Timer(30.0, hello)
723 t.start() # after 30 seconds, "hello, world" will be printed
724
725
726.. class:: Timer(interval, function, args=[], kwargs={})
727
728 Create a timer that will run *function* with arguments *args* and keyword
729 arguments *kwargs*, after *interval* seconds have passed.
730
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000731 .. method:: cancel()
Georg Brandl116aa622007-08-15 14:28:22 +0000732
Georg Brandl7a72b3a2009-07-26 14:48:09 +0000733 Stop the timer, and cancel the execution of the timer's action. This will
734 only work if the timer is still in its waiting stage.
Georg Brandl116aa622007-08-15 14:28:22 +0000735
736
737.. _with-locks:
738
739Using locks, conditions, and semaphores in the :keyword:`with` statement
740------------------------------------------------------------------------
741
742All of the objects provided by this module that have :meth:`acquire` and
743:meth:`release` methods can be used as context managers for a :keyword:`with`
744statement. The :meth:`acquire` method will be called when the block is entered,
745and :meth:`release` will be called when the block is exited.
746
747Currently, :class:`Lock`, :class:`RLock`, :class:`Condition`,
748:class:`Semaphore`, and :class:`BoundedSemaphore` objects may be used as
749:keyword:`with` statement context managers. For example::
750
Georg Brandl116aa622007-08-15 14:28:22 +0000751 import threading
752
753 some_rlock = threading.RLock()
754
755 with some_rlock:
Collin Winterc79461b2007-09-01 23:34:30 +0000756 print("some_rlock is locked while this executes")
Georg Brandl116aa622007-08-15 14:28:22 +0000757
Christian Heimesdd15f6c2008-03-16 00:07:10 +0000758
759.. _threaded-imports:
760
761Importing in threaded code
762--------------------------
763
764While the import machinery is thread safe, there are two key
765restrictions on threaded imports due to inherent limitations in the way
766that thread safety is provided:
767
768* Firstly, other than in the main module, an import should not have the
769 side effect of spawning a new thread and then waiting for that thread in
770 any way. Failing to abide by this restriction can lead to a deadlock if
771 the spawned thread directly or indirectly attempts to import a module.
772* Secondly, all import attempts must be completed before the interpreter
773 starts shutting itself down. This can be most easily achieved by only
774 performing imports from non-daemon threads created through the threading
775 module. Daemon threads and threads created directly with the thread
776 module will require some other form of synchronization to ensure they do
777 not attempt imports after system shutdown has commenced. Failure to
778 abide by this restriction will lead to intermittent exceptions and
779 crashes during interpreter shutdown (as the late imports attempt to
780 access machinery which is no longer in a valid state).