cpython-lru_cache-weakref: Lib/threading

annotate Lib/threading_api.py @ 9383:2b34461ba4a3 legacy-trunk

PyMapping_SetItemString() returns int, not an object.

author	Guido van Rossum <guido@python.org>
date	Fri, 16 Oct 1998 17:43:53 +0000
parents	f88f402417f2
children

rev	line source
7949 58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	1 """Proposed new higher-level threading interfaces.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	2
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	3 This module is safe for use with 'from threading import *'. It
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	4 defines the following objects:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	5
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	6 Lock()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	7 A factory function that returns a new primitive lock object. Once
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	8 a thread has acquired it, subsequent attempts to acquire it block,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	9 until it is released; any thread may release it.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	10
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	11 RLock()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	12 A factory function that returns a new reentrant lock object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	13 A reentrant lock must be released by the thread that acquired it.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	14 Once a thread has acquired a reentrant lock, the same thread may
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	15 acquire it again without blocking; the thread must release it once
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	16 for each time it has acquired it.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	17
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	18 Condition()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	19 A factory function that returns a new condition variable object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	20 A condition variable allows one or more threads to wait until they
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	21 are notified by another thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	22
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	23 Semaphore()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	24 A factory function that returns a new semaphore object. A
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	25 semaphore manages a counter representing the number of release()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	26 calls minus the number of acquire() calls, plus an initial value.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	27 The acquire() method blocks if necessary until it can return
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	28 without making the counter negative.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	29
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	30 Event()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	31 A factory function that returns a new event object. An event
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	32 manages a flag that can be set to true with the set() method and
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	33 reset to false with the clear() method. The wait() method blocks
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	34 until the flag is true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	35
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	36 Thread
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	37 A class that represents a thread of control -- subclassable.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	38
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	39 currentThread()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	40 A function that returns the Thread object for the caller's thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	41
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	42 activeCount()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	43 A function that returns the number of currently active threads.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	44
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	45 enumerate()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	46 A function that returns a list of all currently active threads.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	47
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	48 Detailed interfaces for each of these are documented below in the form
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	49 of pseudo class definitions. Note that the classes marked as ``do not
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	50 subclass'' are actually implemented as factory functions; classes are
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	51 shown here as a way to structure the documentation only.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	52
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	53 The design of this module is loosely based on Java's threading model.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	54 However, where Java makes locks and condition variables basic behavior
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	55 of every object, they are separate objects in Python. Python's Thread
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	56 class supports a subset of the behavior of Java's Thread class;
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	57 currently, there are no priorities, no thread groups, and threads
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	58 cannot be destroyed, stopped, suspended, resumed, or interrupted. The
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	59 static methods of Java's Thread class, when implemented, are mapped to
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	60 module-level functions.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	61
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	62 All methods described below are executed atomically.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	63
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	64 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	65
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	66
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	67 class Lock:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	68 """Primitive lock object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	69
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	70 * DO NOT SUBCLASS THIS CLASS *
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	71
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	72 A primitive lock is a synchronization primitive that is not owned
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	73 by a particular thread when locked. In Python, it is currently
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	74 the lowest level synchronization primitive available, implemented
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	75 directly by the thread extension module.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	76
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	77 A primitive lock is in one of two states, ``locked'' or
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	78 ``unlocked''. It is created in the unlocked state. It has two
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	79 basic methods, acquire() and release(). When the state is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	80 unlocked, acquire() changes the state to locked and returns
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	81 immediately. When the state is locked, acquire() blocks until a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	82 call to release() in another thread changes it to unlocked, then
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	83 the acquire() call resets it to locked and returns. The release()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	84 method should only be called in the locked state; it changes the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	85 state to unlocked and returns immediately. When more than one
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	86 thread is blocked in acquire() waiting for the state to turn to
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	87 unlocked, only one thread proceeds when a release() call resets
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	88 the state to unlocked; which one of the waiting threads proceeds
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	89 is not defined, and may vary across implementations.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	90
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	91 All methods are executed atomically.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	92
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	93 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	94
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	95 def acquire(self, blocking=1):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	96 """Acquire a lock, blocking or non-blocking.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	97
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	98 When invoked without arguments, block until the lock is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	99 unlocked, then set it to locked, and return. There is no
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	100 return value in this case.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	101
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	102 When invoked with the 'blocking' argument set to true, do the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	103 same thing as when called without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	104
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	105 When invoked with the 'blocking' argument set to false, do not
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	106 block. If a call without argument would block, return false
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	107 immediately; otherwise, do the same thing as when called
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	108 without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	109
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	110 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	111
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	112 def release(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	113 """Release a lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	114
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	115 When the lock is locked, reset it to unlocked, and return. If
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	116 any other threads are blocked waiting for the lock to become
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	117 unlocked, allow exactly one of them to proceed.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	118
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	119 Do not call this method when the lock is unlocked.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	120
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	121 There is no return value.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	122
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	123 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	124
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	125
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	126 class RLock:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	127 """Reentrant lock object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	128
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	129 * DO NOT SUBCLASS THIS CLASS *
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	130
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	131 A reentrant lock is a synchronization primitive that may be
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	132 acquired multiple times by the same thread. Internally, it uses
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	133 the concepts of ``owning thread'' and ``recursion level'' in
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	134 addition to the locked/unlocked state used by primitive locks. In
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	135 the locked state, some thread owns the lock; in the unlocked
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	136 state, no thread owns it.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	137
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	138 To lock the lock, a thread calls its acquire() method; this
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	139 returns once the thread owns the lock. To unlock the lock, a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	140 thread calls its release() method. acquire()/release() call pairs
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	141 may be nested; only the final release() (i.e. the release() of the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	142 outermost pair) resets the lock to unlocked and allows another
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	143 thread blocked in acquire() to proceed.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	144
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	145 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	146
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	147 def acquire(self, blocking=1):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	148 """Acquire a lock, blocking or non-blocking.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	149
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	150 When invoked without arguments: if this thread already owns
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	151 the lock, increment the recursion level by one, and return
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	152 immediately. Otherwise, if another thread owns the lock,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	153 block until the lock is unlocked. Once the lock is unlocked
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	154 (not owned by any thread), then grab ownership, set the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	155 recursion level to one, and return. If more than one thread
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	156 is blocked waiting until the lock is unlocked, only one at a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	157 time will be able to grab ownership of the lock. There is no
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	158 return value in this case.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	159
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	160 When invoked with the 'blocking' argument set to true, do the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	161 same thing as when called without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	162
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	163 When invoked with the 'blocking' argument set to false, do not
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	164 block. If a call without argument would block, return false
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	165 immediately; otherwise, do the same thing as when called
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	166 without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	167
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	168 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	169
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	170 def release(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	171 """Release a lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	172
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	173 Only call this method when the calling thread owns the lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	174 Decrement the recursion level. If after the decrement it is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	175 zero, reset the lock to unlocked (not owned by any thread),
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	176 and if any other threads are blocked waiting for the lock to
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	177 become unlocked, allow exactly one of them to proceed. If
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	178 after the decrement the recursion level is still nonzero, the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	179 lock remains locked and owned by the calling thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	180
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	181 Do not call this method when the lock is unlocked.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	182
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	183 There is no return value.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	184
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	185 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	186
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	187
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	188 class Condition:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	189 """Synchronized condition variable object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	190
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	191 * DO NOT SUBCLASS THIS CLASS *
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	192
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	193 A condition variable is always associated with some kind of lock;
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	194 this can be passed in or one will be created by default. (Passing
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	195 one in is useful when several condition variables must share the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	196 same lock.)
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	197
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	198 A condition variable has acquire() and release() methods that call
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	199 the corresponding methods of the associated lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	200
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	201 It also has a wait() method, and notify() and notifyAll() methods.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	202 These three must only be called when the calling thread has
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	203 acquired the lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	204
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	205 The wait() method releases the lock, and then blocks until it is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	206 awakened by a notifiy() or notifyAll() call for the same condition
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	207 variable in another thread. Once awakened, it re-acquires the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	208 lock and returns. It is also possible to specify a timeout.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	209
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	210 The notify() method wakes up one of the threads waiting for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	211 condition variable, if any are waiting. The notifyAll() method
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	212 wakes up all threads waiting for the condition variable.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	213
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	214 Note: the notify() and notifyAll() methods don't release the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	215 lock; this means that the thread or threads awakened will not
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	216 return from their wait() call immediately, but only when the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	217 thread that called notify() or notifyAll() finally relinquishes
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	218 ownership of the lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	219
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	220 Tip: the typical programming style using condition variables uses
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	221 the lock to synchronize access to some shared state; threads that
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	222 are interested in a particular change of state call wait()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	223 repeatedly until they see the desired state, while threads that
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	224 modify the state call notify() or notifyAll() when they change the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	225 state in such a way that it could possibly be a desired state for
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	226 one of the waiters. For example, the following code is a generic
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	227 producer-consumer situation with unlimited buffer capacity:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	228
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	229 # Consume one item
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	230 cv.acquire()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	231 while not an_item_is_available():
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	232 cv.wait()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	233 get_an_available_item()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	234 cv.release()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	235
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	236 # Produce one item
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	237 cv.acquire()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	238 make_an_item_available()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	239 cv.notify()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	240 cv.release()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	241
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	242 To choose between notify() and notifyAll(), consider whether one
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	243 state change can be interesting for only one or several waiting
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	244 threads. E.g. in a typical producer-consumer situation, adding
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	245 one item to the buffer only needs to wake up one consumer thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	246
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	247 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	248
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	249 def __init__(self, lock=None):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	250 """Constructor.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	251
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	252 If the lock argument is given and not None, it must be a Lock
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	253 or RLock object, and it is used as the underlying lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	254 Otherwise, a new RLock object is created and used as the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	255 underlying lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	256
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	257 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	258
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	259 def acquire(self, *args):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	260 """Acquire the underlying lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	261
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	262 This method calls the corresponding method on the underlying
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	263 lock; the return value is whatever that method returns.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	264
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	265 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	266
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	267 def release(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	268 """Release the underlying lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	269
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	270 This method calls the corresponding method on the underlying
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	271 lock; there is no return value.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	272
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	273 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	274
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	275 def wait(self, timeout=None):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	276 """Wait until notified or until a timeout occurs.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	277
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	278 This must only be called when the calling thread has acquired
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	279 the lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	280
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	281 This method releases the underlying lock, and then blocks
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	282 until it is awakened by a notify() or notifyAll() call for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	283 same condition variable in another thread, or until the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	284 optional timeout occurs. Once awakened or timed out, it
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	285 re-acquires the lock and returns.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	286
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	287 When the timeout argument is present and not None, it should
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	288 be a floating point number specifying a timeout for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	289 operation in seconds (or fractions thereof).
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	290
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	291 When the underlying lock is an RLock, it is not released using
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	292 its release() method, since this may not actually unlock the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	293 lock when it was acquired() multiple times recursively.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	294 Instead, an internal interface of the RLock class is used,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	295 which really unlocks it even when it has been recursively
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	296 acquired several times. Another internal interface is then
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	297 used to restore the recursion level when the lock is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	298 reacquired.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	299
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	300 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	301
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	302 def notify(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	303 """Wake up a thread waiting on this condition, if any.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	304
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	305 This must only be called when the calling thread has acquired
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	306 the lock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	307
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	308 This method wakes up one of the threads waiting for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	309 condition variable, if any are waiting; it is a no-op if no
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	310 threads are waiting.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	311
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	312 The current implementation wakes up exactly one thread, if any
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	313 are waiting. However, it's not safe to rely on this behavior.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	314 A future, optimized implementation may occasionally wake up
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	315 more than one thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	316
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	317 Note: the awakened thread does not actually return from its
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	318 wait() call until it can reacquire the lock. Since notify()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	319 does not release the lock, its caller should.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	320
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	321 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	322
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	323 def notifyAll(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	324 """Wake up all threads waiting on this condition.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	325
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	326 This method acts like notify(), but wakes up all waiting
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	327 threads instead of one.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	328
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	329 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	330
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	331
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	332 class Semaphore:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	333 """Semaphore object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	334
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	335 This is one of the oldest synchronization primitives in the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	336 history of computer science, invented by the early Dutch computer
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	337 scientist Edsger W. Dijkstra (he used P() and V() instead of
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	338 acquire() and release()).
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	339
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	340 A semaphore manages an internal counter which is decremented by
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	341 each acquire() call and incremented by each release() call. The
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	342 counter can never go below zero; when acquire() finds that it is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	343 zero, it blocks, waiting until some other thread calls release().
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	344
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	345 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	346
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	347 def __init__(self, value=1):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	348 """Constructor.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	349
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	350 The optional argument gives the initial value for the internal
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	351 counter; it defaults to 1.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	352
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	353 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	354
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	355 def acquire(self, blocking=1):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	356 """Acquire a semaphore.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	357
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	358 When invoked without arguments: if the internal counter is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	359 larger than zero on entry, decrement it by one and return
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	360 immediately. If it is zero on entry, block, waiting until
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	361 some other thread has called release() to make it larger than
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	362 zero. This is done with proper interlocking so that if
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	363 multiple acquire() calls are blocked, release() will wake
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	364 exactly one of them up. The implementation may pick one at
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	365 random, so the order in which blocked threads are awakened
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	366 should not be relied on. There is no return value in this
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	367 case.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	368
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	369 When invoked with the 'blocking' argument set to true, do the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	370 same thing as when called without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	371
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	372 When invoked with the 'blocking' argument set to false, do not
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	373 block. If a call without argument would block, return false
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	374 immediately; otherwise, do the same thing as when called
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	375 without arguments, and return true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	376
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	377 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	378
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	379 def release(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	380 """Release a semaphore.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	381
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	382 Increment the internal counter by one. When it was zero on
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	383 entry and another thread is waiting for it to become larger
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	384 than zero again, wake up that thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	385
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	386 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	387
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	388
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	389 class Event:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	390 """Event object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	391
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	392 This is one of the simplest mechanisms for communication between
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	393 threads: one thread signals an event and another thread, or
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	394 threads, wait for it.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	395
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	396 An event object manages an internal flag that can be set to true
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	397 with the set() method and reset to false with the clear() method.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	398 The wait() method blocks until the flag is true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	399
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	400 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	401
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	402 def __init__(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	403 """Constructor.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	404
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	405 The internal flag is initially false.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	406
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	407 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	408
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	409 def isSet(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	410 """Return true iff the internal flag is true."""
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	411
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	412 def set(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	413 """Set the internal flag to true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	414
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	415 All threads waiting for it to become true are awakened.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	416
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	417 Threads that call wait() once the flag is true will not block
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	418 at all.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	419
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	420 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	421
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	422 def clear(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	423 """Reset the internal flag to false.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	424
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	425 Subsequently, threads calling wait() will block until set() is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	426 called to set the internal flag to true again.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	427
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	428 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	429
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	430 def wait(self, timeout=None):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	431 """Block until the internal flag is true.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	432
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	433 If the internal flag is true on entry, return immediately.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	434 Otherwise, block until another thread calls set() to set the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	435 flag to true, or until the optional timeout occurs.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	436
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	437 When the timeout argument is present and not None, it should
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	438 be a floating point number specifying a timeout for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	439 operation in seconds (or fractions thereof).
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	440
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	441 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	442
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	443
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	444 class Thread:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	445 """Thread class.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	446
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	447 * ONLY OVERRIDE THE __init__() AND run() METHODS OF THIS CLASS *
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	448
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	449 This class represents an activity that is run in a separate thread
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	450 of control. There are two ways to specify the activity: by
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	451 passing a callable object to the constructor, or by overriding the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	452 run() method in a subclass. No other methods (except for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	453 constructor) should be overridden in a subclass.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	454
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	455 Once a thread object is created, its activity must be started by
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	456 calling the thread's start() method. This invokes the run()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	457 method in a separate thread of control.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	458
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	459 Once the thread's activity is started, the thread is considered
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	460 'alive' and 'active' (these concepts are almost, but not quite
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	461 exactly, the same; their definition is intentionally somewhat
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	462 vague). It stops being alive and active when its run() method
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	463 terminates -- either normally, or by raising an unhandled
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	464 exception. The isAlive() method tests whether the thread is
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	465 alive.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	466
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	467 Other threads can call a thread's join() method. This blocks the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	468 calling thread until the thread whose join() method is called
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	469 is terminated.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	470
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	471 A thread has a name. The name can be passed to the constructor,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	472 set with the setName() method, and retrieved with the getName()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	473 method.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	474
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	475 A thread can be flagged as a ``daemon thread''. The significance
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	476 of this flag is that the entire Python program exits when only
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	477 daemon threads are left. The initial value is inherited from the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	478 creating thread. The flag can be set with the setDaemon() method
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	479 and retrieved with the getDaemon() method.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	480
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	481 There is a ``main thread'' object; this corresponds to the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	482 initial thread of control in the Python program. It is not a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	483 daemon thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	484
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	485 There is the possibility that ``dummy thread objects'' are
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	486 created. These are thread objects corresponding to ``alien
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	487 threads''. These are threads of control started outside the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	488 threading module, e.g. directly from C code. Dummy thread objects
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	489 have limited functionality; they are always considered alive,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	490 active, and daemonic, and cannot be join()ed. They are never
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	491 deleted, since it is impossible to detect the termination of alien
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	492 threads.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	493
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	494 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	495
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	496 def __init__(self, group=None, target=None, name=None,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	497 args=(), kwargs={}):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	498 """Thread constructor.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	499
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	500 This constructor should always be called with keyword
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	501 arguments. Arguments are:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	502
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	503 group
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	504 Should be None; reserved for future extension when a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	505 ThreadGroup class is implemented.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	506
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	507 target
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	508 Callable object to be invoked by the run() method.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	509 Defaults to None, meaning nothing is called.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	510
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	511 name
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	512 The thread name. By default, a unique name is constructed
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	513 of the form ``Thread-N'' where N is a small decimal
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	514 number.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	515
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	516 args
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	517 Argument tuple for the target invocation. Defaults to ().
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	518
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	519 kwargs
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	520 Keyword argument dictionary for the target invocation.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	521 Defaults to {}.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	522
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	523 If the subclass overrides the constructor, it must make sure
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	524 to invoke the base class constructor (Thread.__init__())
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	525 before doing anything else to the thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	526
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	527 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	528
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	529 def start(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	530 """Start the thread's activity.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	531
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	532 This must be called at most once per thread object. It
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	533 arranges for the object's run() method to be invoked in a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	534 separate thread of control.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	535
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	536 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	537
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	538 def run(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	539 """Method representing the thread's activity.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	540
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	541 You may override this method in a subclass. The standard
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	542 run() method invokes the callable object passed as the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	543 'target' argument, if any, with sequential and keyword
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	544 arguments taken from the 'args' and 'kwargs' arguments,
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	545 respectively.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	546
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	547 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	548
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	549 def join(self, timeout=None):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	550 """Wait until the thread terminates.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	551
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	552 This blocks the calling thread until the thread whose join()
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	553 method is called terminates -- either normally or through an
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	554 unhandled exception -- or until the optional timeout occurs.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	555
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	556 When the timeout argument is present and not None, it should
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	557 be a floating point number specifying a timeout for the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	558 operation in seconds (or fractions thereof).
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	559
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	560 A thread can be join()ed many times.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	561
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	562 A thread cannot join itself because this would cause a
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	563 deadlock.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	564
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	565 It is an error to attempt to join() a thread before it has
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	566 been started.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	567
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	568 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	569
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	570 def getName(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	571 """Return the thread's name."""
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	572
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	573 def setName(self, name):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	574 """Set the thread's name.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	575
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	576 The name is a string used for identification purposes only.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	577 It has no semantics. Multiple threads may be given the same
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	578 name. The initial name is set by the constructor.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	579
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	580 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	581
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	582 def isAlive(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	583 """Return whether the thread is alive.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	584
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	585 Roughly, a thread is alive from the moment the start() method
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	586 returns until its run() method terminates.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	587
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	588 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	589
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	590 def isDaemon(self):
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	591 """Return the thread's daemon flag."""
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	592
8883 f88f402417f2 The doc string for setDaemon() disagreed with the implementation. The Guido van Rossum <guido@python.org> parents: 7949 diff changeset	593 def setDaemon(self, daemonic):
f88f402417f2 The doc string for setDaemon() disagreed with the implementation. The Guido van Rossum <guido@python.org> parents: 7949 diff changeset	594 """Set the thread's daemon flag (a Boolean).
7949 58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	595
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	596 This must be called before start() is called.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	597
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	598 The initial value is inherited from the creating thread.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	599
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	600 The entire Python program exits when no active non-daemon
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	601 threads are left.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	602
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	603 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	604
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	605
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	606 # Module-level functions:
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	607
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	608
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	609 def currentThread():
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	610 """Return the current Thread object.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	611
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	612 This function returns the Thread object corresponding to the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	613 caller's thread of control.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	614
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	615 If the caller's thread of control was not created through the
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	616 threading module, a dummy thread object with limited functionality
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	617 is returned.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	618
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	619 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	620
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	621
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	622 def activeCount():
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	623 """Return the number of currently active Thread objects.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	624
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	625 The returned count is equal to the length of the list returned by
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	626 enumerate().
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	627
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	628 """
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	629
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	630
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	631 def enumerate():
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	632 """Return a list of all currently active Thread objects.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	633
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	634 The list includes daemonic threads, dummy thread objects created
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	635 by currentThread(), and the main thread. It excludes terminated
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	636 threads and threads that have not yet been started.
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	637
58d6815af002 New Java-style threading module. The doc strings are in a separate module. Guido van Rossum <guido@python.org> parents: diff changeset	638 """

Mercurial > cpython-lru_cache-weakref

annotate Lib/threading_api.py @ 9383:2b34461ba4a3 legacy-trunk