blob: d88f1be4ea37d48a2d069e17a22fe643f1d26888 [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
Brett Cannon20050502008-08-02 03:13:46 +0000154 def _acquire_restore(self, count_owner):
155 count, owner = count_owner
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000156 self.__block.acquire()
157 self.__count = count
158 self.__owner = owner
159 if __debug__:
160 self._note("%s._acquire_restore()", self)
161
162 def _release_save(self):
163 if __debug__:
164 self._note("%s._release_save()", self)
165 count = self.__count
166 self.__count = 0
167 owner = self.__owner
168 self.__owner = None
169 self.__block.release()
170 return (count, owner)
171
172 def _is_owned(self):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000173 return self.__owner is current_thread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000174
175
176def Condition(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000177 return _Condition(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000178
179class _Condition(_Verbose):
180
181 def __init__(self, lock=None, verbose=None):
182 _Verbose.__init__(self, verbose)
183 if lock is None:
184 lock = RLock()
185 self.__lock = lock
186 # Export the lock's acquire() and release() methods
187 self.acquire = lock.acquire
188 self.release = lock.release
189 # If the lock defines _release_save() and/or _acquire_restore(),
190 # these override the default implementations (which just call
191 # release() and acquire() on the lock). Ditto for _is_owned().
192 try:
193 self._release_save = lock._release_save
194 except AttributeError:
195 pass
196 try:
197 self._acquire_restore = lock._acquire_restore
198 except AttributeError:
199 pass
200 try:
201 self._is_owned = lock._is_owned
202 except AttributeError:
203 pass
204 self.__waiters = []
205
Guido van Rossumda5b7012006-05-02 19:47:52 +0000206 def __enter__(self):
207 return self.__lock.__enter__()
208
209 def __exit__(self, *args):
210 return self.__lock.__exit__(*args)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000211
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000212 def __repr__(self):
213 return "<Condition(%s, %d)>" % (self.__lock, len(self.__waiters))
214
215 def _release_save(self):
216 self.__lock.release() # No state to save
217
218 def _acquire_restore(self, x):
219 self.__lock.acquire() # Ignore saved state
220
221 def _is_owned(self):
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000222 # Return True if lock is owned by current_thread.
Jeremy Hyltonaf7fde72002-08-14 17:43:59 +0000223 # This method is called only if __lock doesn't have _is_owned().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000224 if self.__lock.acquire(0):
225 self.__lock.release()
Tim Petersbc0e9102002-04-04 22:55:58 +0000226 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000227 else:
Tim Petersbc0e9102002-04-04 22:55:58 +0000228 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000229
230 def wait(self, timeout=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000231 if not self._is_owned():
232 raise RuntimeError("cannot wait on un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000233 waiter = _allocate_lock()
234 waiter.acquire()
235 self.__waiters.append(waiter)
236 saved_state = self._release_save()
Tim Petersc951bf92001-04-02 20:15:57 +0000237 try: # restore state no matter what (e.g., KeyboardInterrupt)
238 if timeout is None:
239 waiter.acquire()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000240 if __debug__:
Tim Petersc951bf92001-04-02 20:15:57 +0000241 self._note("%s.wait(): got it", self)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000242 else:
Tim Petersa6a4f272001-08-12 00:41:33 +0000243 # Balancing act: We can't afford a pure busy loop, so we
244 # have to sleep; but if we sleep the whole timeout time,
245 # we'll be unresponsive. The scheme here sleeps very
246 # little at first, longer as time goes on, but never longer
247 # than 20 times per second (or the timeout time remaining).
Tim Petersc951bf92001-04-02 20:15:57 +0000248 endtime = _time() + timeout
Tim Petersa6a4f272001-08-12 00:41:33 +0000249 delay = 0.0005 # 500 us -> initial delay of 1 ms
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000250 while True:
Tim Petersc951bf92001-04-02 20:15:57 +0000251 gotit = waiter.acquire(0)
Tim Petersa6a4f272001-08-12 00:41:33 +0000252 if gotit:
Tim Petersc951bf92001-04-02 20:15:57 +0000253 break
Tim Petersa6a4f272001-08-12 00:41:33 +0000254 remaining = endtime - _time()
255 if remaining <= 0:
256 break
257 delay = min(delay * 2, remaining, .05)
Tim Petersc951bf92001-04-02 20:15:57 +0000258 _sleep(delay)
Tim Petersc951bf92001-04-02 20:15:57 +0000259 if not gotit:
260 if __debug__:
261 self._note("%s.wait(%s): timed out", self, timeout)
262 try:
263 self.__waiters.remove(waiter)
264 except ValueError:
265 pass
266 else:
267 if __debug__:
268 self._note("%s.wait(%s): got it", self, timeout)
269 finally:
270 self._acquire_restore(saved_state)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000271
272 def notify(self, n=1):
Collin Winter50b79ce2007-06-06 00:17:35 +0000273 if not self._is_owned():
274 raise RuntimeError("cannot notify on un-aquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000275 __waiters = self.__waiters
276 waiters = __waiters[:n]
277 if not waiters:
278 if __debug__:
279 self._note("%s.notify(): no waiters", self)
280 return
281 self._note("%s.notify(): notifying %d waiter%s", self, n,
282 n!=1 and "s" or "")
283 for waiter in waiters:
284 waiter.release()
285 try:
286 __waiters.remove(waiter)
287 except ValueError:
288 pass
289
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000290 def notify_all(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000291 self.notify(len(self.__waiters))
292
Benjamin Petersonf4395602008-06-11 17:50:00 +0000293 notifyAll = _old_api(notify_all, "notifyAll")
294
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000295
296def Semaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000297 return _Semaphore(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000298
299class _Semaphore(_Verbose):
300
Andrew M. Kuchling39d3bfc2000-02-29 00:10:24 +0000301 # After Tim Peters' semaphore class, but not quite the same (no maximum)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000302
303 def __init__(self, value=1, verbose=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000304 if value < 0:
305 raise ValueError("semaphore initial value must be >= 0")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000306 _Verbose.__init__(self, verbose)
307 self.__cond = Condition(Lock())
308 self.__value = value
309
310 def acquire(self, blocking=1):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000311 rc = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000312 self.__cond.acquire()
313 while self.__value == 0:
314 if not blocking:
315 break
Skip Montanarob446fc72001-08-19 04:25:24 +0000316 if __debug__:
317 self._note("%s.acquire(%s): blocked waiting, value=%s",
318 self, blocking, self.__value)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000319 self.__cond.wait()
320 else:
321 self.__value = self.__value - 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000322 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000323 self._note("%s.acquire: success, value=%s",
324 self, self.__value)
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000325 rc = True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000326 self.__cond.release()
327 return rc
328
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000329 __enter__ = acquire
330
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000331 def release(self):
332 self.__cond.acquire()
333 self.__value = self.__value + 1
Skip Montanarob446fc72001-08-19 04:25:24 +0000334 if __debug__:
Skip Montanaroae8454a2001-08-19 05:53:47 +0000335 self._note("%s.release: success, value=%s",
336 self, self.__value)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000337 self.__cond.notify()
338 self.__cond.release()
339
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000340 def __exit__(self, t, v, tb):
341 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000342
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000343
Skip Montanaroe428bb72001-08-20 20:27:58 +0000344def BoundedSemaphore(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000345 return _BoundedSemaphore(*args, **kwargs)
Skip Montanaroe428bb72001-08-20 20:27:58 +0000346
347class _BoundedSemaphore(_Semaphore):
348 """Semaphore that checks that # releases is <= # acquires"""
349 def __init__(self, value=1, verbose=None):
350 _Semaphore.__init__(self, value, verbose)
351 self._initial_value = value
352
353 def release(self):
354 if self._Semaphore__value >= self._initial_value:
355 raise ValueError, "Semaphore released too many times"
356 return _Semaphore.release(self)
357
358
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000359def Event(*args, **kwargs):
Guido van Rossum68468eb2003-02-27 20:14:51 +0000360 return _Event(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000361
362class _Event(_Verbose):
363
364 # After Tim Peters' event class (without is_posted())
365
366 def __init__(self, verbose=None):
367 _Verbose.__init__(self, verbose)
368 self.__cond = Condition(Lock())
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000369 self.__flag = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000370
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000371 def is_set(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000372 return self.__flag
373
Benjamin Petersonf4395602008-06-11 17:50:00 +0000374 isSet = _old_api(is_set, "isSet")
375
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000376 def set(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000377 self.__cond.acquire()
378 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000379 self.__flag = True
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000380 self.__cond.notify_all()
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000381 finally:
382 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000383
384 def clear(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000385 self.__cond.acquire()
386 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000387 self.__flag = False
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000388 finally:
389 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000390
391 def wait(self, timeout=None):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000392 self.__cond.acquire()
393 try:
Guido van Rossum21b60142002-11-21 21:08:39 +0000394 if not self.__flag:
395 self.__cond.wait(timeout)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000396 finally:
397 self.__cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000398
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000399# Helper to generate new thread names
400_counter = 0
401def _newname(template="Thread-%d"):
402 global _counter
403 _counter = _counter + 1
404 return template % _counter
405
406# Active thread administration
407_active_limbo_lock = _allocate_lock()
Tim Peters711906e2005-01-08 07:30:42 +0000408_active = {} # maps thread id to Thread object
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000409_limbo = {}
410
411
412# Main class for threads
413
414class Thread(_Verbose):
415
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000416 __initialized = False
Brett Cannoncc4e9352004-07-03 03:52:35 +0000417 # Need to store a reference to sys.exc_info for printing
418 # out exceptions when a thread tries to use a global var. during interp.
419 # shutdown and thus raises an exception about trying to perform some
420 # operation on/with a NoneType
421 __exc_info = _sys.exc_info
Jeffrey Yasskin8b9091f2008-03-28 04:11:18 +0000422 # Keep sys.exc_clear too to clear the exception just before
423 # allowing .join() to return.
424 __exc_clear = _sys.exc_clear
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000425
426 def __init__(self, group=None, target=None, name=None,
Georg Brandla4a8b822005-07-15 09:13:21 +0000427 args=(), kwargs=None, verbose=None):
Guido van Rossum5a43e1a1998-06-09 19:04:26 +0000428 assert group is None, "group argument must be None for now"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000429 _Verbose.__init__(self, verbose)
Georg Brandla4a8b822005-07-15 09:13:21 +0000430 if kwargs is None:
431 kwargs = {}
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000432 self.__target = target
433 self.__name = str(name or _newname())
434 self.__args = args
435 self.__kwargs = kwargs
436 self.__daemonic = self._set_daemon()
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000437 self.__ident = None
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000438 self.__started = Event()
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000439 self.__stopped = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000440 self.__block = Condition(Lock())
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000441 self.__initialized = True
Brett Cannoncc4e9352004-07-03 03:52:35 +0000442 # sys.stderr is not stored in the class like
443 # sys.exc_info since it can be changed between instances
444 self.__stderr = _sys.stderr
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000445
446 def _set_daemon(self):
447 # Overridden in _MainThread and _DummyThread
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000448 return current_thread().is_daemon()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000449
450 def __repr__(self):
451 assert self.__initialized, "Thread.__init__() was not called"
452 status = "initial"
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000453 if self.__started.is_set():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000454 status = "started"
455 if self.__stopped:
456 status = "stopped"
457 if self.__daemonic:
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000458 status += " daemon"
459 if self.__ident is not None:
460 status += " %s" % self.__ident
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000461 return "<%s(%s, %s)>" % (self.__class__.__name__, self.__name, status)
462
463 def start(self):
Collin Winter50b79ce2007-06-06 00:17:35 +0000464 if not self.__initialized:
465 raise RuntimeError("thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000466 if self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000467 raise RuntimeError("thread already started")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000468 if __debug__:
469 self._note("%s.start(): starting thread", self)
470 _active_limbo_lock.acquire()
471 _limbo[self] = self
472 _active_limbo_lock.release()
473 _start_new_thread(self.__bootstrap, ())
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000474 self.__started.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000475
476 def run(self):
Jeffrey Yasskina885c152008-02-23 20:40:35 +0000477 try:
478 if self.__target:
479 self.__target(*self.__args, **self.__kwargs)
480 finally:
481 # Avoid a refcycle if the thread is running a function with
482 # an argument that has a member that points to the thread.
483 del self.__target, self.__args, self.__kwargs
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000484
485 def __bootstrap(self):
Guido van Rossum54ec61e2007-08-20 15:18:04 +0000486 # Wrapper around the real bootstrap code that ignores
487 # exceptions during interpreter cleanup. Those typically
488 # happen when a daemon thread wakes up at an unfortunate
489 # moment, finds the world around it destroyed, and raises some
490 # random exception *** while trying to report the exception in
491 # __bootstrap_inner() below ***. Those random exceptions
492 # don't help anybody, and they confuse users, so we suppress
493 # them. We suppress them only when it appears that the world
494 # indeed has already been destroyed, so that exceptions in
495 # __bootstrap_inner() during normal business hours are properly
496 # reported. Also, we only suppress them for daemonic threads;
497 # if a non-daemonic encounters this, something else is wrong.
498 try:
499 self.__bootstrap_inner()
500 except:
501 if self.__daemonic and _sys is None:
502 return
503 raise
504
505 def __bootstrap_inner(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000506 try:
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000507 self.__ident = _get_ident()
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000508 self.__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000509 _active_limbo_lock.acquire()
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000510 _active[self.__ident] = self
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000511 del _limbo[self]
512 _active_limbo_lock.release()
513 if __debug__:
514 self._note("%s.__bootstrap(): thread started", self)
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000515
516 if _trace_hook:
517 self._note("%s.__bootstrap(): registering trace hook", self)
518 _sys.settrace(_trace_hook)
519 if _profile_hook:
520 self._note("%s.__bootstrap(): registering profile hook", self)
521 _sys.setprofile(_profile_hook)
Tim Petersd1b108b2003-06-29 17:24:17 +0000522
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000523 try:
524 self.run()
525 except SystemExit:
526 if __debug__:
527 self._note("%s.__bootstrap(): raised SystemExit", self)
528 except:
529 if __debug__:
530 self._note("%s.__bootstrap(): unhandled exception", self)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000531 # If sys.stderr is no more (most likely from interpreter
532 # shutdown) use self.__stderr. Otherwise still use sys (as in
533 # _sys) in case sys.stderr was redefined since the creation of
534 # self.
535 if _sys:
536 _sys.stderr.write("Exception in thread %s:\n%s\n" %
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000537 (self.get_name(), _format_exc()))
Brett Cannoncc4e9352004-07-03 03:52:35 +0000538 else:
539 # Do the best job possible w/o a huge amt. of code to
540 # approximate a traceback (code ideas from
541 # Lib/traceback.py)
542 exc_type, exc_value, exc_tb = self.__exc_info()
543 try:
544 print>>self.__stderr, (
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000545 "Exception in thread " + self.get_name() +
Brett Cannoncc4e9352004-07-03 03:52:35 +0000546 " (most likely raised during interpreter shutdown):")
547 print>>self.__stderr, (
548 "Traceback (most recent call last):")
549 while exc_tb:
550 print>>self.__stderr, (
551 ' File "%s", line %s, in %s' %
552 (exc_tb.tb_frame.f_code.co_filename,
553 exc_tb.tb_lineno,
554 exc_tb.tb_frame.f_code.co_name))
555 exc_tb = exc_tb.tb_next
556 print>>self.__stderr, ("%s: %s" % (exc_type, exc_value))
557 # Make sure that exc_tb gets deleted since it is a memory
558 # hog; deleting everything else is just for thoroughness
559 finally:
560 del exc_type, exc_value, exc_tb
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000561 else:
562 if __debug__:
563 self._note("%s.__bootstrap(): normal return", self)
Jeffrey Yasskin8b9091f2008-03-28 04:11:18 +0000564 finally:
565 # Prevent a race in
566 # test_threading.test_no_refcycle_through_target when
567 # the exception keeps the target alive past when we
568 # assert that it's dead.
Amaury Forgeot d'Arc504a48f2008-03-29 01:41:08 +0000569 self.__exc_clear()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000570 finally:
Gregory P. Smith95cd5c02008-01-22 01:20:42 +0000571 with _active_limbo_lock:
572 self.__stop()
573 try:
574 # We don't call self.__delete() because it also
575 # grabs _active_limbo_lock.
576 del _active[_get_ident()]
577 except:
578 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000579
580 def __stop(self):
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000581 self.__block.acquire()
582 self.__stopped = True
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000583 self.__block.notify_all()
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000584 self.__block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000585
586 def __delete(self):
Tim Peters21429932004-07-21 03:36:52 +0000587 "Remove current thread from the dict of currently running threads."
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000588
Tim Peters21429932004-07-21 03:36:52 +0000589 # Notes about running with dummy_thread:
590 #
591 # Must take care to not raise an exception if dummy_thread is being
592 # used (and thus this module is being used as an instance of
593 # dummy_threading). dummy_thread.get_ident() always returns -1 since
594 # there is only one thread if dummy_thread is being used. Thus
595 # len(_active) is always <= 1 here, and any Thread instance created
596 # overwrites the (if any) thread currently registered in _active.
597 #
598 # An instance of _MainThread is always created by 'threading'. This
599 # gets overwritten the instant an instance of Thread is created; both
600 # threads return -1 from dummy_thread.get_ident() and thus have the
601 # same key in the dict. So when the _MainThread instance created by
602 # 'threading' tries to clean itself up when atexit calls this method
603 # it gets a KeyError if another Thread instance was created.
604 #
605 # This all means that KeyError from trying to delete something from
606 # _active if dummy_threading is being used is a red herring. But
607 # since it isn't if dummy_threading is *not* being used then don't
608 # hide the exception.
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000609
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000610 try:
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000611 with _active_limbo_lock:
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000612 del _active[_get_ident()]
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000613 # There must not be any python code between the previous line
614 # and after the lock is released. Otherwise a tracing function
615 # could try to acquire the lock again in the same thread, (in
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000616 # current_thread()), and would block.
Amaury Forgeot d'Arcd7a26512008-04-03 23:07:55 +0000617 except KeyError:
618 if 'dummy_threading' not in _sys.modules:
619 raise
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000620
621 def join(self, timeout=None):
Collin Winter50b79ce2007-06-06 00:17:35 +0000622 if not self.__initialized:
623 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000624 if not self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000625 raise RuntimeError("cannot join thread before it is started")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000626 if self is current_thread():
Collin Winter50b79ce2007-06-06 00:17:35 +0000627 raise RuntimeError("cannot join current thread")
628
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000629 if __debug__:
630 if not self.__stopped:
631 self._note("%s.join(): waiting until thread stops", self)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000632 self.__block.acquire()
633 try:
Brett Cannonad07ff22005-11-23 02:15:50 +0000634 if timeout is None:
635 while not self.__stopped:
636 self.__block.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000637 if __debug__:
638 self._note("%s.join(): thread stopped", self)
Brett Cannonad07ff22005-11-23 02:15:50 +0000639 else:
640 deadline = _time() + timeout
641 while not self.__stopped:
642 delay = deadline - _time()
643 if delay <= 0:
644 if __debug__:
645 self._note("%s.join(): timed out", self)
646 break
647 self.__block.wait(delay)
648 else:
649 if __debug__:
650 self._note("%s.join(): thread stopped", self)
Raymond Hettinger70ec29d2008-01-24 18:12:23 +0000651 finally:
652 self.__block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000653
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000654 def get_name(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000655 assert self.__initialized, "Thread.__init__() not called"
656 return self.__name
657
Benjamin Petersonf4395602008-06-11 17:50:00 +0000658 getName = _old_api(get_name, "getName")
659
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000660 def set_name(self, name):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000661 assert self.__initialized, "Thread.__init__() not called"
662 self.__name = str(name)
663
Benjamin Petersonf4395602008-06-11 17:50:00 +0000664 setName = _old_api(set_name, "setName")
665
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000666 def get_ident(self):
Gregory P. Smith8856dda2008-06-01 23:48:47 +0000667 assert self.__initialized, "Thread.__init__() not called"
668 return self.__ident
669
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000670 def is_alive(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000671 assert self.__initialized, "Thread.__init__() not called"
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000672 return self.__started.is_set() and not self.__stopped
Tim Petersb90f89a2001-01-15 03:26:36 +0000673
Benjamin Petersonf4395602008-06-11 17:50:00 +0000674 isAlive = _old_api(is_alive, "isAlive")
675
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000676 def is_daemon(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000677 assert self.__initialized, "Thread.__init__() not called"
678 return self.__daemonic
679
Benjamin Petersonf4395602008-06-11 17:50:00 +0000680 isDaemon = _old_api(is_daemon, "isDaemon")
681
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000682 def set_daemon(self, daemonic):
Collin Winter50b79ce2007-06-06 00:17:35 +0000683 if not self.__initialized:
684 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000685 if self.__started.is_set():
Collin Winter50b79ce2007-06-06 00:17:35 +0000686 raise RuntimeError("cannot set daemon status of active thread");
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000687 self.__daemonic = daemonic
688
Benjamin Petersonf4395602008-06-11 17:50:00 +0000689 setDaemon = _old_api(set_daemon, "setDaemon")
690
Martin v. Löwis44f86962001-09-05 13:44:54 +0000691# The timer class was contributed by Itamar Shtull-Trauring
692
693def Timer(*args, **kwargs):
694 return _Timer(*args, **kwargs)
695
696class _Timer(Thread):
697 """Call a function after a specified number of seconds:
Tim Petersb64bec32001-09-18 02:26:39 +0000698
Martin v. Löwis44f86962001-09-05 13:44:54 +0000699 t = Timer(30.0, f, args=[], kwargs={})
700 t.start()
701 t.cancel() # stop the timer's action if it's still waiting
702 """
Tim Petersb64bec32001-09-18 02:26:39 +0000703
Martin v. Löwis44f86962001-09-05 13:44:54 +0000704 def __init__(self, interval, function, args=[], kwargs={}):
705 Thread.__init__(self)
706 self.interval = interval
707 self.function = function
708 self.args = args
709 self.kwargs = kwargs
710 self.finished = Event()
Tim Petersb64bec32001-09-18 02:26:39 +0000711
Martin v. Löwis44f86962001-09-05 13:44:54 +0000712 def cancel(self):
713 """Stop the timer if it hasn't finished yet"""
714 self.finished.set()
Tim Petersb64bec32001-09-18 02:26:39 +0000715
Martin v. Löwis44f86962001-09-05 13:44:54 +0000716 def run(self):
717 self.finished.wait(self.interval)
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000718 if not self.finished.is_set():
Martin v. Löwis44f86962001-09-05 13:44:54 +0000719 self.function(*self.args, **self.kwargs)
720 self.finished.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000721
722# Special thread class to represent the main thread
723# This is garbage collected through an exit handler
724
725class _MainThread(Thread):
726
727 def __init__(self):
728 Thread.__init__(self, name="MainThread")
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000729 self._Thread__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000730 _active_limbo_lock.acquire()
731 _active[_get_ident()] = self
732 _active_limbo_lock.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000733
734 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000735 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000736
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000737 def _exitfunc(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000738 self._Thread__stop()
739 t = _pickSomeNonDaemonThread()
740 if t:
741 if __debug__:
742 self._note("%s: waiting for other threads", self)
743 while t:
744 t.join()
745 t = _pickSomeNonDaemonThread()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000746 if __debug__:
747 self._note("%s: exiting", self)
748 self._Thread__delete()
749
750def _pickSomeNonDaemonThread():
751 for t in enumerate():
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000752 if not t.is_daemon() and t.is_alive():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000753 return t
754 return None
755
756
757# Dummy thread class to represent threads not started here.
Tim Peters711906e2005-01-08 07:30:42 +0000758# These aren't garbage collected when they die, nor can they be waited for.
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000759# If they invoke anything in threading.py that calls current_thread(), they
Tim Peters711906e2005-01-08 07:30:42 +0000760# leave an entry in the _active dict forever after.
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000761# Their purpose is to return *something* from current_thread().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000762# They are marked as daemon threads so we won't wait for them
763# when we exit (conform previous semantics).
764
765class _DummyThread(Thread):
Tim Petersb90f89a2001-01-15 03:26:36 +0000766
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000767 def __init__(self):
768 Thread.__init__(self, name=_newname("Dummy-%d"))
Tim Peters711906e2005-01-08 07:30:42 +0000769
770 # Thread.__block consumes an OS-level locking primitive, which
771 # can never be used by a _DummyThread. Since a _DummyThread
772 # instance is immortal, that's bad, so release this resource.
Brett Cannone6539c42005-01-08 02:43:53 +0000773 del self._Thread__block
Tim Peters711906e2005-01-08 07:30:42 +0000774
Jeffrey Yasskin69e13092008-02-28 06:09:19 +0000775 self._Thread__started.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000776 _active_limbo_lock.acquire()
777 _active[_get_ident()] = self
778 _active_limbo_lock.release()
779
780 def _set_daemon(self):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000781 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000782
Neal Norwitz45bec8c2002-02-19 03:01:36 +0000783 def join(self, timeout=None):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000784 assert False, "cannot join a dummy thread"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000785
786
787# Global API functions
788
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000789def current_thread():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000790 try:
791 return _active[_get_ident()]
792 except KeyError:
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000793 ##print "current_thread(): no current thread for", _get_ident()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000794 return _DummyThread()
795
Benjamin Petersonf4395602008-06-11 17:50:00 +0000796currentThread = _old_api(current_thread, "currentThread")
797
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000798def active_count():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000799 _active_limbo_lock.acquire()
800 count = len(_active) + len(_limbo)
801 _active_limbo_lock.release()
802 return count
803
Benjamin Petersonf4395602008-06-11 17:50:00 +0000804activeCount = _old_api(active_count, "activeCount")
805
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000806def enumerate():
807 _active_limbo_lock.acquire()
808 active = _active.values() + _limbo.values()
809 _active_limbo_lock.release()
810 return active
811
Andrew MacIntyre92913322006-06-13 15:04:24 +0000812from thread import stack_size
813
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000814# Create the main thread object,
815# and make it available for the interpreter
816# (Py_Main) as threading._shutdown.
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000817
Martin v. Löwis7b7c9d42007-01-04 21:06:12 +0000818_shutdown = _MainThread()._exitfunc
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000819
Jim Fultond15dc062004-07-14 19:11:50 +0000820# get thread-local implementation, either from the thread
821# module, or from the python fallback
822
823try:
824 from thread import _local as local
825except ImportError:
826 from _threading_local import local
827
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000828
Jesse Noller5e62ca42008-07-16 20:03:47 +0000829def _after_fork():
830 # This function is called by Python/ceval.c:PyEval_ReInitThreads which
831 # is called from PyOS_AfterFork. Here we cleanup threading module state
832 # that should not exist after a fork.
833
834 # Reset _active_limbo_lock, in case we forked while the lock was held
835 # by another (non-forked) thread. http://bugs.python.org/issue874900
836 global _active_limbo_lock
837 _active_limbo_lock = _allocate_lock()
838
839 # fork() only copied the current thread; clear references to others.
840 new_active = {}
841 current = current_thread()
842 with _active_limbo_lock:
843 for ident, thread in _active.iteritems():
844 if thread is current:
845 # There is only one active thread.
846 new_active[ident] = thread
847 else:
848 # All the others are already stopped.
849 # We don't call _Thread__stop() because it tries to acquire
850 # thread._Thread__block which could also have been held while
851 # we forked.
852 thread._Thread__stopped = True
853
854 _limbo.clear()
855 _active.clear()
856 _active.update(new_active)
857 assert len(_active) == 1
858
859
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000860# Self-test code
861
862def _test():
863
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000864 class BoundedQueue(_Verbose):
865
866 def __init__(self, limit):
867 _Verbose.__init__(self)
868 self.mon = RLock()
869 self.rc = Condition(self.mon)
870 self.wc = Condition(self.mon)
871 self.limit = limit
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000872 self.queue = deque()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000873
874 def put(self, item):
875 self.mon.acquire()
876 while len(self.queue) >= self.limit:
877 self._note("put(%s): queue full", item)
878 self.wc.wait()
879 self.queue.append(item)
880 self._note("put(%s): appended, length now %d",
881 item, len(self.queue))
882 self.rc.notify()
883 self.mon.release()
884
885 def get(self):
886 self.mon.acquire()
887 while not self.queue:
888 self._note("get(): queue empty")
889 self.rc.wait()
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000890 item = self.queue.popleft()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000891 self._note("get(): got %s, %d left", item, len(self.queue))
892 self.wc.notify()
893 self.mon.release()
894 return item
895
896 class ProducerThread(Thread):
897
898 def __init__(self, queue, quota):
899 Thread.__init__(self, name="Producer")
900 self.queue = queue
901 self.quota = quota
902
903 def run(self):
Guido van Rossumb26a1b41998-05-20 17:05:52 +0000904 from random import random
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000905 counter = 0
906 while counter < self.quota:
907 counter = counter + 1
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000908 self.queue.put("%s.%d" % (self.get_name(), counter))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000909 _sleep(random() * 0.00001)
910
911
912 class ConsumerThread(Thread):
913
914 def __init__(self, queue, count):
915 Thread.__init__(self, name="Consumer")
916 self.queue = queue
917 self.count = count
918
919 def run(self):
920 while self.count > 0:
921 item = self.queue.get()
922 print item
923 self.count = self.count - 1
924
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000925 NP = 3
926 QL = 4
927 NI = 5
928
929 Q = BoundedQueue(QL)
930 P = []
931 for i in range(NP):
932 t = ProducerThread(Q, NI)
933 t.setName("Producer-%d" % (i+1))
934 P.append(t)
935 C = ConsumerThread(Q, NI*NP)
936 for t in P:
937 t.start()
938 _sleep(0.000001)
939 C.start()
940 for t in P:
941 t.join()
942 C.join()
943
944if __name__ == '__main__':
945 _test()