blob: 48c63ce8db789f9eaffb3f0f3837e2d86f58a3e7 [file] [log] [blame]
Jeremy Hylton92bb6e72002-08-14 19:25:42 +00001"""Thread module emulating a subset of Java's threading model."""
Guido van Rossum7f5013a1998-04-09 22:01:42 +00002
Fred Drakea8725952002-12-30 23:32:50 +00003import sys as _sys
Georg Brandl2067bfd2008-05-25 13:05:15 +00004import _thread
Benjamin Petersonf0923f52008-08-18 22:10:13 +00005import warnings
Fred Drakea8725952002-12-30 23:32:50 +00006
Fred Drakea8725952002-12-30 23:32:50 +00007from time import time as _time, sleep as _sleep
Neil Schemenauerf607fc52003-11-05 23:03:00 +00008from traceback import format_exc as _format_exc
Raymond Hettinger756b3f32004-01-29 06:37:52 +00009from collections import deque
Guido van Rossum7f5013a1998-04-09 22:01:42 +000010
11# Rename some stuff so "from threading import *" is safe
Benjamin Peterson672b8032008-06-11 19:14:14 +000012__all__ = ['active_count', 'Condition', 'current_thread', 'enumerate', 'Event',
Tim Peters685e6972003-06-29 16:50:06 +000013 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread',
Thomas Wouters0e3f5912006-08-11 14:57:12 +000014 'Timer', 'setprofile', 'settrace', 'local', 'stack_size']
Guido van Rossum7f5013a1998-04-09 22:01:42 +000015
Georg Brandl2067bfd2008-05-25 13:05:15 +000016_start_new_thread = _thread.start_new_thread
17_allocate_lock = _thread.allocate_lock
18_get_ident = _thread.get_ident
19ThreadError = _thread.error
20del _thread
Guido van Rossum7f5013a1998-04-09 22:01:42 +000021
Guido van Rossum7f5013a1998-04-09 22:01:42 +000022
Tim Peters59aba122003-07-01 20:01:55 +000023# Debug support (adapted from ihooks.py).
24# All the major classes here derive from _Verbose. We force that to
25# be a new-style class so that all the major classes here are new-style.
26# This helps debugging (type(instance) is more revealing for instances
27# of new-style classes).
Guido van Rossum7f5013a1998-04-09 22:01:42 +000028
Tim Peters0939fac2003-07-01 19:28:44 +000029_VERBOSE = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +000030
31if __debug__:
32
Tim Peters59aba122003-07-01 20:01:55 +000033 class _Verbose(object):
Guido van Rossum7f5013a1998-04-09 22:01:42 +000034
35 def __init__(self, verbose=None):
36 if verbose is None:
37 verbose = _VERBOSE
Guido van Rossumd0648992007-08-20 19:25:41 +000038 self._verbose = verbose
Guido van Rossum7f5013a1998-04-09 22:01:42 +000039
40 def _note(self, format, *args):
Guido van Rossumd0648992007-08-20 19:25:41 +000041 if self._verbose:
Guido van Rossum7f5013a1998-04-09 22:01:42 +000042 format = format % args
43 format = "%s: %s\n" % (
Benjamin Petersonfdbea962008-08-18 17:33:47 +000044 current_thread().name, format)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000045 _sys.stderr.write(format)
46
47else:
48 # Disable this when using "python -O"
Tim Peters59aba122003-07-01 20:01:55 +000049 class _Verbose(object):
Guido van Rossum7f5013a1998-04-09 22:01:42 +000050 def __init__(self, verbose=None):
51 pass
52 def _note(self, *args):
53 pass
54
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000055# Support for profile and trace hooks
56
57_profile_hook = None
58_trace_hook = None
59
60def setprofile(func):
61 global _profile_hook
62 _profile_hook = func
Tim Petersd1b108b2003-06-29 17:24:17 +000063
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000064def settrace(func):
65 global _trace_hook
66 _trace_hook = func
Guido van Rossum7f5013a1998-04-09 22:01:42 +000067
68# Synchronization classes
69
70Lock = _allocate_lock
71
72def RLock(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +000073 return _RLock(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000074
75class _RLock(_Verbose):
Tim Petersb90f89a2001-01-15 03:26:36 +000076
Guido van Rossum7f5013a1998-04-09 22:01:42 +000077 def __init__(self, verbose=None):
78 _Verbose.__init__(self, verbose)
Guido van Rossumd0648992007-08-20 19:25:41 +000079 self._block = _allocate_lock()
80 self._owner = None
81 self._count = 0
Guido van Rossum7f5013a1998-04-09 22:01:42 +000082
83 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +000084 owner = self._owner
Guido van Rossum7f5013a1998-04-09 22:01:42 +000085 return "<%s(%s, %d)>" % (
86 self.__class__.__name__,
Benjamin Petersonfdbea962008-08-18 17:33:47 +000087 owner and owner.name,
Guido van Rossumd0648992007-08-20 19:25:41 +000088 self._count)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000089
90 def acquire(self, blocking=1):
Benjamin Peterson672b8032008-06-11 19:14:14 +000091 me = current_thread()
Guido van Rossumd0648992007-08-20 19:25:41 +000092 if self._owner is me:
93 self._count = self._count + 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +000094 if __debug__:
95 self._note("%s.acquire(%s): recursive success", self, blocking)
96 return 1
Guido van Rossumd0648992007-08-20 19:25:41 +000097 rc = self._block.acquire(blocking)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000098 if rc:
Guido van Rossumd0648992007-08-20 19:25:41 +000099 self._owner = me
100 self._count = 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000101 if __debug__:
Brett Cannon90cece72005-01-27 22:48:30 +0000102 self._note("%s.acquire(%s): initial success", self, blocking)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000103 else:
104 if __debug__:
105 self._note("%s.acquire(%s): failure", self, blocking)
106 return rc
107
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000108 __enter__ = acquire
109
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000110 def release(self):
Benjamin Peterson672b8032008-06-11 19:14:14 +0000111 if self._owner is not current_thread():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000112 raise RuntimeError("cannot release un-aquired lock")
Guido van Rossumd0648992007-08-20 19:25:41 +0000113 self._count = count = self._count - 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000114 if not count:
Guido van Rossumd0648992007-08-20 19:25:41 +0000115 self._owner = None
116 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000117 if __debug__:
118 self._note("%s.release(): final release", self)
119 else:
120 if __debug__:
121 self._note("%s.release(): non-final release", self)
122
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000123 def __exit__(self, t, v, tb):
124 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000125
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000126 # Internal methods used by condition variables
127
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000128 def _acquire_restore(self, state):
Guido van Rossumd0648992007-08-20 19:25:41 +0000129 self._block.acquire()
130 self._count, self._owner = state
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000131 if __debug__:
132 self._note("%s._acquire_restore()", self)
133
134 def _release_save(self):
135 if __debug__:
136 self._note("%s._release_save()", self)
Guido van Rossumd0648992007-08-20 19:25:41 +0000137 count = self._count
138 self._count = 0
139 owner = self._owner
140 self._owner = None
141 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000142 return (count, owner)
143
144 def _is_owned(self):
Benjamin Peterson672b8032008-06-11 19:14:14 +0000145 return self._owner is current_thread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000146
147
148def Condition(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000149 return _Condition(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000150
151class _Condition(_Verbose):
152
153 def __init__(self, lock=None, verbose=None):
154 _Verbose.__init__(self, verbose)
155 if lock is None:
156 lock = RLock()
Guido van Rossumd0648992007-08-20 19:25:41 +0000157 self._lock = lock
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000158 # Export the lock's acquire() and release() methods
159 self.acquire = lock.acquire
160 self.release = lock.release
161 # If the lock defines _release_save() and/or _acquire_restore(),
162 # these override the default implementations (which just call
163 # release() and acquire() on the lock). Ditto for _is_owned().
164 try:
165 self._release_save = lock._release_save
166 except AttributeError:
167 pass
168 try:
169 self._acquire_restore = lock._acquire_restore
170 except AttributeError:
171 pass
172 try:
173 self._is_owned = lock._is_owned
174 except AttributeError:
175 pass
Guido van Rossumd0648992007-08-20 19:25:41 +0000176 self._waiters = []
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000177
Thomas Wouters477c8d52006-05-27 19:21:47 +0000178 def __enter__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000179 return self._lock.__enter__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000180
Thomas Wouters477c8d52006-05-27 19:21:47 +0000181 def __exit__(self, *args):
Guido van Rossumd0648992007-08-20 19:25:41 +0000182 return self._lock.__exit__(*args)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000183
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000184 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000185 return "<Condition(%s, %d)>" % (self._lock, len(self._waiters))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000186
187 def _release_save(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000188 self._lock.release() # No state to save
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000189
190 def _acquire_restore(self, x):
Guido van Rossumd0648992007-08-20 19:25:41 +0000191 self._lock.acquire() # Ignore saved state
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000192
193 def _is_owned(self):
Benjamin Peterson672b8032008-06-11 19:14:14 +0000194 # Return True if lock is owned by current_thread.
Jeremy Hyltonaf7fde72002-08-14 17:43:59 +0000195 # This method is called only if __lock doesn't have _is_owned().
Guido van Rossumd0648992007-08-20 19:25:41 +0000196 if self._lock.acquire(0):
197 self._lock.release()
Tim Petersbc0e9102002-04-04 22:55:58 +0000198 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000199 else:
Tim Petersbc0e9102002-04-04 22:55:58 +0000200 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000201
202 def wait(self, timeout=None):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000203 if not self._is_owned():
204 raise RuntimeError("cannot wait on un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000205 waiter = _allocate_lock()
206 waiter.acquire()
Guido van Rossumd0648992007-08-20 19:25:41 +0000207 self._waiters.append(waiter)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000208 saved_state = self._release_save()
Tim Petersc951bf92001-04-02 20:15:57 +0000209 try: # restore state no matter what (e.g., KeyboardInterrupt)
210 if timeout is None:
211 waiter.acquire()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000212 if __debug__:
Tim Petersc951bf92001-04-02 20:15:57 +0000213 self._note("%s.wait(): got it", self)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000214 else:
Tim Petersa6a4f272001-08-12 00:41:33 +0000215 # Balancing act: We can't afford a pure busy loop, so we
216 # have to sleep; but if we sleep the whole timeout time,
217 # we'll be unresponsive. The scheme here sleeps very
218 # little at first, longer as time goes on, but never longer
219 # than 20 times per second (or the timeout time remaining).
Tim Petersc951bf92001-04-02 20:15:57 +0000220 endtime = _time() + timeout
Tim Petersa6a4f272001-08-12 00:41:33 +0000221 delay = 0.0005 # 500 us -> initial delay of 1 ms
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000222 while True:
Tim Petersc951bf92001-04-02 20:15:57 +0000223 gotit = waiter.acquire(0)
Tim Petersa6a4f272001-08-12 00:41:33 +0000224 if gotit:
Tim Petersc951bf92001-04-02 20:15:57 +0000225 break
Tim Petersa6a4f272001-08-12 00:41:33 +0000226 remaining = endtime - _time()
227 if remaining <= 0:
228 break
229 delay = min(delay * 2, remaining, .05)
Tim Petersc951bf92001-04-02 20:15:57 +0000230 _sleep(delay)
Tim Petersc951bf92001-04-02 20:15:57 +0000231 if not gotit:
232 if __debug__:
233 self._note("%s.wait(%s): timed out", self, timeout)
234 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000235 self._waiters.remove(waiter)
Tim Petersc951bf92001-04-02 20:15:57 +0000236 except ValueError:
237 pass
238 else:
239 if __debug__:
240 self._note("%s.wait(%s): got it", self, timeout)
241 finally:
242 self._acquire_restore(saved_state)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000243
244 def notify(self, n=1):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000245 if not self._is_owned():
246 raise RuntimeError("cannot notify on un-aquired lock")
Guido van Rossumd0648992007-08-20 19:25:41 +0000247 __waiters = self._waiters
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000248 waiters = __waiters[:n]
249 if not waiters:
250 if __debug__:
251 self._note("%s.notify(): no waiters", self)
252 return
253 self._note("%s.notify(): notifying %d waiter%s", self, n,
254 n!=1 and "s" or "")
255 for waiter in waiters:
256 waiter.release()
257 try:
258 __waiters.remove(waiter)
259 except ValueError:
260 pass
261
Benjamin Peterson672b8032008-06-11 19:14:14 +0000262 def notify_all(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000263 self.notify(len(self._waiters))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000264
265
266def Semaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000267 return _Semaphore(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000268
269class _Semaphore(_Verbose):
270
Andrew M. Kuchling39d3bfc2000-02-29 00:10:24 +0000271 # After Tim Peters' semaphore class, but not quite the same (no maximum)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000272
273 def __init__(self, value=1, verbose=None):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000274 if value < 0:
275 raise ValueError("semaphore initial value must be >= 0")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000276 _Verbose.__init__(self, verbose)
Guido van Rossumd0648992007-08-20 19:25:41 +0000277 self._cond = Condition(Lock())
278 self._value = value
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000279
280 def acquire(self, blocking=1):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000281 rc = False
Guido van Rossumd0648992007-08-20 19:25:41 +0000282 self._cond.acquire()
283 while self._value == 0:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000284 if not blocking:
285 break
Skip Montanarob446fc72001-08-19 04:25:24 +0000286 if __debug__:
287 self._note("%s.acquire(%s): blocked waiting, value=%s",
Guido van Rossumd0648992007-08-20 19:25:41 +0000288 self, blocking, self._value)
289 self._cond.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000290 else:
Guido van Rossumd0648992007-08-20 19:25:41 +0000291 self._value = self._value - 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000292 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000293 self._note("%s.acquire: success, value=%s",
Guido van Rossumd0648992007-08-20 19:25:41 +0000294 self, self._value)
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000295 rc = True
Guido van Rossumd0648992007-08-20 19:25:41 +0000296 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000297 return rc
298
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000299 __enter__ = acquire
300
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000301 def release(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000302 self._cond.acquire()
303 self._value = self._value + 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000304 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000305 self._note("%s.release: success, value=%s",
Guido van Rossumd0648992007-08-20 19:25:41 +0000306 self, self._value)
307 self._cond.notify()
308 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000309
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000310 def __exit__(self, t, v, tb):
311 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000312
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000313
Skip Montanaroe428bb72001-08-20 20:27:58 +0000314def BoundedSemaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000315 return _BoundedSemaphore(*args, **kwargs)
Skip Montanaroe428bb72001-08-20 20:27:58 +0000316
317class _BoundedSemaphore(_Semaphore):
318 """Semaphore that checks that # releases is <= # acquires"""
319 def __init__(self, value=1, verbose=None):
320 _Semaphore.__init__(self, value, verbose)
321 self._initial_value = value
322
323 def release(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000324 if self._value >= self._initial_value:
Collin Winterce36ad82007-08-30 01:19:48 +0000325 raise ValueError("Semaphore released too many times")
Skip Montanaroe428bb72001-08-20 20:27:58 +0000326 return _Semaphore.release(self)
327
328
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000329def Event(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000330 return _Event(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000331
332class _Event(_Verbose):
333
334 # After Tim Peters' event class (without is_posted())
335
336 def __init__(self, verbose=None):
337 _Verbose.__init__(self, verbose)
Guido van Rossumd0648992007-08-20 19:25:41 +0000338 self._cond = Condition(Lock())
339 self._flag = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000340
Benjamin Peterson672b8032008-06-11 19:14:14 +0000341 def is_set(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000342 return self._flag
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000343
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000344 def isSet(self):
345 warnings.warn("isSet() is deprecated in favor of is_set()",
346 DeprecationWarning)
347 return self.is_set()
348
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000349 def set(self):
Christian Heimes969fe572008-01-25 11:23:10 +0000350 self._cond.acquire()
351 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000352 self._flag = True
Benjamin Peterson672b8032008-06-11 19:14:14 +0000353 self._cond.notify_all()
Christian Heimes969fe572008-01-25 11:23:10 +0000354 finally:
355 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000356
357 def clear(self):
Christian Heimes969fe572008-01-25 11:23:10 +0000358 self._cond.acquire()
359 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000360 self._flag = False
Christian Heimes969fe572008-01-25 11:23:10 +0000361 finally:
362 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000363
364 def wait(self, timeout=None):
Christian Heimes969fe572008-01-25 11:23:10 +0000365 self._cond.acquire()
366 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000367 if not self._flag:
368 self._cond.wait(timeout)
Christian Heimes969fe572008-01-25 11:23:10 +0000369 finally:
370 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000371
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000372# Helper to generate new thread names
373_counter = 0
374def _newname(template="Thread-%d"):
375 global _counter
376 _counter = _counter + 1
377 return template % _counter
378
379# Active thread administration
380_active_limbo_lock = _allocate_lock()
Tim Peters711906e2005-01-08 07:30:42 +0000381_active = {} # maps thread id to Thread object
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000382_limbo = {}
383
384
385# Main class for threads
386
387class Thread(_Verbose):
388
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000389 __initialized = False
Brett Cannoncc4e9352004-07-03 03:52:35 +0000390 # Need to store a reference to sys.exc_info for printing
391 # out exceptions when a thread tries to use a global var. during interp.
392 # shutdown and thus raises an exception about trying to perform some
393 # operation on/with a NoneType
394 __exc_info = _sys.exc_info
Christian Heimesbbe741d2008-03-28 10:53:29 +0000395 # Keep sys.exc_clear too to clear the exception just before
396 # allowing .join() to return.
397 #XXX __exc_clear = _sys.exc_clear
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000398
399 def __init__(self, group=None, target=None, name=None,
Georg Brandla4a8b822005-07-15 09:13:21 +0000400 args=(), kwargs=None, verbose=None):
Guido van Rossum5a43e1a1998-06-09 19:04:26 +0000401 assert group is None, "group argument must be None for now"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000402 _Verbose.__init__(self, verbose)
Georg Brandla4a8b822005-07-15 09:13:21 +0000403 if kwargs is None:
404 kwargs = {}
Guido van Rossumd0648992007-08-20 19:25:41 +0000405 self._target = target
406 self._name = str(name or _newname())
407 self._args = args
408 self._kwargs = kwargs
409 self._daemonic = self._set_daemon()
Georg Brandl0c77a822008-06-10 16:37:50 +0000410 self._ident = None
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000411 self._started = Event()
Guido van Rossumd0648992007-08-20 19:25:41 +0000412 self._stopped = False
413 self._block = Condition(Lock())
414 self._initialized = True
Brett Cannoncc4e9352004-07-03 03:52:35 +0000415 # sys.stderr is not stored in the class like
416 # sys.exc_info since it can be changed between instances
Guido van Rossumd0648992007-08-20 19:25:41 +0000417 self._stderr = _sys.stderr
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000418
419 def _set_daemon(self):
420 # Overridden in _MainThread and _DummyThread
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000421 return current_thread().daemon
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000422
423 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000424 assert self._initialized, "Thread.__init__() was not called"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000425 status = "initial"
Benjamin Peterson672b8032008-06-11 19:14:14 +0000426 if self._started.is_set():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000427 status = "started"
Guido van Rossumd0648992007-08-20 19:25:41 +0000428 if self._stopped:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000429 status = "stopped"
Guido van Rossumd0648992007-08-20 19:25:41 +0000430 if self._daemonic:
Georg Brandl0c77a822008-06-10 16:37:50 +0000431 status += " daemon"
432 if self._ident is not None:
433 status += " %s" % self._ident
Guido van Rossumd0648992007-08-20 19:25:41 +0000434 return "<%s(%s, %s)>" % (self.__class__.__name__, self._name, status)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000435
436 def start(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000437 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000438 raise RuntimeError("thread.__init__() not called")
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000439
Benjamin Peterson672b8032008-06-11 19:14:14 +0000440 if self._started.is_set():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000441 raise RuntimeError("thread already started")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000442 if __debug__:
443 self._note("%s.start(): starting thread", self)
444 _active_limbo_lock.acquire()
445 _limbo[self] = self
446 _active_limbo_lock.release()
Guido van Rossumd0648992007-08-20 19:25:41 +0000447 _start_new_thread(self._bootstrap, ())
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000448 self._started.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000449
450 def run(self):
Christian Heimesd3eb5a152008-02-24 00:38:49 +0000451 try:
452 if self._target:
453 self._target(*self._args, **self._kwargs)
454 finally:
455 # Avoid a refcycle if the thread is running a function with
456 # an argument that has a member that points to the thread.
457 del self._target, self._args, self._kwargs
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000458
Guido van Rossumd0648992007-08-20 19:25:41 +0000459 def _bootstrap(self):
Guido van Rossum61e21b52007-08-20 19:06:03 +0000460 # Wrapper around the real bootstrap code that ignores
461 # exceptions during interpreter cleanup. Those typically
462 # happen when a daemon thread wakes up at an unfortunate
463 # moment, finds the world around it destroyed, and raises some
464 # random exception *** while trying to report the exception in
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000465 # _bootstrap_inner() below ***. Those random exceptions
Guido van Rossum61e21b52007-08-20 19:06:03 +0000466 # don't help anybody, and they confuse users, so we suppress
467 # them. We suppress them only when it appears that the world
468 # indeed has already been destroyed, so that exceptions in
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000469 # _bootstrap_inner() during normal business hours are properly
Guido van Rossum61e21b52007-08-20 19:06:03 +0000470 # reported. Also, we only suppress them for daemonic threads;
471 # if a non-daemonic encounters this, something else is wrong.
472 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000473 self._bootstrap_inner()
Guido van Rossum61e21b52007-08-20 19:06:03 +0000474 except:
Guido van Rossumd0648992007-08-20 19:25:41 +0000475 if self._daemonic and _sys is None:
Guido van Rossum61e21b52007-08-20 19:06:03 +0000476 return
477 raise
478
Guido van Rossumd0648992007-08-20 19:25:41 +0000479 def _bootstrap_inner(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000480 try:
Georg Brandl0c77a822008-06-10 16:37:50 +0000481 self._ident = _get_ident()
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000482 self._started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000483 _active_limbo_lock.acquire()
Georg Brandl0c77a822008-06-10 16:37:50 +0000484 _active[self._ident] = self
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000485 del _limbo[self]
486 _active_limbo_lock.release()
487 if __debug__:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000488 self._note("%s._bootstrap(): thread started", self)
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000489
490 if _trace_hook:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000491 self._note("%s._bootstrap(): registering trace hook", self)
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000492 _sys.settrace(_trace_hook)
493 if _profile_hook:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000494 self._note("%s._bootstrap(): registering profile hook", self)
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000495 _sys.setprofile(_profile_hook)
Tim Petersd1b108b2003-06-29 17:24:17 +0000496
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000497 try:
498 self.run()
499 except SystemExit:
500 if __debug__:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000501 self._note("%s._bootstrap(): raised SystemExit", self)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000502 except:
503 if __debug__:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000504 self._note("%s._bootstrap(): unhandled exception", self)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000505 # If sys.stderr is no more (most likely from interpreter
Guido van Rossumd0648992007-08-20 19:25:41 +0000506 # shutdown) use self._stderr. Otherwise still use sys (as in
Brett Cannoncc4e9352004-07-03 03:52:35 +0000507 # _sys) in case sys.stderr was redefined since the creation of
508 # self.
509 if _sys:
510 _sys.stderr.write("Exception in thread %s:\n%s\n" %
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000511 (self.name, _format_exc()))
Brett Cannoncc4e9352004-07-03 03:52:35 +0000512 else:
513 # Do the best job possible w/o a huge amt. of code to
514 # approximate a traceback (code ideas from
515 # Lib/traceback.py)
Guido van Rossumd0648992007-08-20 19:25:41 +0000516 exc_type, exc_value, exc_tb = self._exc_info()
Brett Cannoncc4e9352004-07-03 03:52:35 +0000517 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000518 print((
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000519 "Exception in thread " + self.name +
Guido van Rossumd0648992007-08-20 19:25:41 +0000520 " (most likely raised during interpreter shutdown):"), file=self._stderr)
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000521 print((
Guido van Rossumd0648992007-08-20 19:25:41 +0000522 "Traceback (most recent call last):"), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000523 while exc_tb:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000524 print((
Brett Cannoncc4e9352004-07-03 03:52:35 +0000525 ' File "%s", line %s, in %s' %
526 (exc_tb.tb_frame.f_code.co_filename,
527 exc_tb.tb_lineno,
Guido van Rossumd0648992007-08-20 19:25:41 +0000528 exc_tb.tb_frame.f_code.co_name)), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000529 exc_tb = exc_tb.tb_next
Guido van Rossumd0648992007-08-20 19:25:41 +0000530 print(("%s: %s" % (exc_type, exc_value)), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000531 # Make sure that exc_tb gets deleted since it is a memory
532 # hog; deleting everything else is just for thoroughness
533 finally:
534 del exc_type, exc_value, exc_tb
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000535 else:
536 if __debug__:
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000537 self._note("%s._bootstrap(): normal return", self)
Christian Heimesbbe741d2008-03-28 10:53:29 +0000538 finally:
539 # Prevent a race in
540 # test_threading.test_no_refcycle_through_target when
541 # the exception keeps the target alive past when we
542 # assert that it's dead.
543 #XXX self.__exc_clear()
544 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000545 finally:
Christian Heimes1af737c2008-01-23 08:24:23 +0000546 with _active_limbo_lock:
547 self._stop()
548 try:
Georg Brandl0c77a822008-06-10 16:37:50 +0000549 # We don't call self._delete() because it also
Christian Heimes1af737c2008-01-23 08:24:23 +0000550 # grabs _active_limbo_lock.
551 del _active[_get_ident()]
552 except:
553 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000554
Guido van Rossumd0648992007-08-20 19:25:41 +0000555 def _stop(self):
Christian Heimes969fe572008-01-25 11:23:10 +0000556 self._block.acquire()
557 self._stopped = True
Benjamin Peterson672b8032008-06-11 19:14:14 +0000558 self._block.notify_all()
Christian Heimes969fe572008-01-25 11:23:10 +0000559 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000560
Guido van Rossumd0648992007-08-20 19:25:41 +0000561 def _delete(self):
Tim Peters21429932004-07-21 03:36:52 +0000562 "Remove current thread from the dict of currently running threads."
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000563
Georg Brandl2067bfd2008-05-25 13:05:15 +0000564 # Notes about running with _dummy_thread:
Tim Peters21429932004-07-21 03:36:52 +0000565 #
Georg Brandl2067bfd2008-05-25 13:05:15 +0000566 # Must take care to not raise an exception if _dummy_thread is being
Tim Peters21429932004-07-21 03:36:52 +0000567 # used (and thus this module is being used as an instance of
Georg Brandl2067bfd2008-05-25 13:05:15 +0000568 # dummy_threading). _dummy_thread.get_ident() always returns -1 since
569 # there is only one thread if _dummy_thread is being used. Thus
Tim Peters21429932004-07-21 03:36:52 +0000570 # len(_active) is always <= 1 here, and any Thread instance created
571 # overwrites the (if any) thread currently registered in _active.
572 #
573 # An instance of _MainThread is always created by 'threading'. This
574 # gets overwritten the instant an instance of Thread is created; both
Georg Brandl2067bfd2008-05-25 13:05:15 +0000575 # threads return -1 from _dummy_thread.get_ident() and thus have the
Tim Peters21429932004-07-21 03:36:52 +0000576 # same key in the dict. So when the _MainThread instance created by
577 # 'threading' tries to clean itself up when atexit calls this method
578 # it gets a KeyError if another Thread instance was created.
579 #
580 # This all means that KeyError from trying to delete something from
581 # _active if dummy_threading is being used is a red herring. But
582 # since it isn't if dummy_threading is *not* being used then don't
583 # hide the exception.
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000584
Christian Heimes969fe572008-01-25 11:23:10 +0000585 try:
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000586 with _active_limbo_lock:
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000587 del _active[_get_ident()]
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000588 # There must not be any python code between the previous line
589 # and after the lock is released. Otherwise a tracing function
590 # could try to acquire the lock again in the same thread, (in
Benjamin Peterson672b8032008-06-11 19:14:14 +0000591 # current_thread()), and would block.
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000592 except KeyError:
593 if 'dummy_threading' not in _sys.modules:
594 raise
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000595
596 def join(self, timeout=None):
Guido van Rossumd0648992007-08-20 19:25:41 +0000597 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000598 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000599 if not self._started.is_set():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000600 raise RuntimeError("cannot join thread before it is started")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000601 if self is current_thread():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000602 raise RuntimeError("cannot join current thread")
603
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000604 if __debug__:
Guido van Rossumd0648992007-08-20 19:25:41 +0000605 if not self._stopped:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000606 self._note("%s.join(): waiting until thread stops", self)
Christian Heimes969fe572008-01-25 11:23:10 +0000607
608 self._block.acquire()
609 try:
Brett Cannonad07ff22005-11-23 02:15:50 +0000610 if timeout is None:
Guido van Rossumd0648992007-08-20 19:25:41 +0000611 while not self._stopped:
612 self._block.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000613 if __debug__:
614 self._note("%s.join(): thread stopped", self)
Brett Cannonad07ff22005-11-23 02:15:50 +0000615 else:
616 deadline = _time() + timeout
Guido van Rossumd0648992007-08-20 19:25:41 +0000617 while not self._stopped:
Brett Cannonad07ff22005-11-23 02:15:50 +0000618 delay = deadline - _time()
619 if delay <= 0:
620 if __debug__:
621 self._note("%s.join(): timed out", self)
622 break
Guido van Rossumd0648992007-08-20 19:25:41 +0000623 self._block.wait(delay)
Brett Cannonad07ff22005-11-23 02:15:50 +0000624 else:
625 if __debug__:
626 self._note("%s.join(): thread stopped", self)
Christian Heimes969fe572008-01-25 11:23:10 +0000627 finally:
628 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000629
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000630 @property
631 def name(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000632 assert self._initialized, "Thread.__init__() not called"
633 return self._name
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000634
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000635 @name.setter
636 def name(self, name):
Guido van Rossumd0648992007-08-20 19:25:41 +0000637 assert self._initialized, "Thread.__init__() not called"
638 self._name = str(name)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000639
Benjamin Peterson773c17b2008-08-18 16:45:31 +0000640 @property
641 def ident(self):
Georg Brandl0c77a822008-06-10 16:37:50 +0000642 assert self._initialized, "Thread.__init__() not called"
643 return self._ident
644
Benjamin Peterson672b8032008-06-11 19:14:14 +0000645 def is_alive(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000646 assert self._initialized, "Thread.__init__() not called"
Benjamin Peterson672b8032008-06-11 19:14:14 +0000647 return self._started.is_set() and not self._stopped
Tim Petersb90f89a2001-01-15 03:26:36 +0000648
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000649 def isAlive(self):
650 warnings.warn("isAlive() is deprecated in favor of is_alive()",
651 DeprecationWarning)
652 return self.is_alive()
653
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000654 @property
655 def daemon(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000656 assert self._initialized, "Thread.__init__() not called"
657 return self._daemonic
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000658
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000659 @daemon.setter
660 def daemon(self, daemonic):
Guido van Rossumd0648992007-08-20 19:25:41 +0000661 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000662 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000663 if self._started.is_set():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000664 raise RuntimeError("cannot set daemon status of active thread");
Guido van Rossumd0648992007-08-20 19:25:41 +0000665 self._daemonic = daemonic
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000666
Benjamin Peterson6640d722008-08-18 18:16:46 +0000667 def isDaemon(self):
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000668 warnings.warn("isDaemon() is deprecated in favor of the " \
669 "Thread.daemon property", DeprecationWarning)
Benjamin Peterson6640d722008-08-18 18:16:46 +0000670 return self.daemon
671
672 def setDaemon(self, daemonic):
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000673 warnings.warn("setDaemon() is deprecated in favor of the " \
674 "Thread.daemon property", DeprecationWarning)
Benjamin Peterson6640d722008-08-18 18:16:46 +0000675 self.daemon = daemonic
676
677 def getName(self):
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000678 warnings.warn("getName() is deprecated in favor of the " \
679 "Thread.name property", DeprecationWarning)
Benjamin Peterson6640d722008-08-18 18:16:46 +0000680 return self.name
681
682 def setName(self, name):
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000683 warnings.warn("setName() is deprecated in favor of the " \
684 "Thread.name property", DeprecationWarning)
Benjamin Peterson6640d722008-08-18 18:16:46 +0000685 self.name = name
686
Martin v. Löwis44f86962001-09-05 13:44:54 +0000687# The timer class was contributed by Itamar Shtull-Trauring
688
689def Timer(*args, **kwargs):
690 return _Timer(*args, **kwargs)
691
692class _Timer(Thread):
693 """Call a function after a specified number of seconds:
Tim Petersb64bec32001-09-18 02:26:39 +0000694
Martin v. Löwis44f86962001-09-05 13:44:54 +0000695 t = Timer(30.0, f, args=[], kwargs={})
696 t.start()
697 t.cancel() # stop the timer's action if it's still waiting
698 """
Tim Petersb64bec32001-09-18 02:26:39 +0000699
Martin v. Löwis44f86962001-09-05 13:44:54 +0000700 def __init__(self, interval, function, args=[], kwargs={}):
701 Thread.__init__(self)
702 self.interval = interval
703 self.function = function
704 self.args = args
705 self.kwargs = kwargs
706 self.finished = Event()
Tim Petersb64bec32001-09-18 02:26:39 +0000707
Martin v. Löwis44f86962001-09-05 13:44:54 +0000708 def cancel(self):
709 """Stop the timer if it hasn't finished yet"""
710 self.finished.set()
Tim Petersb64bec32001-09-18 02:26:39 +0000711
Martin v. Löwis44f86962001-09-05 13:44:54 +0000712 def run(self):
713 self.finished.wait(self.interval)
Benjamin Peterson672b8032008-06-11 19:14:14 +0000714 if not self.finished.is_set():
Martin v. Löwis44f86962001-09-05 13:44:54 +0000715 self.function(*self.args, **self.kwargs)
716 self.finished.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000717
718# Special thread class to represent the main thread
719# This is garbage collected through an exit handler
720
721class _MainThread(Thread):
722
723 def __init__(self):
724 Thread.__init__(self, name="MainThread")
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000725 self._started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000726 _active_limbo_lock.acquire()
727 _active[_get_ident()] = self
728 _active_limbo_lock.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000729
730 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000731 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000732
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000733 def _exitfunc(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000734 self._stop()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000735 t = _pickSomeNonDaemonThread()
736 if t:
737 if __debug__:
738 self._note("%s: waiting for other threads", self)
739 while t:
740 t.join()
741 t = _pickSomeNonDaemonThread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000742 if __debug__:
743 self._note("%s: exiting", self)
Guido van Rossumd0648992007-08-20 19:25:41 +0000744 self._delete()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000745
746def _pickSomeNonDaemonThread():
747 for t in enumerate():
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000748 if not t.daemon and t.is_alive():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000749 return t
750 return None
751
752
753# Dummy thread class to represent threads not started here.
Tim Peters711906e2005-01-08 07:30:42 +0000754# These aren't garbage collected when they die, nor can they be waited for.
Benjamin Peterson672b8032008-06-11 19:14:14 +0000755# If they invoke anything in threading.py that calls current_thread(), they
Tim Peters711906e2005-01-08 07:30:42 +0000756# leave an entry in the _active dict forever after.
Benjamin Peterson672b8032008-06-11 19:14:14 +0000757# Their purpose is to return *something* from current_thread().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000758# They are marked as daemon threads so we won't wait for them
759# when we exit (conform previous semantics).
760
761class _DummyThread(Thread):
Tim Petersb90f89a2001-01-15 03:26:36 +0000762
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000763 def __init__(self):
764 Thread.__init__(self, name=_newname("Dummy-%d"))
Tim Peters711906e2005-01-08 07:30:42 +0000765
766 # Thread.__block consumes an OS-level locking primitive, which
767 # can never be used by a _DummyThread. Since a _DummyThread
768 # instance is immortal, that's bad, so release this resource.
Guido van Rossumd0648992007-08-20 19:25:41 +0000769 del self._block
Tim Peters711906e2005-01-08 07:30:42 +0000770
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000771
772 self._started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000773 _active_limbo_lock.acquire()
774 _active[_get_ident()] = self
775 _active_limbo_lock.release()
776
777 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000778 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000779
Neal Norwitz45bec8c2002-02-19 03:01:36 +0000780 def join(self, timeout=None):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000781 assert False, "cannot join a dummy thread"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000782
783
784# Global API functions
785
Benjamin Peterson672b8032008-06-11 19:14:14 +0000786def current_thread():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000787 try:
788 return _active[_get_ident()]
789 except KeyError:
Benjamin Peterson672b8032008-06-11 19:14:14 +0000790 ##print "current_thread(): no current thread for", _get_ident()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000791 return _DummyThread()
792
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000793def currentThread():
794 warnings.warn("currentThread() is deprecated in favor of current_thread()",
795 DeprecationWarning)
796
Benjamin Peterson672b8032008-06-11 19:14:14 +0000797def active_count():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000798 _active_limbo_lock.acquire()
799 count = len(_active) + len(_limbo)
800 _active_limbo_lock.release()
801 return count
802
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000803def activeCount():
804 warnings.warn("activeCount() is deprecated in favor of active_count()",
805 DeprecationWarning)
806 return active_count()
807
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000808def enumerate():
809 _active_limbo_lock.acquire()
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000810 active = list(_active.values()) + list(_limbo.values())
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000811 _active_limbo_lock.release()
812 return active
813
Georg Brandl2067bfd2008-05-25 13:05:15 +0000814from _thread import stack_size
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000815
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000816# Create the main thread object,
817# and make it available for the interpreter
818# (Py_Main) as threading._shutdown.
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000819
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000820_shutdown = _MainThread()._exitfunc
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000821
Jim Fultond15dc062004-07-14 19:11:50 +0000822# get thread-local implementation, either from the thread
823# module, or from the python fallback
824
825try:
Georg Brandl2067bfd2008-05-25 13:05:15 +0000826 from _thread import _local as local
Jim Fultond15dc062004-07-14 19:11:50 +0000827except ImportError:
828 from _threading_local import local
829
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000830
Jesse Nollera8513972008-07-17 16:49:17 +0000831def _after_fork():
832 # This function is called by Python/ceval.c:PyEval_ReInitThreads which
833 # is called from PyOS_AfterFork. Here we cleanup threading module state
834 # that should not exist after a fork.
835
836 # Reset _active_limbo_lock, in case we forked while the lock was held
837 # by another (non-forked) thread. http://bugs.python.org/issue874900
838 global _active_limbo_lock
839 _active_limbo_lock = _allocate_lock()
840
841 # fork() only copied the current thread; clear references to others.
842 new_active = {}
843 current = current_thread()
844 with _active_limbo_lock:
845 for ident, thread in _active.items():
846 if thread is current:
847 # There is only one active thread.
848 new_active[ident] = thread
849 else:
850 # All the others are already stopped.
851 # We don't call _Thread__stop() because it tries to acquire
852 # thread._Thread__block which could also have been held while
853 # we forked.
854 thread._Thread__stopped = True
855
856 _limbo.clear()
857 _active.clear()
858 _active.update(new_active)
859 assert len(_active) == 1
860
861
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000862# Self-test code
863
864def _test():
865
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000866 class BoundedQueue(_Verbose):
867
868 def __init__(self, limit):
869 _Verbose.__init__(self)
870 self.mon = RLock()
871 self.rc = Condition(self.mon)
872 self.wc = Condition(self.mon)
873 self.limit = limit
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000874 self.queue = deque()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000875
876 def put(self, item):
877 self.mon.acquire()
878 while len(self.queue) >= self.limit:
879 self._note("put(%s): queue full", item)
880 self.wc.wait()
881 self.queue.append(item)
882 self._note("put(%s): appended, length now %d",
883 item, len(self.queue))
884 self.rc.notify()
885 self.mon.release()
886
887 def get(self):
888 self.mon.acquire()
889 while not self.queue:
890 self._note("get(): queue empty")
891 self.rc.wait()
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000892 item = self.queue.popleft()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000893 self._note("get(): got %s, %d left", item, len(self.queue))
894 self.wc.notify()
895 self.mon.release()
896 return item
897
898 class ProducerThread(Thread):
899
900 def __init__(self, queue, quota):
901 Thread.__init__(self, name="Producer")
902 self.queue = queue
903 self.quota = quota
904
905 def run(self):
Guido van Rossumb26a1b41998-05-20 17:05:52 +0000906 from random import random
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000907 counter = 0
908 while counter < self.quota:
909 counter = counter + 1
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000910 self.queue.put("%s.%d" % (self.name, counter))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000911 _sleep(random() * 0.00001)
912
913
914 class ConsumerThread(Thread):
915
916 def __init__(self, queue, count):
917 Thread.__init__(self, name="Consumer")
918 self.queue = queue
919 self.count = count
920
921 def run(self):
922 while self.count > 0:
923 item = self.queue.get()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000924 print(item)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000925 self.count = self.count - 1
926
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000927 NP = 3
928 QL = 4
929 NI = 5
930
931 Q = BoundedQueue(QL)
932 P = []
933 for i in range(NP):
934 t = ProducerThread(Q, NI)
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000935 t.name = "Producer-%d" % (i+1)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000936 P.append(t)
937 C = ConsumerThread(Q, NI*NP)
938 for t in P:
939 t.start()
940 _sleep(0.000001)
941 C.start()
942 for t in P:
943 t.join()
944 C.join()
945
946if __name__ == '__main__':
947 _test()