Jeremy Hylton | 92bb6e7 | 2002-08-14 19:25:42 +0000 | [diff] [blame] | 1 | """Thread module emulating a subset of Java's threading model.""" |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 2 | |
Fred Drake | a872595 | 2002-12-30 23:32:50 +0000 | [diff] [blame] | 3 | import sys as _sys |
| 4 | |
| 5 | try: |
| 6 | import thread |
| 7 | except ImportError: |
| 8 | del _sys.modules[__name__] |
| 9 | raise |
| 10 | |
Jeffrey Yasskin | 105f3d4 | 2008-03-31 00:35:53 +0000 | [diff] [blame] | 11 | import warnings |
Benjamin Peterson | f439560 | 2008-06-11 17:50:00 +0000 | [diff] [blame] | 12 | |
| 13 | from functools import wraps |
Fred Drake | a872595 | 2002-12-30 23:32:50 +0000 | [diff] [blame] | 14 | from time import time as _time, sleep as _sleep |
Neil Schemenauer | f607fc5 | 2003-11-05 23:03:00 +0000 | [diff] [blame] | 15 | from traceback import format_exc as _format_exc |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 16 | from collections import deque |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 17 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 18 | # Note regarding PEP 8 compliant aliases |
| 19 | # This threading model was originally inspired by Java, and inherited |
| 20 | # the convention of camelCase function and method names from that |
| 21 | # language. While those names are not in any imminent danger of being |
| 22 | # deprecated, starting with Python 2.6, the module now provides a |
| 23 | # PEP 8 compliant alias for any such method name. |
| 24 | # Using the new PEP 8 compliant names also facilitates substitution |
| 25 | # with the multiprocessing module, which doesn't provide the old |
| 26 | # Java inspired names. |
| 27 | |
| 28 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 29 | # Rename some stuff so "from threading import *" is safe |
Benjamin Peterson | 13f7382 | 2008-06-11 18:02:31 +0000 | [diff] [blame] | 30 | __all__ = ['activeCount', 'active_count', 'Condition', 'currentThread', |
| 31 | 'current_thread', 'enumerate', 'Event', |
Tim Peters | 685e697 | 2003-06-29 16:50:06 +0000 | [diff] [blame] | 32 | 'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread', |
Andrew MacIntyre | 9291332 | 2006-06-13 15:04:24 +0000 | [diff] [blame] | 33 | 'Timer', 'setprofile', 'settrace', 'local', 'stack_size'] |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 35 | _start_new_thread = thread.start_new_thread |
| 36 | _allocate_lock = thread.allocate_lock |
| 37 | _get_ident = thread.get_ident |
Jeremy Hylton | b5fc749 | 2000-06-01 01:17:17 +0000 | [diff] [blame] | 38 | ThreadError = thread.error |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 39 | del thread |
| 40 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 41 | |
Jeffrey Yasskin | 105f3d4 | 2008-03-31 00:35:53 +0000 | [diff] [blame] | 42 | # sys.exc_clear is used to work around the fact that except blocks |
| 43 | # don't fully clear the exception until 3.0. |
| 44 | warnings.filterwarnings('ignore', category=DeprecationWarning, |
| 45 | module='threading', message='sys.exc_clear') |
| 46 | |
Tim Peters | 59aba12 | 2003-07-01 20:01:55 +0000 | [diff] [blame] | 47 | # Debug support (adapted from ihooks.py). |
| 48 | # All the major classes here derive from _Verbose. We force that to |
| 49 | # be a new-style class so that all the major classes here are new-style. |
| 50 | # This helps debugging (type(instance) is more revealing for instances |
| 51 | # of new-style classes). |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 52 | |
Tim Peters | 0939fac | 2003-07-01 19:28:44 +0000 | [diff] [blame] | 53 | _VERBOSE = False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 54 | |
| 55 | if __debug__: |
| 56 | |
Tim Peters | 59aba12 | 2003-07-01 20:01:55 +0000 | [diff] [blame] | 57 | class _Verbose(object): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 58 | |
| 59 | def __init__(self, verbose=None): |
| 60 | if verbose is None: |
| 61 | verbose = _VERBOSE |
| 62 | self.__verbose = verbose |
| 63 | |
| 64 | def _note(self, format, *args): |
| 65 | if self.__verbose: |
| 66 | format = format % args |
| 67 | format = "%s: %s\n" % ( |
Benjamin Peterson | b6a9556 | 2008-08-22 20:43:48 +0000 | [diff] [blame] | 68 | current_thread().name, format) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 69 | _sys.stderr.write(format) |
| 70 | |
| 71 | else: |
| 72 | # Disable this when using "python -O" |
Tim Peters | 59aba12 | 2003-07-01 20:01:55 +0000 | [diff] [blame] | 73 | class _Verbose(object): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 74 | def __init__(self, verbose=None): |
| 75 | pass |
| 76 | def _note(self, *args): |
| 77 | pass |
| 78 | |
Jeremy Hylton | bfccb35 | 2003-06-29 16:58:41 +0000 | [diff] [blame] | 79 | # Support for profile and trace hooks |
| 80 | |
| 81 | _profile_hook = None |
| 82 | _trace_hook = None |
| 83 | |
| 84 | def setprofile(func): |
| 85 | global _profile_hook |
| 86 | _profile_hook = func |
Tim Peters | d1b108b | 2003-06-29 17:24:17 +0000 | [diff] [blame] | 87 | |
Jeremy Hylton | bfccb35 | 2003-06-29 16:58:41 +0000 | [diff] [blame] | 88 | def settrace(func): |
| 89 | global _trace_hook |
| 90 | _trace_hook = func |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 91 | |
| 92 | # Synchronization classes |
| 93 | |
| 94 | Lock = _allocate_lock |
| 95 | |
| 96 | def RLock(*args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 97 | return _RLock(*args, **kwargs) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 98 | |
| 99 | class _RLock(_Verbose): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 100 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 101 | def __init__(self, verbose=None): |
| 102 | _Verbose.__init__(self, verbose) |
| 103 | self.__block = _allocate_lock() |
| 104 | self.__owner = None |
| 105 | self.__count = 0 |
| 106 | |
| 107 | def __repr__(self): |
Nick Coghlan | f8bbaa9 | 2007-07-31 13:38:01 +0000 | [diff] [blame] | 108 | owner = self.__owner |
Antoine Pitrou | c747d3a | 2009-11-09 16:47:50 +0000 | [diff] [blame^] | 109 | try: |
| 110 | owner = _active[owner].name |
| 111 | except KeyError: |
| 112 | pass |
| 113 | return "<%s owner=%r count=%d>" % ( |
| 114 | self.__class__.__name__, owner, self.__count) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 115 | |
| 116 | def acquire(self, blocking=1): |
Antoine Pitrou | c747d3a | 2009-11-09 16:47:50 +0000 | [diff] [blame^] | 117 | me = _get_ident() |
| 118 | if self.__owner == me: |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 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 Cannon | 90cece7 | 2005-01-27 22:48:30 +0000 | [diff] [blame] | 128 | self._note("%s.acquire(%s): initial success", self, blocking) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 129 | else: |
| 130 | if __debug__: |
| 131 | self._note("%s.acquire(%s): failure", self, blocking) |
| 132 | return rc |
| 133 | |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 134 | __enter__ = acquire |
| 135 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 136 | def release(self): |
Antoine Pitrou | c747d3a | 2009-11-09 16:47:50 +0000 | [diff] [blame^] | 137 | if self.__owner != _get_ident(): |
Georg Brandl | f004d9d | 2009-10-27 15:39:53 +0000 | [diff] [blame] | 138 | raise RuntimeError("cannot release un-acquired lock") |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 139 | 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 Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 149 | def __exit__(self, t, v, tb): |
| 150 | self.release() |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 151 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 152 | # Internal methods used by condition variables |
| 153 | |
Brett Cannon | 2005050 | 2008-08-02 03:13:46 +0000 | [diff] [blame] | 154 | def _acquire_restore(self, count_owner): |
| 155 | count, owner = count_owner |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 156 | 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): |
Antoine Pitrou | c747d3a | 2009-11-09 16:47:50 +0000 | [diff] [blame^] | 173 | return self.__owner == _get_ident() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 174 | |
| 175 | |
| 176 | def Condition(*args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 177 | return _Condition(*args, **kwargs) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 178 | |
| 179 | class _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 Rossum | da5b701 | 2006-05-02 19:47:52 +0000 | [diff] [blame] | 206 | def __enter__(self): |
| 207 | return self.__lock.__enter__() |
| 208 | |
| 209 | def __exit__(self, *args): |
| 210 | return self.__lock.__exit__(*args) |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 211 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 212 | 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 Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 222 | # Return True if lock is owned by current_thread. |
Jeremy Hylton | af7fde7 | 2002-08-14 17:43:59 +0000 | [diff] [blame] | 223 | # This method is called only if __lock doesn't have _is_owned(). |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 224 | if self.__lock.acquire(0): |
| 225 | self.__lock.release() |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 226 | return False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 227 | else: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 228 | return True |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 229 | |
| 230 | def wait(self, timeout=None): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 231 | if not self._is_owned(): |
Georg Brandl | f004d9d | 2009-10-27 15:39:53 +0000 | [diff] [blame] | 232 | raise RuntimeError("cannot wait on un-acquired lock") |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 233 | waiter = _allocate_lock() |
| 234 | waiter.acquire() |
| 235 | self.__waiters.append(waiter) |
| 236 | saved_state = self._release_save() |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 237 | try: # restore state no matter what (e.g., KeyboardInterrupt) |
| 238 | if timeout is None: |
| 239 | waiter.acquire() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 240 | if __debug__: |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 241 | self._note("%s.wait(): got it", self) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 242 | else: |
Tim Peters | a6a4f27 | 2001-08-12 00:41:33 +0000 | [diff] [blame] | 243 | # 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 Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 248 | endtime = _time() + timeout |
Tim Peters | a6a4f27 | 2001-08-12 00:41:33 +0000 | [diff] [blame] | 249 | delay = 0.0005 # 500 us -> initial delay of 1 ms |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 250 | while True: |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 251 | gotit = waiter.acquire(0) |
Tim Peters | a6a4f27 | 2001-08-12 00:41:33 +0000 | [diff] [blame] | 252 | if gotit: |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 253 | break |
Tim Peters | a6a4f27 | 2001-08-12 00:41:33 +0000 | [diff] [blame] | 254 | remaining = endtime - _time() |
| 255 | if remaining <= 0: |
| 256 | break |
| 257 | delay = min(delay * 2, remaining, .05) |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 258 | _sleep(delay) |
Tim Peters | c951bf9 | 2001-04-02 20:15:57 +0000 | [diff] [blame] | 259 | 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 Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 271 | |
| 272 | def notify(self, n=1): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 273 | if not self._is_owned(): |
Georg Brandl | f004d9d | 2009-10-27 15:39:53 +0000 | [diff] [blame] | 274 | raise RuntimeError("cannot notify on un-acquired lock") |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 275 | __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 Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 290 | def notifyAll(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 291 | self.notify(len(self.__waiters)) |
| 292 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 293 | notify_all = notifyAll |
Benjamin Peterson | f439560 | 2008-06-11 17:50:00 +0000 | [diff] [blame] | 294 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 295 | |
| 296 | def Semaphore(*args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 297 | return _Semaphore(*args, **kwargs) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 298 | |
| 299 | class _Semaphore(_Verbose): |
| 300 | |
Andrew M. Kuchling | 39d3bfc | 2000-02-29 00:10:24 +0000 | [diff] [blame] | 301 | # After Tim Peters' semaphore class, but not quite the same (no maximum) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 302 | |
| 303 | def __init__(self, value=1, verbose=None): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 304 | if value < 0: |
| 305 | raise ValueError("semaphore initial value must be >= 0") |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 306 | _Verbose.__init__(self, verbose) |
| 307 | self.__cond = Condition(Lock()) |
| 308 | self.__value = value |
| 309 | |
| 310 | def acquire(self, blocking=1): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 311 | rc = False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 312 | self.__cond.acquire() |
| 313 | while self.__value == 0: |
| 314 | if not blocking: |
| 315 | break |
Skip Montanaro | b446fc7 | 2001-08-19 04:25:24 +0000 | [diff] [blame] | 316 | if __debug__: |
| 317 | self._note("%s.acquire(%s): blocked waiting, value=%s", |
| 318 | self, blocking, self.__value) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 319 | self.__cond.wait() |
| 320 | else: |
| 321 | self.__value = self.__value - 1 |
Skip Montanaro | b446fc7 | 2001-08-19 04:25:24 +0000 | [diff] [blame] | 322 | if __debug__: |
Skip Montanaro | ae8454a | 2001-08-19 05:53:47 +0000 | [diff] [blame] | 323 | self._note("%s.acquire: success, value=%s", |
| 324 | self, self.__value) |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 325 | rc = True |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 326 | self.__cond.release() |
| 327 | return rc |
| 328 | |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 329 | __enter__ = acquire |
| 330 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 331 | def release(self): |
| 332 | self.__cond.acquire() |
| 333 | self.__value = self.__value + 1 |
Skip Montanaro | b446fc7 | 2001-08-19 04:25:24 +0000 | [diff] [blame] | 334 | if __debug__: |
Skip Montanaro | ae8454a | 2001-08-19 05:53:47 +0000 | [diff] [blame] | 335 | self._note("%s.release: success, value=%s", |
| 336 | self, self.__value) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 337 | self.__cond.notify() |
| 338 | self.__cond.release() |
| 339 | |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 340 | def __exit__(self, t, v, tb): |
| 341 | self.release() |
Guido van Rossum | 1a5e21e | 2006-02-28 21:57:43 +0000 | [diff] [blame] | 342 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 343 | |
Skip Montanaro | e428bb7 | 2001-08-20 20:27:58 +0000 | [diff] [blame] | 344 | def BoundedSemaphore(*args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 345 | return _BoundedSemaphore(*args, **kwargs) |
Skip Montanaro | e428bb7 | 2001-08-20 20:27:58 +0000 | [diff] [blame] | 346 | |
| 347 | class _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 Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 359 | def Event(*args, **kwargs): |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 360 | return _Event(*args, **kwargs) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 361 | |
| 362 | class _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 Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 369 | self.__flag = False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 370 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 371 | def isSet(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 372 | return self.__flag |
| 373 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 374 | is_set = isSet |
Benjamin Peterson | f439560 | 2008-06-11 17:50:00 +0000 | [diff] [blame] | 375 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 376 | def set(self): |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 377 | self.__cond.acquire() |
| 378 | try: |
Guido van Rossum | 21b6014 | 2002-11-21 21:08:39 +0000 | [diff] [blame] | 379 | self.__flag = True |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 380 | self.__cond.notify_all() |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 381 | finally: |
| 382 | self.__cond.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 383 | |
| 384 | def clear(self): |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 385 | self.__cond.acquire() |
| 386 | try: |
Guido van Rossum | 21b6014 | 2002-11-21 21:08:39 +0000 | [diff] [blame] | 387 | self.__flag = False |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 388 | finally: |
| 389 | self.__cond.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 390 | |
| 391 | def wait(self, timeout=None): |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 392 | self.__cond.acquire() |
| 393 | try: |
Guido van Rossum | 21b6014 | 2002-11-21 21:08:39 +0000 | [diff] [blame] | 394 | if not self.__flag: |
| 395 | self.__cond.wait(timeout) |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 396 | finally: |
| 397 | self.__cond.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 398 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 399 | # Helper to generate new thread names |
| 400 | _counter = 0 |
| 401 | def _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 Peters | 711906e | 2005-01-08 07:30:42 +0000 | [diff] [blame] | 408 | _active = {} # maps thread id to Thread object |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 409 | _limbo = {} |
| 410 | |
| 411 | |
| 412 | # Main class for threads |
| 413 | |
| 414 | class Thread(_Verbose): |
| 415 | |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 416 | __initialized = False |
Brett Cannon | cc4e935 | 2004-07-03 03:52:35 +0000 | [diff] [blame] | 417 | # 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 Yasskin | 8b9091f | 2008-03-28 04:11:18 +0000 | [diff] [blame] | 422 | # Keep sys.exc_clear too to clear the exception just before |
| 423 | # allowing .join() to return. |
| 424 | __exc_clear = _sys.exc_clear |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 425 | |
| 426 | def __init__(self, group=None, target=None, name=None, |
Georg Brandl | a4a8b82 | 2005-07-15 09:13:21 +0000 | [diff] [blame] | 427 | args=(), kwargs=None, verbose=None): |
Guido van Rossum | 5a43e1a | 1998-06-09 19:04:26 +0000 | [diff] [blame] | 428 | assert group is None, "group argument must be None for now" |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 429 | _Verbose.__init__(self, verbose) |
Georg Brandl | a4a8b82 | 2005-07-15 09:13:21 +0000 | [diff] [blame] | 430 | if kwargs is None: |
| 431 | kwargs = {} |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 432 | 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. Smith | 8856dda | 2008-06-01 23:48:47 +0000 | [diff] [blame] | 437 | self.__ident = None |
Jeffrey Yasskin | 69e1309 | 2008-02-28 06:09:19 +0000 | [diff] [blame] | 438 | self.__started = Event() |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 439 | self.__stopped = False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 440 | self.__block = Condition(Lock()) |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 441 | self.__initialized = True |
Brett Cannon | cc4e935 | 2004-07-03 03:52:35 +0000 | [diff] [blame] | 442 | # 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 Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 445 | |
| 446 | def _set_daemon(self): |
| 447 | # Overridden in _MainThread and _DummyThread |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 448 | return current_thread().daemon |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 449 | |
| 450 | def __repr__(self): |
| 451 | assert self.__initialized, "Thread.__init__() was not called" |
| 452 | status = "initial" |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 453 | if self.__started.is_set(): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 454 | status = "started" |
| 455 | if self.__stopped: |
| 456 | status = "stopped" |
| 457 | if self.__daemonic: |
Gregory P. Smith | 8856dda | 2008-06-01 23:48:47 +0000 | [diff] [blame] | 458 | status += " daemon" |
| 459 | if self.__ident is not None: |
| 460 | status += " %s" % self.__ident |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 461 | return "<%s(%s, %s)>" % (self.__class__.__name__, self.__name, status) |
| 462 | |
| 463 | def start(self): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 464 | if not self.__initialized: |
| 465 | raise RuntimeError("thread.__init__() not called") |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 466 | if self.__started.is_set(): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 467 | raise RuntimeError("thread already started") |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 468 | 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 Yasskin | 69e1309 | 2008-02-28 06:09:19 +0000 | [diff] [blame] | 474 | self.__started.wait() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 475 | |
| 476 | def run(self): |
Jeffrey Yasskin | a885c15 | 2008-02-23 20:40:35 +0000 | [diff] [blame] | 477 | 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 Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 484 | |
| 485 | def __bootstrap(self): |
Guido van Rossum | 54ec61e | 2007-08-20 15:18:04 +0000 | [diff] [blame] | 486 | # 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 | |
Benjamin Peterson | 61611f8 | 2009-03-31 21:40:18 +0000 | [diff] [blame] | 505 | def _set_ident(self): |
| 506 | self.__ident = _get_ident() |
| 507 | |
Guido van Rossum | 54ec61e | 2007-08-20 15:18:04 +0000 | [diff] [blame] | 508 | def __bootstrap_inner(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 509 | try: |
Benjamin Peterson | 61611f8 | 2009-03-31 21:40:18 +0000 | [diff] [blame] | 510 | self._set_ident() |
Jeffrey Yasskin | 69e1309 | 2008-02-28 06:09:19 +0000 | [diff] [blame] | 511 | self.__started.set() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 512 | _active_limbo_lock.acquire() |
Gregory P. Smith | 8856dda | 2008-06-01 23:48:47 +0000 | [diff] [blame] | 513 | _active[self.__ident] = self |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 514 | del _limbo[self] |
| 515 | _active_limbo_lock.release() |
| 516 | if __debug__: |
| 517 | self._note("%s.__bootstrap(): thread started", self) |
Jeremy Hylton | bfccb35 | 2003-06-29 16:58:41 +0000 | [diff] [blame] | 518 | |
| 519 | if _trace_hook: |
| 520 | self._note("%s.__bootstrap(): registering trace hook", self) |
| 521 | _sys.settrace(_trace_hook) |
| 522 | if _profile_hook: |
| 523 | self._note("%s.__bootstrap(): registering profile hook", self) |
| 524 | _sys.setprofile(_profile_hook) |
Tim Peters | d1b108b | 2003-06-29 17:24:17 +0000 | [diff] [blame] | 525 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 526 | try: |
| 527 | self.run() |
| 528 | except SystemExit: |
| 529 | if __debug__: |
| 530 | self._note("%s.__bootstrap(): raised SystemExit", self) |
| 531 | except: |
| 532 | if __debug__: |
| 533 | self._note("%s.__bootstrap(): unhandled exception", self) |
Brett Cannon | cc4e935 | 2004-07-03 03:52:35 +0000 | [diff] [blame] | 534 | # If sys.stderr is no more (most likely from interpreter |
| 535 | # shutdown) use self.__stderr. Otherwise still use sys (as in |
| 536 | # _sys) in case sys.stderr was redefined since the creation of |
| 537 | # self. |
| 538 | if _sys: |
| 539 | _sys.stderr.write("Exception in thread %s:\n%s\n" % |
Benjamin Peterson | b6a9556 | 2008-08-22 20:43:48 +0000 | [diff] [blame] | 540 | (self.name, _format_exc())) |
Brett Cannon | cc4e935 | 2004-07-03 03:52:35 +0000 | [diff] [blame] | 541 | else: |
| 542 | # Do the best job possible w/o a huge amt. of code to |
| 543 | # approximate a traceback (code ideas from |
| 544 | # Lib/traceback.py) |
| 545 | exc_type, exc_value, exc_tb = self.__exc_info() |
| 546 | try: |
| 547 | print>>self.__stderr, ( |
Benjamin Peterson | b6a9556 | 2008-08-22 20:43:48 +0000 | [diff] [blame] | 548 | "Exception in thread " + self.name + |
Brett Cannon | cc4e935 | 2004-07-03 03:52:35 +0000 | [diff] [blame] | 549 | " (most likely raised during interpreter shutdown):") |
| 550 | print>>self.__stderr, ( |
| 551 | "Traceback (most recent call last):") |
| 552 | while exc_tb: |
| 553 | print>>self.__stderr, ( |
| 554 | ' File "%s", line %s, in %s' % |
| 555 | (exc_tb.tb_frame.f_code.co_filename, |
| 556 | exc_tb.tb_lineno, |
| 557 | exc_tb.tb_frame.f_code.co_name)) |
| 558 | exc_tb = exc_tb.tb_next |
| 559 | print>>self.__stderr, ("%s: %s" % (exc_type, exc_value)) |
| 560 | # Make sure that exc_tb gets deleted since it is a memory |
| 561 | # hog; deleting everything else is just for thoroughness |
| 562 | finally: |
| 563 | del exc_type, exc_value, exc_tb |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 564 | else: |
| 565 | if __debug__: |
| 566 | self._note("%s.__bootstrap(): normal return", self) |
Jeffrey Yasskin | 8b9091f | 2008-03-28 04:11:18 +0000 | [diff] [blame] | 567 | finally: |
| 568 | # Prevent a race in |
| 569 | # test_threading.test_no_refcycle_through_target when |
| 570 | # the exception keeps the target alive past when we |
| 571 | # assert that it's dead. |
Amaury Forgeot d'Arc | 504a48f | 2008-03-29 01:41:08 +0000 | [diff] [blame] | 572 | self.__exc_clear() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 573 | finally: |
Gregory P. Smith | 95cd5c0 | 2008-01-22 01:20:42 +0000 | [diff] [blame] | 574 | with _active_limbo_lock: |
| 575 | self.__stop() |
| 576 | try: |
| 577 | # We don't call self.__delete() because it also |
| 578 | # grabs _active_limbo_lock. |
| 579 | del _active[_get_ident()] |
| 580 | except: |
| 581 | pass |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 582 | |
| 583 | def __stop(self): |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 584 | self.__block.acquire() |
| 585 | self.__stopped = True |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 586 | self.__block.notify_all() |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 587 | self.__block.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 588 | |
| 589 | def __delete(self): |
Tim Peters | 2142993 | 2004-07-21 03:36:52 +0000 | [diff] [blame] | 590 | "Remove current thread from the dict of currently running threads." |
Brett Cannon | 8b3d92a | 2004-07-21 02:21:58 +0000 | [diff] [blame] | 591 | |
Tim Peters | 2142993 | 2004-07-21 03:36:52 +0000 | [diff] [blame] | 592 | # Notes about running with dummy_thread: |
| 593 | # |
| 594 | # Must take care to not raise an exception if dummy_thread is being |
| 595 | # used (and thus this module is being used as an instance of |
| 596 | # dummy_threading). dummy_thread.get_ident() always returns -1 since |
| 597 | # there is only one thread if dummy_thread is being used. Thus |
| 598 | # len(_active) is always <= 1 here, and any Thread instance created |
| 599 | # overwrites the (if any) thread currently registered in _active. |
| 600 | # |
| 601 | # An instance of _MainThread is always created by 'threading'. This |
| 602 | # gets overwritten the instant an instance of Thread is created; both |
| 603 | # threads return -1 from dummy_thread.get_ident() and thus have the |
| 604 | # same key in the dict. So when the _MainThread instance created by |
| 605 | # 'threading' tries to clean itself up when atexit calls this method |
| 606 | # it gets a KeyError if another Thread instance was created. |
| 607 | # |
| 608 | # This all means that KeyError from trying to delete something from |
| 609 | # _active if dummy_threading is being used is a red herring. But |
| 610 | # since it isn't if dummy_threading is *not* being used then don't |
| 611 | # hide the exception. |
Brett Cannon | 8b3d92a | 2004-07-21 02:21:58 +0000 | [diff] [blame] | 612 | |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 613 | try: |
Amaury Forgeot d'Arc | d7a2651 | 2008-04-03 23:07:55 +0000 | [diff] [blame] | 614 | with _active_limbo_lock: |
Brett Cannon | 8b3d92a | 2004-07-21 02:21:58 +0000 | [diff] [blame] | 615 | del _active[_get_ident()] |
Amaury Forgeot d'Arc | d7a2651 | 2008-04-03 23:07:55 +0000 | [diff] [blame] | 616 | # There must not be any python code between the previous line |
| 617 | # and after the lock is released. Otherwise a tracing function |
| 618 | # could try to acquire the lock again in the same thread, (in |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 619 | # current_thread()), and would block. |
Amaury Forgeot d'Arc | d7a2651 | 2008-04-03 23:07:55 +0000 | [diff] [blame] | 620 | except KeyError: |
| 621 | if 'dummy_threading' not in _sys.modules: |
| 622 | raise |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 623 | |
| 624 | def join(self, timeout=None): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 625 | if not self.__initialized: |
| 626 | raise RuntimeError("Thread.__init__() not called") |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 627 | if not self.__started.is_set(): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 628 | raise RuntimeError("cannot join thread before it is started") |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 629 | if self is current_thread(): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 630 | raise RuntimeError("cannot join current thread") |
| 631 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 632 | if __debug__: |
| 633 | if not self.__stopped: |
| 634 | self._note("%s.join(): waiting until thread stops", self) |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 635 | self.__block.acquire() |
| 636 | try: |
Brett Cannon | ad07ff2 | 2005-11-23 02:15:50 +0000 | [diff] [blame] | 637 | if timeout is None: |
| 638 | while not self.__stopped: |
| 639 | self.__block.wait() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 640 | if __debug__: |
| 641 | self._note("%s.join(): thread stopped", self) |
Brett Cannon | ad07ff2 | 2005-11-23 02:15:50 +0000 | [diff] [blame] | 642 | else: |
| 643 | deadline = _time() + timeout |
| 644 | while not self.__stopped: |
| 645 | delay = deadline - _time() |
| 646 | if delay <= 0: |
| 647 | if __debug__: |
| 648 | self._note("%s.join(): timed out", self) |
| 649 | break |
| 650 | self.__block.wait(delay) |
| 651 | else: |
| 652 | if __debug__: |
| 653 | self._note("%s.join(): thread stopped", self) |
Raymond Hettinger | 70ec29d | 2008-01-24 18:12:23 +0000 | [diff] [blame] | 654 | finally: |
| 655 | self.__block.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 656 | |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 657 | @property |
| 658 | def name(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 659 | assert self.__initialized, "Thread.__init__() not called" |
| 660 | return self.__name |
| 661 | |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 662 | @name.setter |
| 663 | def name(self, name): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 664 | assert self.__initialized, "Thread.__init__() not called" |
| 665 | self.__name = str(name) |
| 666 | |
Benjamin Peterson | d8a8972 | 2008-08-18 16:40:03 +0000 | [diff] [blame] | 667 | @property |
| 668 | def ident(self): |
Gregory P. Smith | 8856dda | 2008-06-01 23:48:47 +0000 | [diff] [blame] | 669 | assert self.__initialized, "Thread.__init__() not called" |
| 670 | return self.__ident |
| 671 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 672 | def isAlive(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 673 | assert self.__initialized, "Thread.__init__() not called" |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 674 | return self.__started.is_set() and not self.__stopped |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 675 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 676 | is_alive = isAlive |
Benjamin Peterson | 6ee1a31 | 2008-08-18 21:53:29 +0000 | [diff] [blame] | 677 | |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 678 | @property |
| 679 | def daemon(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 680 | assert self.__initialized, "Thread.__init__() not called" |
| 681 | return self.__daemonic |
| 682 | |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 683 | @daemon.setter |
| 684 | def daemon(self, daemonic): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 685 | if not self.__initialized: |
| 686 | raise RuntimeError("Thread.__init__() not called") |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 687 | if self.__started.is_set(): |
Collin Winter | 50b79ce | 2007-06-06 00:17:35 +0000 | [diff] [blame] | 688 | raise RuntimeError("cannot set daemon status of active thread"); |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 689 | self.__daemonic = daemonic |
| 690 | |
Benjamin Peterson | d810626 | 2008-08-18 18:13:17 +0000 | [diff] [blame] | 691 | def isDaemon(self): |
| 692 | return self.daemon |
| 693 | |
| 694 | def setDaemon(self, daemonic): |
| 695 | self.daemon = daemonic |
| 696 | |
| 697 | def getName(self): |
| 698 | return self.name |
| 699 | |
| 700 | def setName(self, name): |
| 701 | self.name = name |
| 702 | |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 703 | # The timer class was contributed by Itamar Shtull-Trauring |
| 704 | |
| 705 | def Timer(*args, **kwargs): |
| 706 | return _Timer(*args, **kwargs) |
| 707 | |
| 708 | class _Timer(Thread): |
| 709 | """Call a function after a specified number of seconds: |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 710 | |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 711 | t = Timer(30.0, f, args=[], kwargs={}) |
| 712 | t.start() |
| 713 | t.cancel() # stop the timer's action if it's still waiting |
| 714 | """ |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 715 | |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 716 | def __init__(self, interval, function, args=[], kwargs={}): |
| 717 | Thread.__init__(self) |
| 718 | self.interval = interval |
| 719 | self.function = function |
| 720 | self.args = args |
| 721 | self.kwargs = kwargs |
| 722 | self.finished = Event() |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 723 | |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 724 | def cancel(self): |
| 725 | """Stop the timer if it hasn't finished yet""" |
| 726 | self.finished.set() |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 727 | |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 728 | def run(self): |
| 729 | self.finished.wait(self.interval) |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 730 | if not self.finished.is_set(): |
Martin v. Löwis | 44f8696 | 2001-09-05 13:44:54 +0000 | [diff] [blame] | 731 | self.function(*self.args, **self.kwargs) |
| 732 | self.finished.set() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 733 | |
| 734 | # Special thread class to represent the main thread |
| 735 | # This is garbage collected through an exit handler |
| 736 | |
| 737 | class _MainThread(Thread): |
| 738 | |
| 739 | def __init__(self): |
| 740 | Thread.__init__(self, name="MainThread") |
Jeffrey Yasskin | 69e1309 | 2008-02-28 06:09:19 +0000 | [diff] [blame] | 741 | self._Thread__started.set() |
Benjamin Peterson | 61611f8 | 2009-03-31 21:40:18 +0000 | [diff] [blame] | 742 | self._set_ident() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 743 | _active_limbo_lock.acquire() |
| 744 | _active[_get_ident()] = self |
| 745 | _active_limbo_lock.release() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 746 | |
| 747 | def _set_daemon(self): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 748 | return False |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 749 | |
Martin v. Löwis | 7b7c9d4 | 2007-01-04 21:06:12 +0000 | [diff] [blame] | 750 | def _exitfunc(self): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 751 | self._Thread__stop() |
| 752 | t = _pickSomeNonDaemonThread() |
| 753 | if t: |
| 754 | if __debug__: |
| 755 | self._note("%s: waiting for other threads", self) |
| 756 | while t: |
| 757 | t.join() |
| 758 | t = _pickSomeNonDaemonThread() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 759 | if __debug__: |
| 760 | self._note("%s: exiting", self) |
| 761 | self._Thread__delete() |
| 762 | |
| 763 | def _pickSomeNonDaemonThread(): |
| 764 | for t in enumerate(): |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 765 | if not t.daemon and t.is_alive(): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 766 | return t |
| 767 | return None |
| 768 | |
| 769 | |
| 770 | # Dummy thread class to represent threads not started here. |
Tim Peters | 711906e | 2005-01-08 07:30:42 +0000 | [diff] [blame] | 771 | # These aren't garbage collected when they die, nor can they be waited for. |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 772 | # If they invoke anything in threading.py that calls current_thread(), they |
Tim Peters | 711906e | 2005-01-08 07:30:42 +0000 | [diff] [blame] | 773 | # leave an entry in the _active dict forever after. |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 774 | # Their purpose is to return *something* from current_thread(). |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 775 | # They are marked as daemon threads so we won't wait for them |
| 776 | # when we exit (conform previous semantics). |
| 777 | |
| 778 | class _DummyThread(Thread): |
Tim Peters | b90f89a | 2001-01-15 03:26:36 +0000 | [diff] [blame] | 779 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 780 | def __init__(self): |
| 781 | Thread.__init__(self, name=_newname("Dummy-%d")) |
Tim Peters | 711906e | 2005-01-08 07:30:42 +0000 | [diff] [blame] | 782 | |
| 783 | # Thread.__block consumes an OS-level locking primitive, which |
| 784 | # can never be used by a _DummyThread. Since a _DummyThread |
| 785 | # instance is immortal, that's bad, so release this resource. |
Brett Cannon | e6539c4 | 2005-01-08 02:43:53 +0000 | [diff] [blame] | 786 | del self._Thread__block |
Tim Peters | 711906e | 2005-01-08 07:30:42 +0000 | [diff] [blame] | 787 | |
Jeffrey Yasskin | 69e1309 | 2008-02-28 06:09:19 +0000 | [diff] [blame] | 788 | self._Thread__started.set() |
Benjamin Peterson | 61611f8 | 2009-03-31 21:40:18 +0000 | [diff] [blame] | 789 | self._set_ident() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 790 | _active_limbo_lock.acquire() |
| 791 | _active[_get_ident()] = self |
| 792 | _active_limbo_lock.release() |
| 793 | |
| 794 | def _set_daemon(self): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 795 | return True |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 796 | |
Neal Norwitz | 45bec8c | 2002-02-19 03:01:36 +0000 | [diff] [blame] | 797 | def join(self, timeout=None): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 798 | assert False, "cannot join a dummy thread" |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 799 | |
| 800 | |
| 801 | # Global API functions |
| 802 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 803 | def currentThread(): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 804 | try: |
| 805 | return _active[_get_ident()] |
| 806 | except KeyError: |
Benjamin Peterson | 0fbcf69 | 2008-06-11 17:27:50 +0000 | [diff] [blame] | 807 | ##print "current_thread(): no current thread for", _get_ident() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 808 | return _DummyThread() |
| 809 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 810 | current_thread = currentThread |
Benjamin Peterson | f439560 | 2008-06-11 17:50:00 +0000 | [diff] [blame] | 811 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 812 | def activeCount(): |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 813 | _active_limbo_lock.acquire() |
| 814 | count = len(_active) + len(_limbo) |
| 815 | _active_limbo_lock.release() |
| 816 | return count |
| 817 | |
Benjamin Peterson | 973e6c2 | 2008-09-01 23:12:58 +0000 | [diff] [blame] | 818 | active_count = activeCount |
Benjamin Peterson | f439560 | 2008-06-11 17:50:00 +0000 | [diff] [blame] | 819 | |
Antoine Pitrou | 4fb961c | 2009-11-05 13:44:28 +0000 | [diff] [blame] | 820 | def _enumerate(): |
| 821 | # Same as enumerate(), but without the lock. Internal use only. |
| 822 | return _active.values() + _limbo.values() |
| 823 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 824 | def enumerate(): |
| 825 | _active_limbo_lock.acquire() |
| 826 | active = _active.values() + _limbo.values() |
| 827 | _active_limbo_lock.release() |
| 828 | return active |
| 829 | |
Andrew MacIntyre | 9291332 | 2006-06-13 15:04:24 +0000 | [diff] [blame] | 830 | from thread import stack_size |
| 831 | |
Martin v. Löwis | 7b7c9d4 | 2007-01-04 21:06:12 +0000 | [diff] [blame] | 832 | # Create the main thread object, |
| 833 | # and make it available for the interpreter |
| 834 | # (Py_Main) as threading._shutdown. |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 835 | |
Martin v. Löwis | 7b7c9d4 | 2007-01-04 21:06:12 +0000 | [diff] [blame] | 836 | _shutdown = _MainThread()._exitfunc |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 837 | |
Jim Fulton | d15dc06 | 2004-07-14 19:11:50 +0000 | [diff] [blame] | 838 | # get thread-local implementation, either from the thread |
| 839 | # module, or from the python fallback |
| 840 | |
| 841 | try: |
| 842 | from thread import _local as local |
| 843 | except ImportError: |
| 844 | from _threading_local import local |
| 845 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 846 | |
Jesse Noller | 5e62ca4 | 2008-07-16 20:03:47 +0000 | [diff] [blame] | 847 | def _after_fork(): |
| 848 | # This function is called by Python/ceval.c:PyEval_ReInitThreads which |
| 849 | # is called from PyOS_AfterFork. Here we cleanup threading module state |
| 850 | # that should not exist after a fork. |
| 851 | |
| 852 | # Reset _active_limbo_lock, in case we forked while the lock was held |
| 853 | # by another (non-forked) thread. http://bugs.python.org/issue874900 |
| 854 | global _active_limbo_lock |
| 855 | _active_limbo_lock = _allocate_lock() |
| 856 | |
| 857 | # fork() only copied the current thread; clear references to others. |
| 858 | new_active = {} |
| 859 | current = current_thread() |
| 860 | with _active_limbo_lock: |
Antoine Pitrou | 9fb1aca | 2008-09-06 23:04:32 +0000 | [diff] [blame] | 861 | for thread in _active.itervalues(): |
Jesse Noller | 5e62ca4 | 2008-07-16 20:03:47 +0000 | [diff] [blame] | 862 | if thread is current: |
Antoine Pitrou | 9fb1aca | 2008-09-06 23:04:32 +0000 | [diff] [blame] | 863 | # There is only one active thread. We reset the ident to |
| 864 | # its new value since it can have changed. |
| 865 | ident = _get_ident() |
| 866 | thread._Thread__ident = ident |
Jesse Noller | 5e62ca4 | 2008-07-16 20:03:47 +0000 | [diff] [blame] | 867 | new_active[ident] = thread |
| 868 | else: |
| 869 | # All the others are already stopped. |
| 870 | # We don't call _Thread__stop() because it tries to acquire |
| 871 | # thread._Thread__block which could also have been held while |
| 872 | # we forked. |
| 873 | thread._Thread__stopped = True |
| 874 | |
| 875 | _limbo.clear() |
| 876 | _active.clear() |
| 877 | _active.update(new_active) |
| 878 | assert len(_active) == 1 |
| 879 | |
| 880 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 881 | # Self-test code |
| 882 | |
| 883 | def _test(): |
| 884 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 885 | class BoundedQueue(_Verbose): |
| 886 | |
| 887 | def __init__(self, limit): |
| 888 | _Verbose.__init__(self) |
| 889 | self.mon = RLock() |
| 890 | self.rc = Condition(self.mon) |
| 891 | self.wc = Condition(self.mon) |
| 892 | self.limit = limit |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 893 | self.queue = deque() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 894 | |
| 895 | def put(self, item): |
| 896 | self.mon.acquire() |
| 897 | while len(self.queue) >= self.limit: |
| 898 | self._note("put(%s): queue full", item) |
| 899 | self.wc.wait() |
| 900 | self.queue.append(item) |
| 901 | self._note("put(%s): appended, length now %d", |
| 902 | item, len(self.queue)) |
| 903 | self.rc.notify() |
| 904 | self.mon.release() |
| 905 | |
| 906 | def get(self): |
| 907 | self.mon.acquire() |
| 908 | while not self.queue: |
| 909 | self._note("get(): queue empty") |
| 910 | self.rc.wait() |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 911 | item = self.queue.popleft() |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 912 | self._note("get(): got %s, %d left", item, len(self.queue)) |
| 913 | self.wc.notify() |
| 914 | self.mon.release() |
| 915 | return item |
| 916 | |
| 917 | class ProducerThread(Thread): |
| 918 | |
| 919 | def __init__(self, queue, quota): |
| 920 | Thread.__init__(self, name="Producer") |
| 921 | self.queue = queue |
| 922 | self.quota = quota |
| 923 | |
| 924 | def run(self): |
Guido van Rossum | b26a1b4 | 1998-05-20 17:05:52 +0000 | [diff] [blame] | 925 | from random import random |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 926 | counter = 0 |
| 927 | while counter < self.quota: |
| 928 | counter = counter + 1 |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 929 | self.queue.put("%s.%d" % (self.name, counter)) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 930 | _sleep(random() * 0.00001) |
| 931 | |
| 932 | |
| 933 | class ConsumerThread(Thread): |
| 934 | |
| 935 | def __init__(self, queue, count): |
| 936 | Thread.__init__(self, name="Consumer") |
| 937 | self.queue = queue |
| 938 | self.count = count |
| 939 | |
| 940 | def run(self): |
| 941 | while self.count > 0: |
| 942 | item = self.queue.get() |
| 943 | print item |
| 944 | self.count = self.count - 1 |
| 945 | |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 946 | NP = 3 |
| 947 | QL = 4 |
| 948 | NI = 5 |
| 949 | |
| 950 | Q = BoundedQueue(QL) |
| 951 | P = [] |
| 952 | for i in range(NP): |
| 953 | t = ProducerThread(Q, NI) |
Benjamin Peterson | cbae869 | 2008-08-18 17:45:09 +0000 | [diff] [blame] | 954 | t.name = ("Producer-%d" % (i+1)) |
Guido van Rossum | 7f5013a | 1998-04-09 22:01:42 +0000 | [diff] [blame] | 955 | P.append(t) |
| 956 | C = ConsumerThread(Q, NI*NP) |
| 957 | for t in P: |
| 958 | t.start() |
| 959 | _sleep(0.000001) |
| 960 | C.start() |
| 961 | for t in P: |
| 962 | t.join() |
| 963 | C.join() |
| 964 | |
| 965 | if __name__ == '__main__': |
| 966 | _test() |