blob: d49be0be55375c0e6b6dc3b19ac35d6a273b3769 [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
Fred Drakea8725952002-12-30 23:32:50 +00005
Victor Stinnerec895392012-04-29 02:41:27 +02006from time import sleep as _sleep
7try:
8 from time import monotonic as _time
Brett Cannoncd171c82013-07-04 17:43:24 -04009except ImportError:
Victor Stinnerec895392012-04-29 02:41:27 +020010 from time import time as _time
Neil Schemenauerf607fc52003-11-05 23:03:00 +000011from traceback import format_exc as _format_exc
Antoine Pitrouc081c0c2011-07-15 22:12:24 +020012from _weakrefset import WeakSet
Raymond Hettinger30307282013-03-20 19:28:19 -070013from itertools import islice as _islice
Raymond Hettingerec4b1742013-03-10 17:57:28 -070014try:
Raymond Hettingerec4b1742013-03-10 17:57:28 -070015 from _collections import deque as _deque
Brett Cannoncd171c82013-07-04 17:43:24 -040016except ImportError:
Raymond Hettingerec4b1742013-03-10 17:57:28 -070017 from collections import deque as _deque
Guido van Rossum7f5013a1998-04-09 22:01:42 +000018
Benjamin Petersonb3085c92008-09-01 23:09:31 +000019# Note regarding PEP 8 compliant names
20# This threading model was originally inspired by Java, and inherited
21# the convention of camelCase function and method names from that
Ezio Melotti30b9d5d2013-08-17 15:50:46 +030022# language. Those original names are not in any imminent danger of
Benjamin Petersonb3085c92008-09-01 23:09:31 +000023# being deprecated (even for Py3k),so this module provides them as an
24# alias for the PEP 8 compliant names
25# Note that using the new PEP 8 compliant names facilitates substitution
26# with the multiprocessing module, which doesn't provide the old
27# Java inspired names.
28
Benjamin Peterson672b8032008-06-11 19:14:14 +000029__all__ = ['active_count', 'Condition', 'current_thread', 'enumerate', 'Event',
Raymond Hettinger5cee47f2011-01-11 19:59:46 +000030 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread', 'Barrier',
Benjamin Peterson7761b952011-08-02 13:05:47 -050031 'Timer', 'ThreadError', 'setprofile', 'settrace', 'local', 'stack_size']
Guido van Rossum7f5013a1998-04-09 22:01:42 +000032
Raymond Hettinger5cee47f2011-01-11 19:59:46 +000033# Rename some stuff so "from threading import *" is safe
Georg Brandl2067bfd2008-05-25 13:05:15 +000034_start_new_thread = _thread.start_new_thread
35_allocate_lock = _thread.allocate_lock
Antoine Pitrou7b476992013-09-07 23:38:37 +020036_set_sentinel = _thread._set_sentinel
Victor Stinner2a129742011-05-30 23:02:52 +020037get_ident = _thread.get_ident
Georg Brandl2067bfd2008-05-25 13:05:15 +000038ThreadError = _thread.error
Antoine Pitrou434736a2009-11-10 18:46:01 +000039try:
40 _CRLock = _thread.RLock
41except AttributeError:
42 _CRLock = None
Antoine Pitrou7c3e5772010-04-14 15:44:10 +000043TIMEOUT_MAX = _thread.TIMEOUT_MAX
Georg Brandl2067bfd2008-05-25 13:05:15 +000044del _thread
Guido van Rossum7f5013a1998-04-09 22:01:42 +000045
Guido van Rossum7f5013a1998-04-09 22:01:42 +000046
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000047# Support for profile and trace hooks
48
49_profile_hook = None
50_trace_hook = None
51
52def setprofile(func):
53 global _profile_hook
54 _profile_hook = func
Tim Petersd1b108b2003-06-29 17:24:17 +000055
Jeremy Hyltonbfccb352003-06-29 16:58:41 +000056def settrace(func):
57 global _trace_hook
58 _trace_hook = func
Guido van Rossum7f5013a1998-04-09 22:01:42 +000059
60# Synchronization classes
61
62Lock = _allocate_lock
63
Victor Stinner135b6d82012-03-03 01:32:57 +010064def RLock(*args, **kwargs):
65 if _CRLock is None:
66 return _PyRLock(*args, **kwargs)
Antoine Pitrou434736a2009-11-10 18:46:01 +000067 return _CRLock(*args, **kwargs)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000068
Victor Stinner135b6d82012-03-03 01:32:57 +010069class _RLock:
Tim Petersb90f89a2001-01-15 03:26:36 +000070
Victor Stinner135b6d82012-03-03 01:32:57 +010071 def __init__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +000072 self._block = _allocate_lock()
73 self._owner = None
74 self._count = 0
Guido van Rossum7f5013a1998-04-09 22:01:42 +000075
76 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +000077 owner = self._owner
Antoine Pitroub0872682009-11-09 16:08:16 +000078 try:
79 owner = _active[owner].name
80 except KeyError:
81 pass
82 return "<%s owner=%r count=%d>" % (
83 self.__class__.__name__, owner, self._count)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000084
Antoine Pitrou7c3e5772010-04-14 15:44:10 +000085 def acquire(self, blocking=True, timeout=-1):
Victor Stinner2a129742011-05-30 23:02:52 +020086 me = get_ident()
Antoine Pitroub0872682009-11-09 16:08:16 +000087 if self._owner == me:
Raymond Hettinger720da572013-03-10 15:13:35 -070088 self._count += 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +000089 return 1
Antoine Pitrou7c3e5772010-04-14 15:44:10 +000090 rc = self._block.acquire(blocking, timeout)
Guido van Rossum7f5013a1998-04-09 22:01:42 +000091 if rc:
Guido van Rossumd0648992007-08-20 19:25:41 +000092 self._owner = me
93 self._count = 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +000094 return rc
95
Guido van Rossum1a5e21e2006-02-28 21:57:43 +000096 __enter__ = acquire
97
Guido van Rossum7f5013a1998-04-09 22:01:42 +000098 def release(self):
Victor Stinner2a129742011-05-30 23:02:52 +020099 if self._owner != get_ident():
Georg Brandl495f7b52009-10-27 15:28:25 +0000100 raise RuntimeError("cannot release un-acquired lock")
Guido van Rossumd0648992007-08-20 19:25:41 +0000101 self._count = count = self._count - 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000102 if not count:
Guido van Rossumd0648992007-08-20 19:25:41 +0000103 self._owner = None
104 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000105
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000106 def __exit__(self, t, v, tb):
107 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000108
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000109 # Internal methods used by condition variables
110
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000111 def _acquire_restore(self, state):
Guido van Rossumd0648992007-08-20 19:25:41 +0000112 self._block.acquire()
113 self._count, self._owner = state
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000114
115 def _release_save(self):
Victor Stinnerc2824d42011-04-24 23:41:33 +0200116 if self._count == 0:
117 raise RuntimeError("cannot release un-acquired lock")
Guido van Rossumd0648992007-08-20 19:25:41 +0000118 count = self._count
119 self._count = 0
120 owner = self._owner
121 self._owner = None
122 self._block.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000123 return (count, owner)
124
125 def _is_owned(self):
Victor Stinner2a129742011-05-30 23:02:52 +0200126 return self._owner == get_ident()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000127
Antoine Pitrou434736a2009-11-10 18:46:01 +0000128_PyRLock = _RLock
129
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000130
Victor Stinner135b6d82012-03-03 01:32:57 +0100131class Condition:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000132
Victor Stinner135b6d82012-03-03 01:32:57 +0100133 def __init__(self, lock=None):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000134 if lock is None:
135 lock = RLock()
Guido van Rossumd0648992007-08-20 19:25:41 +0000136 self._lock = lock
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000137 # Export the lock's acquire() and release() methods
138 self.acquire = lock.acquire
139 self.release = lock.release
140 # If the lock defines _release_save() and/or _acquire_restore(),
141 # these override the default implementations (which just call
142 # release() and acquire() on the lock). Ditto for _is_owned().
143 try:
144 self._release_save = lock._release_save
145 except AttributeError:
146 pass
147 try:
148 self._acquire_restore = lock._acquire_restore
149 except AttributeError:
150 pass
151 try:
152 self._is_owned = lock._is_owned
153 except AttributeError:
154 pass
Raymond Hettingerec4b1742013-03-10 17:57:28 -0700155 self._waiters = _deque()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000156
Thomas Wouters477c8d52006-05-27 19:21:47 +0000157 def __enter__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000158 return self._lock.__enter__()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000159
Thomas Wouters477c8d52006-05-27 19:21:47 +0000160 def __exit__(self, *args):
Guido van Rossumd0648992007-08-20 19:25:41 +0000161 return self._lock.__exit__(*args)
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000162
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000163 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000164 return "<Condition(%s, %d)>" % (self._lock, len(self._waiters))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000165
166 def _release_save(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000167 self._lock.release() # No state to save
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000168
169 def _acquire_restore(self, x):
Guido van Rossumd0648992007-08-20 19:25:41 +0000170 self._lock.acquire() # Ignore saved state
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000171
172 def _is_owned(self):
Benjamin Peterson672b8032008-06-11 19:14:14 +0000173 # Return True if lock is owned by current_thread.
Jeremy Hyltonaf7fde72002-08-14 17:43:59 +0000174 # This method is called only if __lock doesn't have _is_owned().
Guido van Rossumd0648992007-08-20 19:25:41 +0000175 if self._lock.acquire(0):
176 self._lock.release()
Tim Petersbc0e9102002-04-04 22:55:58 +0000177 return False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000178 else:
Tim Petersbc0e9102002-04-04 22:55:58 +0000179 return True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000180
181 def wait(self, timeout=None):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000182 if not self._is_owned():
Georg Brandl495f7b52009-10-27 15:28:25 +0000183 raise RuntimeError("cannot wait on un-acquired lock")
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000184 waiter = _allocate_lock()
185 waiter.acquire()
Guido van Rossumd0648992007-08-20 19:25:41 +0000186 self._waiters.append(waiter)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000187 saved_state = self._release_save()
Tim Petersc951bf92001-04-02 20:15:57 +0000188 try: # restore state no matter what (e.g., KeyboardInterrupt)
189 if timeout is None:
190 waiter.acquire()
Georg Brandlb9a43912010-10-28 09:03:20 +0000191 gotit = True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000192 else:
Antoine Pitrou7c3e5772010-04-14 15:44:10 +0000193 if timeout > 0:
194 gotit = waiter.acquire(True, timeout)
195 else:
196 gotit = waiter.acquire(False)
Tim Petersc951bf92001-04-02 20:15:57 +0000197 if not gotit:
Tim Petersc951bf92001-04-02 20:15:57 +0000198 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000199 self._waiters.remove(waiter)
Tim Petersc951bf92001-04-02 20:15:57 +0000200 except ValueError:
201 pass
Georg Brandlb9a43912010-10-28 09:03:20 +0000202 return gotit
Tim Petersc951bf92001-04-02 20:15:57 +0000203 finally:
204 self._acquire_restore(saved_state)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000205
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000206 def wait_for(self, predicate, timeout=None):
207 endtime = None
208 waittime = timeout
209 result = predicate()
210 while not result:
211 if waittime is not None:
212 if endtime is None:
213 endtime = _time() + waittime
214 else:
215 waittime = endtime - _time()
216 if waittime <= 0:
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000217 break
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000218 self.wait(waittime)
219 result = predicate()
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000220 return result
221
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000222 def notify(self, n=1):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000223 if not self._is_owned():
Georg Brandl495f7b52009-10-27 15:28:25 +0000224 raise RuntimeError("cannot notify on un-acquired lock")
Raymond Hettingerb65e5792013-03-10 20:34:16 -0700225 all_waiters = self._waiters
226 waiters_to_notify = _deque(_islice(all_waiters, n))
227 if not waiters_to_notify:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000228 return
Raymond Hettingerb65e5792013-03-10 20:34:16 -0700229 for waiter in waiters_to_notify:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000230 waiter.release()
231 try:
Raymond Hettingerb65e5792013-03-10 20:34:16 -0700232 all_waiters.remove(waiter)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000233 except ValueError:
234 pass
235
Benjamin Peterson672b8032008-06-11 19:14:14 +0000236 def notify_all(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000237 self.notify(len(self._waiters))
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000238
Benjamin Petersonb3085c92008-09-01 23:09:31 +0000239 notifyAll = notify_all
240
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000241
Victor Stinner135b6d82012-03-03 01:32:57 +0100242class Semaphore:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000243
Andrew M. Kuchling39d3bfc2000-02-29 00:10:24 +0000244 # After Tim Peters' semaphore class, but not quite the same (no maximum)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000245
Victor Stinner135b6d82012-03-03 01:32:57 +0100246 def __init__(self, value=1):
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000247 if value < 0:
248 raise ValueError("semaphore initial value must be >= 0")
Guido van Rossumd0648992007-08-20 19:25:41 +0000249 self._cond = Condition(Lock())
250 self._value = value
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000251
Antoine Pitrou0454af92010-04-17 23:51:58 +0000252 def acquire(self, blocking=True, timeout=None):
253 if not blocking and timeout is not None:
254 raise ValueError("can't specify timeout for non-blocking acquire")
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000255 rc = False
Antoine Pitrou0454af92010-04-17 23:51:58 +0000256 endtime = None
Serhiy Storchaka81a58552013-04-22 22:51:43 +0300257 with self._cond:
258 while self._value == 0:
259 if not blocking:
260 break
261 if timeout is not None:
262 if endtime is None:
263 endtime = _time() + timeout
264 else:
265 timeout = endtime - _time()
266 if timeout <= 0:
267 break
268 self._cond.wait(timeout)
269 else:
Serhiy Storchakab00b5962013-04-22 22:54:16 +0300270 self._value -= 1
Serhiy Storchaka81a58552013-04-22 22:51:43 +0300271 rc = True
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000272 return rc
273
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000274 __enter__ = acquire
275
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000276 def release(self):
Serhiy Storchaka81a58552013-04-22 22:51:43 +0300277 with self._cond:
Serhiy Storchakab00b5962013-04-22 22:54:16 +0300278 self._value += 1
Serhiy Storchaka81a58552013-04-22 22:51:43 +0300279 self._cond.notify()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000280
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000281 def __exit__(self, t, v, tb):
282 self.release()
Guido van Rossum1a5e21e2006-02-28 21:57:43 +0000283
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000284
Éric Araujo0cdd4452011-07-28 00:28:28 +0200285class BoundedSemaphore(Semaphore):
Skip Montanaroe428bb72001-08-20 20:27:58 +0000286 """Semaphore that checks that # releases is <= # acquires"""
Victor Stinner135b6d82012-03-03 01:32:57 +0100287 def __init__(self, value=1):
288 Semaphore.__init__(self, value)
Skip Montanaroe428bb72001-08-20 20:27:58 +0000289 self._initial_value = value
290
291 def release(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000292 if self._value >= self._initial_value:
Collin Winterce36ad82007-08-30 01:19:48 +0000293 raise ValueError("Semaphore released too many times")
Éric Araujo0cdd4452011-07-28 00:28:28 +0200294 return Semaphore.release(self)
Skip Montanaroe428bb72001-08-20 20:27:58 +0000295
296
Victor Stinner135b6d82012-03-03 01:32:57 +0100297class Event:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000298
299 # After Tim Peters' event class (without is_posted())
300
Victor Stinner135b6d82012-03-03 01:32:57 +0100301 def __init__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000302 self._cond = Condition(Lock())
303 self._flag = False
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000304
Gregory P. Smith9bd4a242011-01-04 18:33:38 +0000305 def _reset_internal_locks(self):
306 # private! called by Thread._reset_internal_locks by _after_fork()
307 self._cond.__init__()
308
Benjamin Peterson672b8032008-06-11 19:14:14 +0000309 def is_set(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000310 return self._flag
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000311
Benjamin Petersonb3085c92008-09-01 23:09:31 +0000312 isSet = is_set
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000313
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000314 def set(self):
Christian Heimes969fe572008-01-25 11:23:10 +0000315 self._cond.acquire()
316 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000317 self._flag = True
Benjamin Peterson672b8032008-06-11 19:14:14 +0000318 self._cond.notify_all()
Christian Heimes969fe572008-01-25 11:23:10 +0000319 finally:
320 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000321
322 def clear(self):
Christian Heimes969fe572008-01-25 11:23:10 +0000323 self._cond.acquire()
324 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000325 self._flag = False
Christian Heimes969fe572008-01-25 11:23:10 +0000326 finally:
327 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000328
329 def wait(self, timeout=None):
Christian Heimes969fe572008-01-25 11:23:10 +0000330 self._cond.acquire()
331 try:
Charles-François Natalided03482012-01-07 18:24:56 +0100332 signaled = self._flag
333 if not signaled:
334 signaled = self._cond.wait(timeout)
335 return signaled
Christian Heimes969fe572008-01-25 11:23:10 +0000336 finally:
337 self._cond.release()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000338
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000339
340# A barrier class. Inspired in part by the pthread_barrier_* api and
341# the CyclicBarrier class from Java. See
342# http://sourceware.org/pthreads-win32/manual/pthread_barrier_init.html and
343# http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/
344# CyclicBarrier.html
345# for information.
346# We maintain two main states, 'filling' and 'draining' enabling the barrier
347# to be cyclic. Threads are not allowed into it until it has fully drained
348# since the previous cycle. In addition, a 'resetting' state exists which is
349# similar to 'draining' except that threads leave with a BrokenBarrierError,
Ezio Melottie130a522011-10-19 10:58:56 +0300350# and a 'broken' state in which all threads get the exception.
Victor Stinner135b6d82012-03-03 01:32:57 +0100351class Barrier:
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000352 """
353 Barrier. Useful for synchronizing a fixed number of threads
354 at known synchronization points. Threads block on 'wait()' and are
355 simultaneously once they have all made that call.
356 """
Victor Stinner135b6d82012-03-03 01:32:57 +0100357 def __init__(self, parties, action=None, timeout=None):
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000358 """
359 Create a barrier, initialised to 'parties' threads.
360 'action' is a callable which, when supplied, will be called
361 by one of the threads after they have all entered the
362 barrier and just prior to releasing them all.
363 If a 'timeout' is provided, it is uses as the default for
364 all subsequent 'wait()' calls.
365 """
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000366 self._cond = Condition(Lock())
367 self._action = action
368 self._timeout = timeout
369 self._parties = parties
370 self._state = 0 #0 filling, 1, draining, -1 resetting, -2 broken
371 self._count = 0
372
373 def wait(self, timeout=None):
374 """
375 Wait for the barrier. When the specified number of threads have
376 started waiting, they are all simultaneously awoken. If an 'action'
377 was provided for the barrier, one of the threads will have executed
378 that callback prior to returning.
379 Returns an individual index number from 0 to 'parties-1'.
380 """
381 if timeout is None:
382 timeout = self._timeout
383 with self._cond:
384 self._enter() # Block while the barrier drains.
385 index = self._count
386 self._count += 1
387 try:
388 if index + 1 == self._parties:
389 # We release the barrier
390 self._release()
391 else:
392 # We wait until someone releases us
393 self._wait(timeout)
394 return index
395 finally:
396 self._count -= 1
397 # Wake up any threads waiting for barrier to drain.
398 self._exit()
399
400 # Block until the barrier is ready for us, or raise an exception
401 # if it is broken.
402 def _enter(self):
403 while self._state in (-1, 1):
404 # It is draining or resetting, wait until done
405 self._cond.wait()
406 #see if the barrier is in a broken state
407 if self._state < 0:
408 raise BrokenBarrierError
409 assert self._state == 0
410
411 # Optionally run the 'action' and release the threads waiting
412 # in the barrier.
413 def _release(self):
414 try:
415 if self._action:
416 self._action()
417 # enter draining state
418 self._state = 1
419 self._cond.notify_all()
420 except:
421 #an exception during the _action handler. Break and reraise
422 self._break()
423 raise
424
425 # Wait in the barrier until we are relased. Raise an exception
426 # if the barrier is reset or broken.
427 def _wait(self, timeout):
Kristján Valur Jónsson63315202010-11-18 12:46:39 +0000428 if not self._cond.wait_for(lambda : self._state != 0, timeout):
429 #timed out. Break the barrier
430 self._break()
431 raise BrokenBarrierError
432 if self._state < 0:
433 raise BrokenBarrierError
Kristján Valur Jónsson3be00032010-10-28 09:43:10 +0000434 assert self._state == 1
435
436 # If we are the last thread to exit the barrier, signal any threads
437 # waiting for the barrier to drain.
438 def _exit(self):
439 if self._count == 0:
440 if self._state in (-1, 1):
441 #resetting or draining
442 self._state = 0
443 self._cond.notify_all()
444
445 def reset(self):
446 """
447 Reset the barrier to the initial state.
448 Any threads currently waiting will get the BrokenBarrier exception
449 raised.
450 """
451 with self._cond:
452 if self._count > 0:
453 if self._state == 0:
454 #reset the barrier, waking up threads
455 self._state = -1
456 elif self._state == -2:
457 #was broken, set it to reset state
458 #which clears when the last thread exits
459 self._state = -1
460 else:
461 self._state = 0
462 self._cond.notify_all()
463
464 def abort(self):
465 """
466 Place the barrier into a 'broken' state.
467 Useful in case of error. Any currently waiting threads and
468 threads attempting to 'wait()' will have BrokenBarrierError
469 raised.
470 """
471 with self._cond:
472 self._break()
473
474 def _break(self):
475 # An internal error was detected. The barrier is set to
476 # a broken state all parties awakened.
477 self._state = -2
478 self._cond.notify_all()
479
480 @property
481 def parties(self):
482 """
483 Return the number of threads required to trip the barrier.
484 """
485 return self._parties
486
487 @property
488 def n_waiting(self):
489 """
490 Return the number of threads that are currently waiting at the barrier.
491 """
492 # We don't need synchronization here since this is an ephemeral result
493 # anyway. It returns the correct value in the steady state.
494 if self._state == 0:
495 return self._count
496 return 0
497
498 @property
499 def broken(self):
500 """
501 Return True if the barrier is in a broken state
502 """
503 return self._state == -2
504
505#exception raised by the Barrier class
506class BrokenBarrierError(RuntimeError): pass
507
508
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000509# Helper to generate new thread names
510_counter = 0
511def _newname(template="Thread-%d"):
512 global _counter
Raymond Hettinger720da572013-03-10 15:13:35 -0700513 _counter += 1
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000514 return template % _counter
515
516# Active thread administration
517_active_limbo_lock = _allocate_lock()
Tim Peters711906e2005-01-08 07:30:42 +0000518_active = {} # maps thread id to Thread object
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000519_limbo = {}
520
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200521# For debug and leak testing
522_dangling = WeakSet()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000523
524# Main class for threads
525
Victor Stinner135b6d82012-03-03 01:32:57 +0100526class Thread:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000527
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000528 __initialized = False
Brett Cannoncc4e9352004-07-03 03:52:35 +0000529 # Need to store a reference to sys.exc_info for printing
530 # out exceptions when a thread tries to use a global var. during interp.
531 # shutdown and thus raises an exception about trying to perform some
532 # operation on/with a NoneType
533 __exc_info = _sys.exc_info
Christian Heimesbbe741d2008-03-28 10:53:29 +0000534 # Keep sys.exc_clear too to clear the exception just before
535 # allowing .join() to return.
536 #XXX __exc_clear = _sys.exc_clear
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000537
538 def __init__(self, group=None, target=None, name=None,
Victor Stinner135b6d82012-03-03 01:32:57 +0100539 args=(), kwargs=None, *, daemon=None):
Guido van Rossum5a43e1a1998-06-09 19:04:26 +0000540 assert group is None, "group argument must be None for now"
Georg Brandla4a8b822005-07-15 09:13:21 +0000541 if kwargs is None:
542 kwargs = {}
Guido van Rossumd0648992007-08-20 19:25:41 +0000543 self._target = target
544 self._name = str(name or _newname())
545 self._args = args
546 self._kwargs = kwargs
Antoine Pitrou0bd4deb2011-02-25 22:07:43 +0000547 if daemon is not None:
548 self._daemonic = daemon
549 else:
550 self._daemonic = current_thread().daemon
Georg Brandl0c77a822008-06-10 16:37:50 +0000551 self._ident = None
Antoine Pitrou7b476992013-09-07 23:38:37 +0200552 self._tstate_lock = None
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000553 self._started = Event()
Antoine Pitrou7b476992013-09-07 23:38:37 +0200554 self._stopped = Event()
Guido van Rossumd0648992007-08-20 19:25:41 +0000555 self._initialized = True
Brett Cannoncc4e9352004-07-03 03:52:35 +0000556 # sys.stderr is not stored in the class like
557 # sys.exc_info since it can be changed between instances
Guido van Rossumd0648992007-08-20 19:25:41 +0000558 self._stderr = _sys.stderr
Antoine Pitrouc081c0c2011-07-15 22:12:24 +0200559 _dangling.add(self)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000560
Antoine Pitrou7b476992013-09-07 23:38:37 +0200561 def _reset_internal_locks(self, is_alive):
Gregory P. Smith9bd4a242011-01-04 18:33:38 +0000562 # private! Called by _after_fork() to reset our internal locks as
563 # they may be in an invalid state leading to a deadlock or crash.
Gregory P. Smith9bd4a242011-01-04 18:33:38 +0000564 self._started._reset_internal_locks()
Antoine Pitrou7b476992013-09-07 23:38:37 +0200565 self._stopped._reset_internal_locks()
566 if is_alive:
567 self._set_tstate_lock()
568 else:
569 # The thread isn't alive after fork: it doesn't have a tstate
570 # anymore.
571 self._tstate_lock = None
Gregory P. Smith9bd4a242011-01-04 18:33:38 +0000572
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000573 def __repr__(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000574 assert self._initialized, "Thread.__init__() was not called"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000575 status = "initial"
Benjamin Peterson672b8032008-06-11 19:14:14 +0000576 if self._started.is_set():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000577 status = "started"
Antoine Pitrou7b476992013-09-07 23:38:37 +0200578 if self._stopped.is_set():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000579 status = "stopped"
Guido van Rossumd0648992007-08-20 19:25:41 +0000580 if self._daemonic:
Georg Brandl0c77a822008-06-10 16:37:50 +0000581 status += " daemon"
582 if self._ident is not None:
583 status += " %s" % self._ident
Guido van Rossumd0648992007-08-20 19:25:41 +0000584 return "<%s(%s, %s)>" % (self.__class__.__name__, self._name, status)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000585
586 def start(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000587 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000588 raise RuntimeError("thread.__init__() not called")
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000589
Benjamin Peterson672b8032008-06-11 19:14:14 +0000590 if self._started.is_set():
Senthil Kumaranfdd4d0f2010-04-06 03:30:18 +0000591 raise RuntimeError("threads can only be started once")
Benjamin Petersond23f8222009-04-05 19:13:16 +0000592 with _active_limbo_lock:
593 _limbo[self] = self
Gregory P. Smith3fdd9642010-02-28 18:57:46 +0000594 try:
595 _start_new_thread(self._bootstrap, ())
596 except Exception:
597 with _active_limbo_lock:
598 del _limbo[self]
599 raise
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000600 self._started.wait()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000601
602 def run(self):
Christian Heimesd3eb5a152008-02-24 00:38:49 +0000603 try:
604 if self._target:
605 self._target(*self._args, **self._kwargs)
606 finally:
607 # Avoid a refcycle if the thread is running a function with
608 # an argument that has a member that points to the thread.
609 del self._target, self._args, self._kwargs
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000610
Guido van Rossumd0648992007-08-20 19:25:41 +0000611 def _bootstrap(self):
Guido van Rossum61e21b52007-08-20 19:06:03 +0000612 # Wrapper around the real bootstrap code that ignores
613 # exceptions during interpreter cleanup. Those typically
614 # happen when a daemon thread wakes up at an unfortunate
615 # moment, finds the world around it destroyed, and raises some
616 # random exception *** while trying to report the exception in
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000617 # _bootstrap_inner() below ***. Those random exceptions
Guido van Rossum61e21b52007-08-20 19:06:03 +0000618 # don't help anybody, and they confuse users, so we suppress
619 # them. We suppress them only when it appears that the world
620 # indeed has already been destroyed, so that exceptions in
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000621 # _bootstrap_inner() during normal business hours are properly
Guido van Rossum61e21b52007-08-20 19:06:03 +0000622 # reported. Also, we only suppress them for daemonic threads;
623 # if a non-daemonic encounters this, something else is wrong.
624 try:
Guido van Rossumd0648992007-08-20 19:25:41 +0000625 self._bootstrap_inner()
Guido van Rossum61e21b52007-08-20 19:06:03 +0000626 except:
Guido van Rossumd0648992007-08-20 19:25:41 +0000627 if self._daemonic and _sys is None:
Guido van Rossum61e21b52007-08-20 19:06:03 +0000628 return
629 raise
630
Benjamin Petersond23f8222009-04-05 19:13:16 +0000631 def _set_ident(self):
Victor Stinner2a129742011-05-30 23:02:52 +0200632 self._ident = get_ident()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000633
Antoine Pitrou7b476992013-09-07 23:38:37 +0200634 def _set_tstate_lock(self):
635 """
636 Set a lock object which will be released by the interpreter when
637 the underlying thread state (see pystate.h) gets deleted.
638 """
639 self._tstate_lock = _set_sentinel()
640 self._tstate_lock.acquire()
641
Guido van Rossumd0648992007-08-20 19:25:41 +0000642 def _bootstrap_inner(self):
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000643 try:
Benjamin Petersond23f8222009-04-05 19:13:16 +0000644 self._set_ident()
Antoine Pitrou7b476992013-09-07 23:38:37 +0200645 self._set_tstate_lock()
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000646 self._started.set()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000647 with _active_limbo_lock:
648 _active[self._ident] = self
649 del _limbo[self]
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000650
651 if _trace_hook:
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000652 _sys.settrace(_trace_hook)
653 if _profile_hook:
Jeremy Hyltonbfccb352003-06-29 16:58:41 +0000654 _sys.setprofile(_profile_hook)
Tim Petersd1b108b2003-06-29 17:24:17 +0000655
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000656 try:
657 self.run()
658 except SystemExit:
Victor Stinner135b6d82012-03-03 01:32:57 +0100659 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000660 except:
Brett Cannoncc4e9352004-07-03 03:52:35 +0000661 # If sys.stderr is no more (most likely from interpreter
Guido van Rossumd0648992007-08-20 19:25:41 +0000662 # shutdown) use self._stderr. Otherwise still use sys (as in
Brett Cannoncc4e9352004-07-03 03:52:35 +0000663 # _sys) in case sys.stderr was redefined since the creation of
664 # self.
665 if _sys:
666 _sys.stderr.write("Exception in thread %s:\n%s\n" %
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000667 (self.name, _format_exc()))
Brett Cannoncc4e9352004-07-03 03:52:35 +0000668 else:
669 # Do the best job possible w/o a huge amt. of code to
670 # approximate a traceback (code ideas from
671 # Lib/traceback.py)
Guido van Rossumd0648992007-08-20 19:25:41 +0000672 exc_type, exc_value, exc_tb = self._exc_info()
Brett Cannoncc4e9352004-07-03 03:52:35 +0000673 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000674 print((
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000675 "Exception in thread " + self.name +
Guido van Rossumd0648992007-08-20 19:25:41 +0000676 " (most likely raised during interpreter shutdown):"), file=self._stderr)
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000677 print((
Guido van Rossumd0648992007-08-20 19:25:41 +0000678 "Traceback (most recent call last):"), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000679 while exc_tb:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000680 print((
Brett Cannoncc4e9352004-07-03 03:52:35 +0000681 ' File "%s", line %s, in %s' %
682 (exc_tb.tb_frame.f_code.co_filename,
683 exc_tb.tb_lineno,
Guido van Rossumd0648992007-08-20 19:25:41 +0000684 exc_tb.tb_frame.f_code.co_name)), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000685 exc_tb = exc_tb.tb_next
Guido van Rossumd0648992007-08-20 19:25:41 +0000686 print(("%s: %s" % (exc_type, exc_value)), file=self._stderr)
Brett Cannoncc4e9352004-07-03 03:52:35 +0000687 # Make sure that exc_tb gets deleted since it is a memory
688 # hog; deleting everything else is just for thoroughness
689 finally:
690 del exc_type, exc_value, exc_tb
Christian Heimesbbe741d2008-03-28 10:53:29 +0000691 finally:
692 # Prevent a race in
693 # test_threading.test_no_refcycle_through_target when
694 # the exception keeps the target alive past when we
695 # assert that it's dead.
696 #XXX self.__exc_clear()
697 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000698 finally:
Christian Heimes1af737c2008-01-23 08:24:23 +0000699 with _active_limbo_lock:
700 self._stop()
701 try:
Georg Brandl0c77a822008-06-10 16:37:50 +0000702 # We don't call self._delete() because it also
Christian Heimes1af737c2008-01-23 08:24:23 +0000703 # grabs _active_limbo_lock.
Victor Stinner2a129742011-05-30 23:02:52 +0200704 del _active[get_ident()]
Christian Heimes1af737c2008-01-23 08:24:23 +0000705 except:
706 pass
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000707
Guido van Rossumd0648992007-08-20 19:25:41 +0000708 def _stop(self):
Antoine Pitrou7b476992013-09-07 23:38:37 +0200709 self._stopped.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000710
Guido van Rossumd0648992007-08-20 19:25:41 +0000711 def _delete(self):
Tim Peters21429932004-07-21 03:36:52 +0000712 "Remove current thread from the dict of currently running threads."
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000713
Georg Brandl2067bfd2008-05-25 13:05:15 +0000714 # Notes about running with _dummy_thread:
Tim Peters21429932004-07-21 03:36:52 +0000715 #
Georg Brandl2067bfd2008-05-25 13:05:15 +0000716 # Must take care to not raise an exception if _dummy_thread is being
Tim Peters21429932004-07-21 03:36:52 +0000717 # used (and thus this module is being used as an instance of
Georg Brandl2067bfd2008-05-25 13:05:15 +0000718 # dummy_threading). _dummy_thread.get_ident() always returns -1 since
719 # there is only one thread if _dummy_thread is being used. Thus
Tim Peters21429932004-07-21 03:36:52 +0000720 # len(_active) is always <= 1 here, and any Thread instance created
721 # overwrites the (if any) thread currently registered in _active.
722 #
723 # An instance of _MainThread is always created by 'threading'. This
724 # gets overwritten the instant an instance of Thread is created; both
Georg Brandl2067bfd2008-05-25 13:05:15 +0000725 # threads return -1 from _dummy_thread.get_ident() and thus have the
Tim Peters21429932004-07-21 03:36:52 +0000726 # same key in the dict. So when the _MainThread instance created by
727 # 'threading' tries to clean itself up when atexit calls this method
728 # it gets a KeyError if another Thread instance was created.
729 #
730 # This all means that KeyError from trying to delete something from
731 # _active if dummy_threading is being used is a red herring. But
732 # since it isn't if dummy_threading is *not* being used then don't
733 # hide the exception.
Brett Cannon8b3d92a2004-07-21 02:21:58 +0000734
Christian Heimes969fe572008-01-25 11:23:10 +0000735 try:
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000736 with _active_limbo_lock:
Victor Stinner2a129742011-05-30 23:02:52 +0200737 del _active[get_ident()]
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000738 # There must not be any python code between the previous line
739 # and after the lock is released. Otherwise a tracing function
740 # could try to acquire the lock again in the same thread, (in
Benjamin Peterson672b8032008-06-11 19:14:14 +0000741 # current_thread()), and would block.
Neal Norwitzf5c7c2e2008-04-05 04:47:45 +0000742 except KeyError:
743 if 'dummy_threading' not in _sys.modules:
744 raise
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000745
746 def join(self, timeout=None):
Guido van Rossumd0648992007-08-20 19:25:41 +0000747 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000748 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000749 if not self._started.is_set():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000750 raise RuntimeError("cannot join thread before it is started")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000751 if self is current_thread():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000752 raise RuntimeError("cannot join current thread")
Antoine Pitrou7b476992013-09-07 23:38:37 +0200753 if not self.is_alive():
754 return
755 self._stopped.wait(timeout)
756 if self._stopped.is_set():
757 self._wait_for_tstate_lock(timeout is None)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000758
Antoine Pitrou7b476992013-09-07 23:38:37 +0200759 def _wait_for_tstate_lock(self, block):
760 # Issue #18808: wait for the thread state to be gone.
761 # When self._stopped is set, the Python part of the thread is done,
762 # but the thread's tstate has not yet been destroyed. The C code
763 # releases self._tstate_lock when the C part of the thread is done
764 # (the code at the end of the thread's life to remove all knowledge
765 # of the thread from the C data structures).
766 # This method waits to acquire _tstate_lock if `block` is True, or
767 # sees whether it can be acquired immediately if `block` is False.
768 # If it does acquire the lock, the C code is done, and _tstate_lock
769 # is set to None.
770 lock = self._tstate_lock
771 if lock is None:
772 return # already determined that the C code is done
773 if lock.acquire(block):
774 lock.release()
775 self._tstate_lock = None
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000776
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000777 @property
778 def name(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000779 assert self._initialized, "Thread.__init__() not called"
780 return self._name
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000781
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000782 @name.setter
783 def name(self, name):
Guido van Rossumd0648992007-08-20 19:25:41 +0000784 assert self._initialized, "Thread.__init__() not called"
785 self._name = str(name)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000786
Benjamin Peterson773c17b2008-08-18 16:45:31 +0000787 @property
788 def ident(self):
Georg Brandl0c77a822008-06-10 16:37:50 +0000789 assert self._initialized, "Thread.__init__() not called"
790 return self._ident
791
Benjamin Peterson672b8032008-06-11 19:14:14 +0000792 def is_alive(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000793 assert self._initialized, "Thread.__init__() not called"
Antoine Pitrou7b476992013-09-07 23:38:37 +0200794 if not self._started.is_set():
795 return False
796 if not self._stopped.is_set():
797 return True
798 # The Python part of the thread is done, but the C part may still be
799 # waiting to run.
800 self._wait_for_tstate_lock(False)
801 return self._tstate_lock is not None
Tim Petersb90f89a2001-01-15 03:26:36 +0000802
Benjamin Petersonb3085c92008-09-01 23:09:31 +0000803 isAlive = is_alive
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000804
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000805 @property
806 def daemon(self):
Guido van Rossumd0648992007-08-20 19:25:41 +0000807 assert self._initialized, "Thread.__init__() not called"
808 return self._daemonic
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000809
Benjamin Petersonfdbea962008-08-18 17:33:47 +0000810 @daemon.setter
811 def daemon(self, daemonic):
Guido van Rossumd0648992007-08-20 19:25:41 +0000812 if not self._initialized:
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000813 raise RuntimeError("Thread.__init__() not called")
Benjamin Peterson672b8032008-06-11 19:14:14 +0000814 if self._started.is_set():
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000815 raise RuntimeError("cannot set daemon status of active thread");
Guido van Rossumd0648992007-08-20 19:25:41 +0000816 self._daemonic = daemonic
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000817
Benjamin Peterson6640d722008-08-18 18:16:46 +0000818 def isDaemon(self):
819 return self.daemon
820
821 def setDaemon(self, daemonic):
822 self.daemon = daemonic
823
824 def getName(self):
825 return self.name
826
827 def setName(self, name):
828 self.name = name
829
Martin v. Löwis44f86962001-09-05 13:44:54 +0000830# The timer class was contributed by Itamar Shtull-Trauring
831
Éric Araujo0cdd4452011-07-28 00:28:28 +0200832class Timer(Thread):
Martin v. Löwis44f86962001-09-05 13:44:54 +0000833 """Call a function after a specified number of seconds:
Tim Petersb64bec32001-09-18 02:26:39 +0000834
R David Murray19aeb432013-03-30 17:19:38 -0400835 t = Timer(30.0, f, args=None, kwargs=None)
Martin v. Löwis44f86962001-09-05 13:44:54 +0000836 t.start()
837 t.cancel() # stop the timer's action if it's still waiting
838 """
Tim Petersb64bec32001-09-18 02:26:39 +0000839
R David Murray19aeb432013-03-30 17:19:38 -0400840 def __init__(self, interval, function, args=None, kwargs=None):
Martin v. Löwis44f86962001-09-05 13:44:54 +0000841 Thread.__init__(self)
842 self.interval = interval
843 self.function = function
R David Murray19aeb432013-03-30 17:19:38 -0400844 self.args = args if args is not None else []
845 self.kwargs = kwargs if kwargs is not None else {}
Martin v. Löwis44f86962001-09-05 13:44:54 +0000846 self.finished = Event()
Tim Petersb64bec32001-09-18 02:26:39 +0000847
Martin v. Löwis44f86962001-09-05 13:44:54 +0000848 def cancel(self):
849 """Stop the timer if it hasn't finished yet"""
850 self.finished.set()
Tim Petersb64bec32001-09-18 02:26:39 +0000851
Martin v. Löwis44f86962001-09-05 13:44:54 +0000852 def run(self):
853 self.finished.wait(self.interval)
Benjamin Peterson672b8032008-06-11 19:14:14 +0000854 if not self.finished.is_set():
Martin v. Löwis44f86962001-09-05 13:44:54 +0000855 self.function(*self.args, **self.kwargs)
856 self.finished.set()
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000857
858# Special thread class to represent the main thread
859# This is garbage collected through an exit handler
860
861class _MainThread(Thread):
862
863 def __init__(self):
Antoine Pitrou0bd4deb2011-02-25 22:07:43 +0000864 Thread.__init__(self, name="MainThread", daemon=False)
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000865 self._started.set()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000866 self._set_ident()
867 with _active_limbo_lock:
868 _active[self._ident] = self
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000869
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000870
871# Dummy thread class to represent threads not started here.
Tim Peters711906e2005-01-08 07:30:42 +0000872# These aren't garbage collected when they die, nor can they be waited for.
Benjamin Peterson672b8032008-06-11 19:14:14 +0000873# If they invoke anything in threading.py that calls current_thread(), they
Tim Peters711906e2005-01-08 07:30:42 +0000874# leave an entry in the _active dict forever after.
Benjamin Peterson672b8032008-06-11 19:14:14 +0000875# Their purpose is to return *something* from current_thread().
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000876# They are marked as daemon threads so we won't wait for them
877# when we exit (conform previous semantics).
878
879class _DummyThread(Thread):
Tim Petersb90f89a2001-01-15 03:26:36 +0000880
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000881 def __init__(self):
Antoine Pitrou0bd4deb2011-02-25 22:07:43 +0000882 Thread.__init__(self, name=_newname("Dummy-%d"), daemon=True)
Tim Peters711906e2005-01-08 07:30:42 +0000883
Christian Heimes9e7f1d22008-02-28 12:27:11 +0000884 self._started.set()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000885 self._set_ident()
886 with _active_limbo_lock:
887 _active[self._ident] = self
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000888
Antoine Pitrou8e6e0fd2012-04-19 23:55:01 +0200889 def _stop(self):
890 pass
891
Neal Norwitz45bec8c2002-02-19 03:01:36 +0000892 def join(self, timeout=None):
Guido van Rossum8ca162f2002-04-07 06:36:23 +0000893 assert False, "cannot join a dummy thread"
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000894
895
896# Global API functions
897
Benjamin Peterson672b8032008-06-11 19:14:14 +0000898def current_thread():
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000899 try:
Victor Stinner2a129742011-05-30 23:02:52 +0200900 return _active[get_ident()]
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000901 except KeyError:
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000902 return _DummyThread()
903
Benjamin Petersonb3085c92008-09-01 23:09:31 +0000904currentThread = current_thread
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000905
Benjamin Peterson672b8032008-06-11 19:14:14 +0000906def active_count():
Benjamin Petersond23f8222009-04-05 19:13:16 +0000907 with _active_limbo_lock:
908 return len(_active) + len(_limbo)
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000909
Benjamin Petersonb3085c92008-09-01 23:09:31 +0000910activeCount = active_count
Benjamin Petersonf0923f52008-08-18 22:10:13 +0000911
Antoine Pitroubdec11f2009-11-05 13:49:14 +0000912def _enumerate():
913 # Same as enumerate(), but without the lock. Internal use only.
914 return list(_active.values()) + list(_limbo.values())
915
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000916def enumerate():
Benjamin Petersond23f8222009-04-05 19:13:16 +0000917 with _active_limbo_lock:
918 return list(_active.values()) + list(_limbo.values())
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000919
Georg Brandl2067bfd2008-05-25 13:05:15 +0000920from _thread import stack_size
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000921
Thomas Wouters902d6eb2007-01-09 23:18:33 +0000922# Create the main thread object,
923# and make it available for the interpreter
924# (Py_Main) as threading._shutdown.
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000925
Andrew Svetlov58b5c5a2013-09-04 07:01:07 +0300926_main_thread = _MainThread()
927
928def _shutdown():
929 _main_thread._stop()
930 t = _pickSomeNonDaemonThread()
931 while t:
932 t.join()
933 t = _pickSomeNonDaemonThread()
934 _main_thread._delete()
935
936def _pickSomeNonDaemonThread():
937 for t in enumerate():
938 if not t.daemon and t.is_alive():
939 return t
940 return None
941
942def main_thread():
Andrew Svetlovb1dd5572013-09-04 10:33:11 +0300943 """Return the main thread object.
944
945 In normal conditions, the main thread is the thread from which the
946 Python interpreter was started.
947 """
Andrew Svetlov58b5c5a2013-09-04 07:01:07 +0300948 return _main_thread
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000949
Jim Fultond15dc062004-07-14 19:11:50 +0000950# get thread-local implementation, either from the thread
951# module, or from the python fallback
952
953try:
Georg Brandl2067bfd2008-05-25 13:05:15 +0000954 from _thread import _local as local
Brett Cannoncd171c82013-07-04 17:43:24 -0400955except ImportError:
Jim Fultond15dc062004-07-14 19:11:50 +0000956 from _threading_local import local
957
Guido van Rossum7f5013a1998-04-09 22:01:42 +0000958
Jesse Nollera8513972008-07-17 16:49:17 +0000959def _after_fork():
960 # This function is called by Python/ceval.c:PyEval_ReInitThreads which
961 # is called from PyOS_AfterFork. Here we cleanup threading module state
962 # that should not exist after a fork.
963
964 # Reset _active_limbo_lock, in case we forked while the lock was held
965 # by another (non-forked) thread. http://bugs.python.org/issue874900
Andrew Svetlov58b5c5a2013-09-04 07:01:07 +0300966 global _active_limbo_lock, _main_thread
Jesse Nollera8513972008-07-17 16:49:17 +0000967 _active_limbo_lock = _allocate_lock()
968
969 # fork() only copied the current thread; clear references to others.
970 new_active = {}
971 current = current_thread()
Andrew Svetlov58b5c5a2013-09-04 07:01:07 +0300972 _main_thread = current
Jesse Nollera8513972008-07-17 16:49:17 +0000973 with _active_limbo_lock:
Charles-François Natali9939cc82013-08-30 23:32:53 +0200974 for thread in _enumerate():
Charles-François Natalib055bf62011-12-18 18:45:16 +0100975 # Any lock/condition variable may be currently locked or in an
976 # invalid state, so we reinitialize them.
Jesse Nollera8513972008-07-17 16:49:17 +0000977 if thread is current:
Antoine Pitrou5fe291f2008-09-06 23:00:03 +0000978 # There is only one active thread. We reset the ident to
979 # its new value since it can have changed.
Antoine Pitrou7b476992013-09-07 23:38:37 +0200980 thread._reset_internal_locks(True)
Victor Stinner2a129742011-05-30 23:02:52 +0200981 ident = get_ident()
Antoine Pitrou5fe291f2008-09-06 23:00:03 +0000982 thread._ident = ident
Jesse Nollera8513972008-07-17 16:49:17 +0000983 new_active[ident] = thread
984 else:
985 # All the others are already stopped.
Antoine Pitrou7b476992013-09-07 23:38:37 +0200986 thread._reset_internal_locks(False)
Charles-François Natalib055bf62011-12-18 18:45:16 +0100987 thread._stop()
Jesse Nollera8513972008-07-17 16:49:17 +0000988
989 _limbo.clear()
990 _active.clear()
991 _active.update(new_active)
992 assert len(_active) == 1