blob: 8a1de42bea6eb208ee13ed80a8e9bf6a2e1270bf [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
4
5try:
6 import thread
7except ImportError:
8 del _sys.modules[__name__]
9 raise
10
Jeffrey Yasskin105f3d42008-03-31 00:35:53 +000011import warnings
Benjamin Petersonf4395602008-06-11 17:50:00 +000012
13from functools import wraps
Fred Drakea8725952002-12-30 23:32:50 +000014from time import time as _time, sleep as _sleep
Neil Schemenauerf607fc52003-11-05 23:03:00 +000015from traceback import format_exc as _format_exc
Raymond Hettinger756b3f32004-01-29 06:37:52 +000016from collections import deque
Guido van Rossum7f5013a1998-04-09 22:01:42 +000017
18# Rename some stuff so "from threading import *" is safe
Benjamin Peterson13f73822008-06-11 18:02:31 +000019__all__ = ['activeCount', 'active_count', 'Condition', 'currentThread',
20 'current_thread', 'enumerate', 'Event',
Tim Peters685e6972003-06-29 16:50:06 +000021 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread',
Andrew MacIntyre92913322006-06-13 15:04:24 +000022 'Timer', 'setprofile', 'settrace', 'local', 'stack_size']
Guido van Rossum7f5013a1998-04-09 22:01:42 +000023
Guido van Rossum7f5013a1998-04-09 22:01:42 +000024_start_new_thread = thread.start_new_thread
25_allocate_lock = thread.allocate_lock
26_get_ident = thread.get_ident
Jeremy Hyltonb5fc7492000-06-01 01:17:17 +000027ThreadError = thread.error
Guido van Rossum7f5013a1998-04-09 22:01:42 +000028del thread
29
Guido van Rossum7f5013a1998-04-09 22:01:42 +000030
Jeffrey Yasskin105f3d42008-03-31 00:35:53 +000031# sys.exc_clear is used to work around the fact that except blocks
32# don't fully clear the exception until 3.0.
33warnings.filterwarnings('ignore', category=DeprecationWarning,
34 module='threading', message='sys.exc_clear')
35
36
Benjamin Petersonf4395602008-06-11 17:50:00 +000037def _old_api(callable, old_name):
38 if not _sys.py3kwarning:
39 return callable
40 @wraps(callable)
41 def old(*args, **kwargs):
42 warnings.warnpy3k("In 3.x, {0} is renamed to {1}."
43 .format(old_name, callable.__name__),
44 stacklevel=3)
45 return callable(*args, **kwargs)
46 old.__name__ = old_name
47 return old
48
Tim Peters59aba122003-07-01 20:01:55 +000049# Debug support (adapted from ihooks.py).
50# All the major classes here derive from _Verbose. We force that to
51# be a new-style class so that all the major classes here are new-style.
52# This helps debugging (type(instance) is more revealing for instances
53# of new-style classes).
Guido van Rossum7f5013a1998-04-09 22:01:42 +000054
Tim Peters0939fac2003-07-01 19:28:44 +000055_VERBOSE = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +000056
57if __debug__:
58
Tim Peters59aba122003-07-01 20:01:55 +000059 class _Verbose(object):
Guido van Rossum7f5013a1998-04-09 22:01:42 +000060
61 def __init__(self, verbose=None):
62 if verbose is None:
63 verbose = _VERBOSE
64 self.__verbose = verbose
65
66 def _note(self, format, *args):
67 if self.__verbose:
68 format = format % args
69 format = "%s: %s\n" % (
Benjamin Peterson0fbcf692008-06-11 17:27:50 +000070 current_thread().get_name(), format)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000071 _sys.stderr.write(format)
72
73else:
74 # Disable this when using "python -O"
Tim Peters59aba122003-07-01 20:01:55 +000075 class _Verbose(object):
Guido van Rossum7f5013a1998-04-09 22:01:42 +000076 def __init__(self, verbose=None):
77 pass
78 def _note(self, *args):
79 pass
80
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000081# Support for profile and trace hooks
82
83_profile_hook = None
84_trace_hook = None
85
86def setprofile(func):
87 global _profile_hook
88 _profile_hook = func
Tim Petersd1b108b2003-06-29 17:24:17 +000089
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000090def settrace(func):
91 global _trace_hook
92 _trace_hook = func
Guido van Rossum7f5013a1998-04-09 22:01:42 +000093
94# Synchronization classes
95
96Lock = _allocate_lock
97
98def RLock(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +000099 return _RLock(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000100
101class _RLock(_Verbose):
Tim Petersb90f89a2001-01-15 03:26:36 +0000102
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000103 def __init__(self, verbose=None):
104 _Verbose.__init__(self, verbose)
105 self.__block = _allocate_lock()
106 self.__owner = None
107 self.__count = 0
108
109 def __repr__(self):
Nick Coghlanf8bbaa92007-07-31 13:38:01 +0000110 owner = self.__owner
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000111 return "<%s(%s, %d)>" % (
112 self.__class__.__name__,
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000113 owner and owner.get_name(),
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000114 self.__count)
115
116 def acquire(self, blocking=1):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000117 me = current_thread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000118 if self.__owner is me:
119 self.__count = self.__count + 1
120 if __debug__:
121 self._note("%s.acquire(%s): recursive success", self, blocking)
122 return 1
123 rc = self.__block.acquire(blocking)
124 if rc:
125 self.__owner = me
126 self.__count = 1
127 if __debug__:
Brett Cannon90cece72005-01-27 22:48:30 +0000128 self._note("%s.acquire(%s): initial success", self, blocking)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000129 else:
130 if __debug__:
131 self._note("%s.acquire(%s): failure", self, blocking)
132 return rc
133
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000134 __enter__ = acquire
135
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000136 def release(self):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000137 if self.__owner is not current_thread():
Collin Winter50b79ce2007-06-06 00:17:35 +0000138 raise RuntimeError("cannot release un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000139 self.__count = count = self.__count - 1
140 if not count:
141 self.__owner = None
142 self.__block.release()
143 if __debug__:
144 self._note("%s.release(): final release", self)
145 else:
146 if __debug__:
147 self._note("%s.release(): non-final release", self)
148
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000149 def __exit__(self, t, v, tb):
150 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000151
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000152 # Internal methods used by condition variables
153
154 def _acquire_restore(self, (count, owner)):
155 self.__block.acquire()
156 self.__count = count
157 self.__owner = owner
158 if __debug__:
159 self._note("%s._acquire_restore()", self)
160
161 def _release_save(self):
162 if __debug__:
163 self._note("%s._release_save()", self)
164 count = self.__count
165 self.__count = 0
166 owner = self.__owner
167 self.__owner = None
168 self.__block.release()
169 return (count, owner)
170
171 def _is_owned(self):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000172 return self.__owner is current_thread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000173
174
175def Condition(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000176 return _Condition(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000177
178class _Condition(_Verbose):
179
180 def __init__(self, lock=None, verbose=None):
181 _Verbose.__init__(self, verbose)
182 if lock is None:
183 lock = RLock()
184 self.__lock = lock
185 # Export the lock's acquire() and release() methods
186 self.acquire = lock.acquire
187 self.release = lock.release
188 # If the lock defines _release_save() and/or _acquire_restore(),
189 # these override the default implementations (which just call
190 # release() and acquire() on the lock). Ditto for _is_owned().
191 try:
192 self._release_save = lock._release_save
193 except AttributeError:
194 pass
195 try:
196 self._acquire_restore = lock._acquire_restore
197 except AttributeError:
198 pass
199 try:
200 self._is_owned = lock._is_owned
201 except AttributeError:
202 pass
203 self.__waiters = []
204
Guido van Rossumda5b7012006-05-02 19:47:52 +0000205 def __enter__(self):
206 return self.__lock.__enter__()
207
208 def __exit__(self, *args):
209 return self.__lock.__exit__(*args)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000210
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000211 def __repr__(self):
212 return "<Condition(%s, %d)>" % (self.__lock, len(self.__waiters))
213
214 def _release_save(self):
215 self.__lock.release() # No state to save
216
217 def _acquire_restore(self, x):
218 self.__lock.acquire() # Ignore saved state
219
220 def _is_owned(self):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000221 # Return True if lock is owned by current_thread.
Jeremy Hyltonaf7fde72002-08-14 17:43:59 +0000222 # This method is called only if __lock doesn't have _is_owned().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000223 if self.__lock.acquire(0):
224 self.__lock.release()
Tim Petersbc0e9102002-04-04 22:55:58 +0000225 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000226 else:
Tim Petersbc0e9102002-04-04 22:55:58 +0000227 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000228
229 def wait(self, timeout=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000230 if not self._is_owned():
231 raise RuntimeError("cannot wait on un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000232 waiter = _allocate_lock()
233 waiter.acquire()
234 self.__waiters.append(waiter)
235 saved_state = self._release_save()
Tim Petersc951bf92001-04-02 20:15:57 +0000236 try: # restore state no matter what (e.g., KeyboardInterrupt)
237 if timeout is None:
238 waiter.acquire()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000239 if __debug__:
Tim Petersc951bf92001-04-02 20:15:57 +0000240 self._note("%s.wait(): got it", self)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000241 else:
Tim Petersa6a4f272001-08-12 00:41:33 +0000242 # Balancing act: We can't afford a pure busy loop, so we
243 # have to sleep; but if we sleep the whole timeout time,
244 # we'll be unresponsive. The scheme here sleeps very
245 # little at first, longer as time goes on, but never longer
246 # than 20 times per second (or the timeout time remaining).
Tim Petersc951bf92001-04-02 20:15:57 +0000247 endtime = _time() + timeout
Tim Petersa6a4f272001-08-12 00:41:33 +0000248 delay = 0.0005 # 500 us -> initial delay of 1 ms
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000249 while True:
Tim Petersc951bf92001-04-02 20:15:57 +0000250 gotit = waiter.acquire(0)
Tim Petersa6a4f272001-08-12 00:41:33 +0000251 if gotit:
Tim Petersc951bf92001-04-02 20:15:57 +0000252 break
Tim Petersa6a4f272001-08-12 00:41:33 +0000253 remaining = endtime - _time()
254 if remaining <= 0:
255 break
256 delay = min(delay * 2, remaining, .05)
Tim Petersc951bf92001-04-02 20:15:57 +0000257 _sleep(delay)
Tim Petersc951bf92001-04-02 20:15:57 +0000258 if not gotit:
259 if __debug__:
260 self._note("%s.wait(%s): timed out", self, timeout)
261 try:
262 self.__waiters.remove(waiter)
263 except ValueError:
264 pass
265 else:
266 if __debug__:
267 self._note("%s.wait(%s): got it", self, timeout)
268 finally:
269 self._acquire_restore(saved_state)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000270
271 def notify(self, n=1):
Collin Winter50b79ce2007-06-06 00:17:35 +0000272 if not self._is_owned():
273 raise RuntimeError("cannot notify on un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000274 __waiters = self.__waiters
275 waiters = __waiters[:n]
276 if not waiters:
277 if __debug__:
278 self._note("%s.notify(): no waiters", self)
279 return
280 self._note("%s.notify(): notifying %d waiter%s", self, n,
281 n!=1 and "s" or "")
282 for waiter in waiters:
283 waiter.release()
284 try:
285 __waiters.remove(waiter)
286 except ValueError:
287 pass
288
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000289 def notify_all(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000290 self.notify(len(self.__waiters))
291
Benjamin Petersonf4395602008-06-11 17:50:00 +0000292 notifyAll = _old_api(notify_all, "notifyAll")
293
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000294
295def Semaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000296 return _Semaphore(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000297
298class _Semaphore(_Verbose):
299
Andrew M. Kuchling39d3bfc2000-02-29 00:10:24 +0000300 # After Tim Peters' semaphore class, but not quite the same (no maximum)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000301
302 def __init__(self, value=1, verbose=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000303 if value < 0:
304 raise ValueError("semaphore initial value must be >= 0")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000305 _Verbose.__init__(self, verbose)
306 self.__cond = Condition(Lock())
307 self.__value = value
308
309 def acquire(self, blocking=1):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000310 rc = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000311 self.__cond.acquire()
312 while self.__value == 0:
313 if not blocking:
314 break
Skip Montanarob446fc72001-08-19 04:25:24 +0000315 if __debug__:
316 self._note("%s.acquire(%s): blocked waiting, value=%s",
317 self, blocking, self.__value)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000318 self.__cond.wait()
319 else:
320 self.__value = self.__value - 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000321 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000322 self._note("%s.acquire: success, value=%s",
323 self, self.__value)
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000324 rc = True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000325 self.__cond.release()
326 return rc
327
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000328 __enter__ = acquire
329
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000330 def release(self):
331 self.__cond.acquire()
332 self.__value = self.__value + 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000333 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000334 self._note("%s.release: success, value=%s",
335 self, self.__value)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000336 self.__cond.notify()
337 self.__cond.release()
338
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000339 def __exit__(self, t, v, tb):
340 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000341
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000342
Skip Montanaroe428bb72001-08-20 20:27:58 +0000343def BoundedSemaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000344 return _BoundedSemaphore(*args, **kwargs)
Skip Montanaroe428bb72001-08-20 20:27:58 +0000345
346class _BoundedSemaphore(_Semaphore):
347 """Semaphore that checks that # releases is <= # acquires"""
348 def __init__(self, value=1, verbose=None):
349 _Semaphore.__init__(self, value, verbose)
350 self._initial_value = value
351
352 def release(self):
353 if self._Semaphore__value >= self._initial_value:
354 raise ValueError, "Semaphore released too many times"
355 return _Semaphore.release(self)
356
357
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000358def Event(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000359 return _Event(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000360
361class _Event(_Verbose):
362
363 # After Tim Peters' event class (without is_posted())
364
365 def __init__(self, verbose=None):
366 _Verbose.__init__(self, verbose)
367 self.__cond = Condition(Lock())
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000368 self.__flag = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000369
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000370 def is_set(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000371 return self.__flag
372
Benjamin Petersonf4395602008-06-11 17:50:00 +0000373 isSet = _old_api(is_set, "isSet")
374
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000375 def set(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000376 self.__cond.acquire()
377 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000378 self.__flag = True
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000379 self.__cond.notify_all()
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000380 finally:
381 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000382
383 def clear(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000384 self.__cond.acquire()
385 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000386 self.__flag = False
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000387 finally:
388 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000389
390 def wait(self, timeout=None):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000391 self.__cond.acquire()
392 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000393 if not self.__flag:
394 self.__cond.wait(timeout)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000395 finally:
396 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000397
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000398# Helper to generate new thread names
399_counter = 0
400def _newname(template="Thread-%d"):
401 global _counter
402 _counter = _counter + 1
403 return template % _counter
404
405# Active thread administration
406_active_limbo_lock = _allocate_lock()
Tim Peters711906e2005-01-08 07:30:42 +0000407_active = {} # maps thread id to Thread object
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000408_limbo = {}
409
410
411# Main class for threads
412
413class Thread(_Verbose):
414
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000415 __initialized = False
Brett Cannoncc4e9352004-07-03 03:52:35 +0000416 # Need to store a reference to sys.exc_info for printing
417 # out exceptions when a thread tries to use a global var. during interp.
418 # shutdown and thus raises an exception about trying to perform some
419 # operation on/with a NoneType
420 __exc_info = _sys.exc_info
Jeffrey Yasskin8b9091f2008-03-28 04:11:18 +0000421 # Keep sys.exc_clear too to clear the exception just before
422 # allowing .join() to return.
423 __exc_clear = _sys.exc_clear
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000424
425 def __init__(self, group=None, target=None, name=None,
Georg Brandla4a8b822005-07-15 09:13:21 +0000426 args=(), kwargs=None, verbose=None):
Guido van Rossum5a43e1a1998-06-09 19:04:26 +0000427 assert group is None, "group argument must be None for now"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000428 _Verbose.__init__(self, verbose)
Georg Brandla4a8b822005-07-15 09:13:21 +0000429 if kwargs is None:
430 kwargs = {}
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000431 self.__target = target
432 self.__name = str(name or _newname())
433 self.__args = args
434 self.__kwargs = kwargs
435 self.__daemonic = self._set_daemon()
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000436 self.__ident = None
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000437 self.__started = Event()
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000438 self.__stopped = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000439 self.__block = Condition(Lock())
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000440 self.__initialized = True
Brett Cannoncc4e9352004-07-03 03:52:35 +0000441 # sys.stderr is not stored in the class like
442 # sys.exc_info since it can be changed between instances
443 self.__stderr = _sys.stderr
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000444
445 def _set_daemon(self):
446 # Overridden in _MainThread and _DummyThread
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000447 return current_thread().is_daemon()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000448
449 def __repr__(self):
450 assert self.__initialized, "Thread.__init__() was not called"
451 status = "initial"
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000452 if self.__started.is_set():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000453 status = "started"
454 if self.__stopped:
455 status = "stopped"
456 if self.__daemonic:
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000457 status += " daemon"
458 if self.__ident is not None:
459 status += " %s" % self.__ident
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000460 return "<%s(%s, %s)>" % (self.__class__.__name__, self.__name, status)
461
462 def start(self):
Collin Winter50b79ce2007-06-06 00:17:35 +0000463 if not self.__initialized:
464 raise RuntimeError("thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000465 if self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000466 raise RuntimeError("thread already started")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000467 if __debug__:
468 self._note("%s.start(): starting thread", self)
469 _active_limbo_lock.acquire()
470 _limbo[self] = self
471 _active_limbo_lock.release()
472 _start_new_thread(self.__bootstrap, ())
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000473 self.__started.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000474
475 def run(self):
Jeffrey Yasskina885c152008-02-23 20:40:35 +0000476 try:
477 if self.__target:
478 self.__target(*self.__args, **self.__kwargs)
479 finally:
480 # Avoid a refcycle if the thread is running a function with
481 # an argument that has a member that points to the thread.
482 del self.__target, self.__args, self.__kwargs
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000483
484 def __bootstrap(self):
Guido van Rossum54ec61e2007-08-20 15:18:04 +0000485 # Wrapper around the real bootstrap code that ignores
486 # exceptions during interpreter cleanup. Those typically
487 # happen when a daemon thread wakes up at an unfortunate
488 # moment, finds the world around it destroyed, and raises some
489 # random exception *** while trying to report the exception in
490 # __bootstrap_inner() below ***. Those random exceptions
491 # don't help anybody, and they confuse users, so we suppress
492 # them. We suppress them only when it appears that the world
493 # indeed has already been destroyed, so that exceptions in
494 # __bootstrap_inner() during normal business hours are properly
495 # reported. Also, we only suppress them for daemonic threads;
496 # if a non-daemonic encounters this, something else is wrong.
497 try:
498 self.__bootstrap_inner()
499 except:
500 if self.__daemonic and _sys is None:
501 return
502 raise
503
504 def __bootstrap_inner(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000505 try:
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000506 self.__ident = _get_ident()
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000507 self.__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000508 _active_limbo_lock.acquire()
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000509 _active[self.__ident] = self
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000510 del _limbo[self]
511 _active_limbo_lock.release()
512 if __debug__:
513 self._note("%s.__bootstrap(): thread started", self)
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000514
515 if _trace_hook:
516 self._note("%s.__bootstrap(): registering trace hook", self)
517 _sys.settrace(_trace_hook)
518 if _profile_hook:
519 self._note("%s.__bootstrap(): registering profile hook", self)
520 _sys.setprofile(_profile_hook)
Tim Petersd1b108b2003-06-29 17:24:17 +0000521
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000522 try:
523 self.run()
524 except SystemExit:
525 if __debug__:
526 self._note("%s.__bootstrap(): raised SystemExit", self)
527 except:
528 if __debug__:
529 self._note("%s.__bootstrap(): unhandled exception", self)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000530 # If sys.stderr is no more (most likely from interpreter
531 # shutdown) use self.__stderr. Otherwise still use sys (as in
532 # _sys) in case sys.stderr was redefined since the creation of
533 # self.
534 if _sys:
535 _sys.stderr.write("Exception in thread %s:\n%s\n" %
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000536 (self.get_name(), _format_exc()))
Brett Cannoncc4e9352004-07-03 03:52:35 +0000537 else:
538 # Do the best job possible w/o a huge amt. of code to
539 # approximate a traceback (code ideas from
540 # Lib/traceback.py)
541 exc_type, exc_value, exc_tb = self.__exc_info()
542 try:
543 print>>self.__stderr, (
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000544 "Exception in thread " + self.get_name() +
Brett Cannoncc4e9352004-07-03 03:52:35 +0000545 " (most likely raised during interpreter shutdown):")
546 print>>self.__stderr, (
547 "Traceback (most recent call last):")
548 while exc_tb:
549 print>>self.__stderr, (
550 ' File "%s", line %s, in %s' %
551 (exc_tb.tb_frame.f_code.co_filename,
552 exc_tb.tb_lineno,
553 exc_tb.tb_frame.f_code.co_name))
554 exc_tb = exc_tb.tb_next
555 print>>self.__stderr, ("%s: %s" % (exc_type, exc_value))
556 # Make sure that exc_tb gets deleted since it is a memory
557 # hog; deleting everything else is just for thoroughness
558 finally:
559 del exc_type, exc_value, exc_tb
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000560 else:
561 if __debug__:
562 self._note("%s.__bootstrap(): normal return", self)
Jeffrey Yasskin8b9091f2008-03-28 04:11:18 +0000563 finally:
564 # Prevent a race in
565 # test_threading.test_no_refcycle_through_target when
566 # the exception keeps the target alive past when we
567 # assert that it's dead.
Amaury Forgeot d'Arc504a48f2008-03-29 01:41:08 +0000568 self.__exc_clear()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000569 finally:
Gregory P. Smith95cd5c02008-01-22 01:20:42 +0000570 with _active_limbo_lock:
571 self.__stop()
572 try:
573 # We don't call self.__delete() because it also
574 # grabs _active_limbo_lock.
575 del _active[_get_ident()]
576 except:
577 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000578
579 def __stop(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000580 self.__block.acquire()
581 self.__stopped = True
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000582 self.__block.notify_all()
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000583 self.__block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000584
585 def __delete(self):
Tim Peters21429932004-07-21 03:36:52 +0000586 "Remove current thread from the dict of currently running threads."
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000587
Tim Peters21429932004-07-21 03:36:52 +0000588 # Notes about running with dummy_thread:
589 #
590 # Must take care to not raise an exception if dummy_thread is being
591 # used (and thus this module is being used as an instance of
592 # dummy_threading). dummy_thread.get_ident() always returns -1 since
593 # there is only one thread if dummy_thread is being used. Thus
594 # len(_active) is always <= 1 here, and any Thread instance created
595 # overwrites the (if any) thread currently registered in _active.
596 #
597 # An instance of _MainThread is always created by 'threading'. This
598 # gets overwritten the instant an instance of Thread is created; both
599 # threads return -1 from dummy_thread.get_ident() and thus have the
600 # same key in the dict. So when the _MainThread instance created by
601 # 'threading' tries to clean itself up when atexit calls this method
602 # it gets a KeyError if another Thread instance was created.
603 #
604 # This all means that KeyError from trying to delete something from
605 # _active if dummy_threading is being used is a red herring. But
606 # since it isn't if dummy_threading is *not* being used then don't
607 # hide the exception.
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000608
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000609 try:
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000610 with _active_limbo_lock:
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000611 del _active[_get_ident()]
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000612 # There must not be any python code between the previous line
613 # and after the lock is released. Otherwise a tracing function
614 # could try to acquire the lock again in the same thread, (in
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000615 # current_thread()), and would block.
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000616 except KeyError:
617 if 'dummy_threading' not in _sys.modules:
618 raise
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000619
620 def join(self, timeout=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000621 if not self.__initialized:
622 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000623 if not self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000624 raise RuntimeError("cannot join thread before it is started")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000625 if self is current_thread():
Collin Winter50b79ce2007-06-06 00:17:35 +0000626 raise RuntimeError("cannot join current thread")
627
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000628 if __debug__:
629 if not self.__stopped:
630 self._note("%s.join(): waiting until thread stops", self)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000631 self.__block.acquire()
632 try:
Brett Cannonad07ff22005-11-23 02:15:50 +0000633 if timeout is None:
634 while not self.__stopped:
635 self.__block.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000636 if __debug__:
637 self._note("%s.join(): thread stopped", self)
Brett Cannonad07ff22005-11-23 02:15:50 +0000638 else:
639 deadline = _time() + timeout
640 while not self.__stopped:
641 delay = deadline - _time()
642 if delay <= 0:
643 if __debug__:
644 self._note("%s.join(): timed out", self)
645 break
646 self.__block.wait(delay)
647 else:
648 if __debug__:
649 self._note("%s.join(): thread stopped", self)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000650 finally:
651 self.__block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000652
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000653 def get_name(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000654 assert self.__initialized, "Thread.__init__() not called"
655 return self.__name
656
Benjamin Petersonf4395602008-06-11 17:50:00 +0000657 getName = _old_api(get_name, "getName")
658
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000659 def set_name(self, name):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000660 assert self.__initialized, "Thread.__init__() not called"
661 self.__name = str(name)
662
Benjamin Petersonf4395602008-06-11 17:50:00 +0000663 setName = _old_api(set_name, "setName")
664
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000665 def get_ident(self):
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000666 assert self.__initialized, "Thread.__init__() not called"
667 return self.__ident
668
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000669 def is_alive(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000670 assert self.__initialized, "Thread.__init__() not called"
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000671 return self.__started.is_set() and not self.__stopped
Tim Petersb90f89a2001-01-15 03:26:36 +0000672
Benjamin Petersonf4395602008-06-11 17:50:00 +0000673 isAlive = _old_api(is_alive, "isAlive")
674
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000675 def is_daemon(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000676 assert self.__initialized, "Thread.__init__() not called"
677 return self.__daemonic
678
Benjamin Petersonf4395602008-06-11 17:50:00 +0000679 isDaemon = _old_api(is_daemon, "isDaemon")
680
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000681 def set_daemon(self, daemonic):
Collin Winter50b79ce2007-06-06 00:17:35 +0000682 if not self.__initialized:
683 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000684 if self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000685 raise RuntimeError("cannot set daemon status of active thread");
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000686 self.__daemonic = daemonic
687
Benjamin Petersonf4395602008-06-11 17:50:00 +0000688 setDaemon = _old_api(set_daemon, "setDaemon")
689
Martin v. Löwis44f86962001-09-05 13:44:54 +0000690# The timer class was contributed by Itamar Shtull-Trauring
691
692def Timer(*args, **kwargs):
693 return _Timer(*args, **kwargs)
694
695class _Timer(Thread):
696 """Call a function after a specified number of seconds:
Tim Petersb64bec32001-09-18 02:26:39 +0000697
Martin v. Löwis44f86962001-09-05 13:44:54 +0000698 t = Timer(30.0, f, args=[], kwargs={})
699 t.start()
700 t.cancel() # stop the timer's action if it's still waiting
701 """
Tim Petersb64bec32001-09-18 02:26:39 +0000702
Martin v. Löwis44f86962001-09-05 13:44:54 +0000703 def __init__(self, interval, function, args=[], kwargs={}):
704 Thread.__init__(self)
705 self.interval = interval
706 self.function = function
707 self.args = args
708 self.kwargs = kwargs
709 self.finished = Event()
Tim Petersb64bec32001-09-18 02:26:39 +0000710
Martin v. Löwis44f86962001-09-05 13:44:54 +0000711 def cancel(self):
712 """Stop the timer if it hasn't finished yet"""
713 self.finished.set()
Tim Petersb64bec32001-09-18 02:26:39 +0000714
Martin v. Löwis44f86962001-09-05 13:44:54 +0000715 def run(self):
716 self.finished.wait(self.interval)
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000717 if not self.finished.is_set():
Martin v. Löwis44f86962001-09-05 13:44:54 +0000718 self.function(*self.args, **self.kwargs)
719 self.finished.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000720
721# Special thread class to represent the main thread
722# This is garbage collected through an exit handler
723
724class _MainThread(Thread):
725
726 def __init__(self):
727 Thread.__init__(self, name="MainThread")
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000728 self._Thread__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000729 _active_limbo_lock.acquire()
730 _active[_get_ident()] = self
731 _active_limbo_lock.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000732
733 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000734 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000735
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000736 def _exitfunc(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000737 self._Thread__stop()
738 t = _pickSomeNonDaemonThread()
739 if t:
740 if __debug__:
741 self._note("%s: waiting for other threads", self)
742 while t:
743 t.join()
744 t = _pickSomeNonDaemonThread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000745 if __debug__:
746 self._note("%s: exiting", self)
747 self._Thread__delete()
748
749def _pickSomeNonDaemonThread():
750 for t in enumerate():
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000751 if not t.is_daemon() and t.is_alive():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000752 return t
753 return None
754
755
756# Dummy thread class to represent threads not started here.
Tim Peters711906e2005-01-08 07:30:42 +0000757# These aren't garbage collected when they die, nor can they be waited for.
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000758# If they invoke anything in threading.py that calls current_thread(), they
Tim Peters711906e2005-01-08 07:30:42 +0000759# leave an entry in the _active dict forever after.
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000760# Their purpose is to return *something* from current_thread().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000761# They are marked as daemon threads so we won't wait for them
762# when we exit (conform previous semantics).
763
764class _DummyThread(Thread):
Tim Petersb90f89a2001-01-15 03:26:36 +0000765
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000766 def __init__(self):
767 Thread.__init__(self, name=_newname("Dummy-%d"))
Tim Peters711906e2005-01-08 07:30:42 +0000768
769 # Thread.__block consumes an OS-level locking primitive, which
770 # can never be used by a _DummyThread. Since a _DummyThread
771 # instance is immortal, that's bad, so release this resource.
Brett Cannone6539c42005-01-08 02:43:53 +0000772 del self._Thread__block
Tim Peters711906e2005-01-08 07:30:42 +0000773
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000774 self._Thread__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000775 _active_limbo_lock.acquire()
776 _active[_get_ident()] = self
777 _active_limbo_lock.release()
778
779 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000780 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000781
Neal Norwitz45bec8c2002-02-19 03:01:36 +0000782 def join(self, timeout=None):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000783 assert False, "cannot join a dummy thread"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000784
785
786# Global API functions
787
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000788def current_thread():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000789 try:
790 return _active[_get_ident()]
791 except KeyError:
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000792 ##print "current_thread(): no current thread for", _get_ident()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000793 return _DummyThread()
794
Benjamin Petersonf4395602008-06-11 17:50:00 +0000795currentThread = _old_api(current_thread, "currentThread")
796
Benjamin Peterson0fbcf692008-06-11 17:27:50 +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 Petersonf4395602008-06-11 17:50:00 +0000803activeCount = _old_api(active_count, "activeCount")
804
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000805def enumerate():
806 _active_limbo_lock.acquire()
807 active = _active.values() + _limbo.values()
808 _active_limbo_lock.release()
809 return active
810
Andrew MacIntyre92913322006-06-13 15:04:24 +0000811from thread import stack_size
812
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000813# Create the main thread object,
814# and make it available for the interpreter
815# (Py_Main) as threading._shutdown.
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000816
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000817_shutdown = _MainThread()._exitfunc
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000818
Jim Fultond15dc062004-07-14 19:11:50 +0000819# get thread-local implementation, either from the thread
820# module, or from the python fallback
821
822try:
823 from thread import _local as local
824except ImportError:
825 from _threading_local import local
826
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000827
Jesse Noller5e62ca42008-07-16 20:03:47 +0000828def _after_fork():
829 # This function is called by Python/ceval.c:PyEval_ReInitThreads which
830 # is called from PyOS_AfterFork. Here we cleanup threading module state
831 # that should not exist after a fork.
832
833 # Reset _active_limbo_lock, in case we forked while the lock was held
834 # by another (non-forked) thread. http://bugs.python.org/issue874900
835 global _active_limbo_lock
836 _active_limbo_lock = _allocate_lock()
837
838 # fork() only copied the current thread; clear references to others.
839 new_active = {}
840 current = current_thread()
841 with _active_limbo_lock:
842 for ident, thread in _active.iteritems():
843 if thread is current:
844 # There is only one active thread.
845 new_active[ident] = thread
846 else:
847 # All the others are already stopped.
848 # We don't call _Thread__stop() because it tries to acquire
849 # thread._Thread__block which could also have been held while
850 # we forked.
851 thread._Thread__stopped = True
852
853 _limbo.clear()
854 _active.clear()
855 _active.update(new_active)
856 assert len(_active) == 1
857
858
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000859# Self-test code
860
861def _test():
862
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000863 class BoundedQueue(_Verbose):
864
865 def __init__(self, limit):
866 _Verbose.__init__(self)
867 self.mon = RLock()
868 self.rc = Condition(self.mon)
869 self.wc = Condition(self.mon)
870 self.limit = limit
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000871 self.queue = deque()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000872
873 def put(self, item):
874 self.mon.acquire()
875 while len(self.queue) >= self.limit:
876 self._note("put(%s): queue full", item)
877 self.wc.wait()
878 self.queue.append(item)
879 self._note("put(%s): appended, length now %d",
880 item, len(self.queue))
881 self.rc.notify()
882 self.mon.release()
883
884 def get(self):
885 self.mon.acquire()
886 while not self.queue:
887 self._note("get(): queue empty")
888 self.rc.wait()
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000889 item = self.queue.popleft()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000890 self._note("get(): got %s, %d left", item, len(self.queue))
891 self.wc.notify()
892 self.mon.release()
893 return item
894
895 class ProducerThread(Thread):
896
897 def __init__(self, queue, quota):
898 Thread.__init__(self, name="Producer")
899 self.queue = queue
900 self.quota = quota
901
902 def run(self):
Guido van Rossumb26a1b41998-05-20 17:05:52 +0000903 from random import random
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000904 counter = 0
905 while counter < self.quota:
906 counter = counter + 1
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000907 self.queue.put("%s.%d" % (self.get_name(), counter))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000908 _sleep(random() * 0.00001)
909
910
911 class ConsumerThread(Thread):
912
913 def __init__(self, queue, count):
914 Thread.__init__(self, name="Consumer")
915 self.queue = queue
916 self.count = count
917
918 def run(self):
919 while self.count > 0:
920 item = self.queue.get()
921 print item
922 self.count = self.count - 1
923
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000924 NP = 3
925 QL = 4
926 NI = 5
927
928 Q = BoundedQueue(QL)
929 P = []
930 for i in range(NP):
931 t = ProducerThread(Q, NI)
932 t.setName("Producer-%d" % (i+1))
933 P.append(t)
934 C = ConsumerThread(Q, NI*NP)
935 for t in P:
936 t.start()
937 _sleep(0.000001)
938 C.start()
939 for t in P:
940 t.join()
941 C.join()
942
943if __name__ == '__main__':
944 _test()