""" This module reimplements Python's native threading module using Panda threading constructs. It's designed as a drop-in replacement for the threading module for code that works with Panda; it is necessary because in some compilation models, Panda's threading constructs are incompatible with the OS-provided threads used by Python's thread module. This module implements the threading module with a thin layer over Panda's threading constructs. As such, the semantics are close to, but not precisely, the semantics documented for Python's standard threading module. If you really do require strict adherence to Python's semantics, see the threading2 module instead. However, if you don't need such strict adherence to Python's original semantics, this module is probably a better choice. It is likely to be slighly faster than the threading2 module (and even slightly faster than Python's own threading module). It is also better integrated with Panda's threads, so that Panda's thread debug mechanisms will be easier to use and understand. It is permissible to mix-and-match both threading and threading2 within the same application. """ # We import PandaModules as the name pm, so we can avoid namespace # collisions between native Panda objects, and our own class # definitions in this module. """ import direct from pandac import PandaModules as pm from direct.stdpy import thread as _thread import sys as _sys import weakref __all__ = [ 'Thread', 'Lock', 'RLock', 'Condition', 'Semaphore', 'BoundedSemaphore', 'Event', 'Timer', 'local', 'current_thread', 'currentThread', 'enumerate', 'active_count', 'activeCount', 'settrace', 'setprofile', 'stack_size', ] local = _thread._local class ThreadBase: """ A base class for both Thread and ExternalThread in this module. """ def __init__(self): pass def getName(self): return self.name def is_alive(self): return self.__thread.isStarted() def isAlive(self): return self.__thread.isStarted() def isDaemon(self): return self.daemon def setDaemon(self, daemon): if self.is_alive(): raise RuntimeError self.__dict__['daemon'] = daemon def __setattr__(self, key, value): if key == 'name': self.setName(value) elif key == 'ident': raise AttributeError elif key == 'daemon': self.setDaemon(value) else: self.__dict__[key] = value # Copy these static methods from Panda's Thread object. These are # useful if you may be running in Panda's SIMPLE_THREADS compilation # mode. ThreadBase.forceYield = pm.Thread.forceYield ThreadBase.considerYield = pm.Thread.considerYield class Thread(ThreadBase): """ This class provides a wrapper around Panda's PythonThread object. The wrapper is designed to emulate Python's own threading.Thread object. """ def __init__(self, group=None, target=None, name=None, args=(), kwargs={}): ThreadBase.__init__(self) assert group is None self.__target = target self.__args = args self.__kwargs = kwargs if not name: import threading2 name = threading2._newname() current = current_thread() self.__dict__['daemon'] = current.daemon self.__dict__['name'] = name self.__thread = pm.PythonThread(self.run, None, name, name) threadId = _thread._add_thread(self.__thread, weakref.proxy(self)) self.__dict__['ident'] = threadId def __del__(self): # On interpreter shutdown, the _thread module might have # already been cleaned up. if _thread and _thread._remove_thread_id: _thread._remove_thread_id(self.ident) def start(self): if self.__thread.isStarted(): raise RuntimeError if not self.__thread.start(pm.TPNormal, True): raise RuntimeError def run(self): if _settrace_func: _sys.settrace(_settrace_func) if _setprofile_func: _sys.setprofile(_setprofile_func) self.__target(*self.__args, **self.__kwargs) def join(self, timeout = None): # We don't support a timed join here, sorry. assert timeout is None self.__thread.join() self.__thread = None def setName(self, name): self.__dict__['name'] = name self.__thread.setName(name) class ExternalThread(ThreadBase): """ Returned for a Thread object that wasn't created by this interface. """ def __init__(self, extThread, threadId): ThreadBase.__init__(self) self.__thread = extThread self.__dict__['daemon'] = True self.__dict__['name'] = self.__thread.getName() self.__dict__['ident'] = threadId def start(self): raise RuntimeError def run(self): raise RuntimeError def join(self, timeout = None): raise RuntimeError def setDaemon(self, daemon): raise RuntimeError class MainThread(ExternalThread): """ Returned for the MainThread object. """ def __init__(self, extThread, threadId): ExternalThread.__init__(self, extThread, threadId) self.__dict__['daemon'] = False class Lock(pm.Mutex): """ This class provides a wrapper around Panda's Mutex object. The wrapper is designed to emulate Python's own threading.Lock object. """ def __init__(self, name = "PythonLock"): pm.Mutex.__init__(self, name) def acquire(self, blocking = True): if blocking: pm.Mutex.acquire(self) return True else: return pm.Mutex.tryAcquire(self) __enter__ = acquire def __exit__(self, t, v, tb): self.release() class RLock(pm.ReMutex): """ This class provides a wrapper around Panda's ReMutex object. The wrapper is designed to emulate Python's own threading.RLock object. """ def __init__(self, name = "PythonRLock"): pm.ReMutex.__init__(self, name) def acquire(self, blocking = True): if blocking: pm.ReMutex.acquire(self) return True else: return pm.ReMutex.tryAcquire(self) __enter__ = acquire def __exit__(self, t, v, tb): self.release() class Condition(pm.ConditionVarFull): """ This class provides a wrapper around Panda's ConditionVarFull object. The wrapper is designed to emulate Python's own threading.Condition object. """ def __init__(self, lock = None): if not lock: lock = Lock() # Panda doesn't support RLock objects used with condition # variables. assert isinstance(lock, Lock) self.__lock = lock pm.ConditionVarFull.__init__(self, self.__lock) def acquire(self, *args, **kw): return self.__lock.acquire(*args, **kw) def release(self): self.__lock.release() def wait(self, timeout = None): if timeout is None: pm.ConditionVarFull.wait(self) else: pm.ConditionVarFull.wait(self, timeout) def notifyAll(self): pm.ConditionVarFull.notifyAll(self) notify_all = notifyAll __enter__ = acquire def __exit__(self, t, v, tb): self.release() class Semaphore(pm.Semaphore): """ This class provides a wrapper around Panda's Semaphore object. The wrapper is designed to emulate Python's own threading.Semaphore object. """ def __init__(self, value = 1): pm.Semaphore.__init__(self, value) def acquire(self, blocking = True): if blocking: pm.Semaphore.acquire(self) return True else: return pm.Semaphore.tryAcquire(self) __enter__ = acquire def __exit__(self, t, v, tb): self.release() class BoundedSemaphore(Semaphore): """ This class provides a wrapper around Panda's Semaphore object. The wrapper is designed to emulate Python's own threading.BoundedSemaphore object. """ def __init__(self, value = 1): self.__max = value Semaphore.__init__(value) def release(self): if self.getCount() > value: raise ValueError Semaphore.release(self) class Event: """ This class is designed to emulate Python's own threading.Event object. """ def __init__(self): self.__lock = pm.Lock("Python Event") self.__cvar = pm.ConditionVarFull(self.__lock) self.__flag = False def is_set(self): return self.__flag isSet = is_set def set(self): self.__lock.acquire() try: self.__flag = True self.__cvar.signalAll() finally: self.__lock.release() def clear(self): self.__lock.acquire() try: self.__flag = False finally: self.__lock.release() def wait(self, timeout = None): self.__lock.acquire() try: if timeout is None: while not self.__flag: self.__cvar.wait() else: clock = pm.TrueClock.getGlobalPtr() expires = clock.getShortTime() + timeout while not self.__flag: wait = expires - clock.getShortTime() if wait < 0: return self.__cvar.wait(wait) finally: self.__lock.release() class Timer(Thread): """Call a function after a specified number of seconds: t = Timer(30.0, f, args=[], kwargs={}) t.start() t.cancel() # stop the timer's action if it's still waiting """ def __init__(self, interval, function, args=[], kwargs={}): Thread.__init__(self) self.interval = interval self.function = function self.args = args self.kwargs = kwargs self.finished = Event() def cancel(self): """Stop the timer if it hasn't finished yet""" self.finished.set() def run(self): self.finished.wait(self.interval) if not self.finished.isSet(): self.function(*self.args, **self.kwargs) self.finished.set() def _create_thread_wrapper(t, threadId): """ Creates a thread wrapper for the indicated external thread. """ if isinstance(t, pm.MainThread): pyt = MainThread(t, threadId) else: pyt = ExternalThread(t, threadId) return pyt def current_thread(): t = pm.Thread.getCurrentThread() return _thread._get_thread_wrapper(t, _create_thread_wrapper) currentThread = current_thread def enumerate(): tlist = [] _thread._threadsLock.acquire() try: for thread, locals, wrapper in _thread._threads.values(): if wrapper and thread.isStarted(): tlist.append(wrapper) return tlist finally: _thread._threadsLock.release() def active_count(): return len(enumerate()) activeCount = active_count _settrace_func = None def settrace(func): global _settrace_func _settrace_func = func _setprofile_func = None def setprofile(func): global _setprofile_func _setprofile_func = func def stack_size(size = None): raise ThreadError def _test(): from collections import deque _sleep = pm.Thread.sleep _VERBOSE = False class _Verbose(object): def __init__(self, verbose=None): if verbose is None: verbose = _VERBOSE self.__verbose = verbose def _note(self, format, *args): if self.__verbose: format = format % args format = "%s: %s\n" % ( currentThread().getName(), format) _sys.stderr.write(format) class BoundedQueue(_Verbose): def __init__(self, limit): _Verbose.__init__(self) self.mon = Lock(name = "BoundedQueue.mon") self.rc = Condition(self.mon) self.wc = Condition(self.mon) self.limit = limit self.queue = deque() def put(self, item): self.mon.acquire() while len(self.queue) >= self.limit: self._note("put(%s): queue full", item) self.wc.wait() self.queue.append(item) self._note("put(%s): appended, length now %d", item, len(self.queue)) self.rc.notify() self.mon.release() def get(self): self.mon.acquire() while not self.queue: self._note("get(): queue empty") self.rc.wait() item = self.queue.popleft() self._note("get(): got %s, %d left", item, len(self.queue)) self.wc.notify() self.mon.release() return item class ProducerThread(Thread): def __init__(self, queue, quota): Thread.__init__(self, name="Producer") self.queue = queue self.quota = quota def run(self): from random import random counter = 0 while counter < self.quota: counter = counter + 1 self.queue.put("%s.%d" % (self.getName(), counter)) _sleep(random() * 0.00001) class ConsumerThread(Thread): def __init__(self, queue, count): Thread.__init__(self, name="Consumer") self.queue = queue self.count = count def run(self): while self.count > 0: item = self.queue.get() print item self.count = self.count - 1 NP = 3 QL = 4 NI = 5 Q = BoundedQueue(QL) P = [] for i in range(NP): t = ProducerThread(Q, NI) t.setName("Producer-%d" % (i+1)) P.append(t) C = ConsumerThread(Q, NI*NP) for t in P: t.start() _sleep(0.000001) C.start() for t in P: t.join() C.join() if __name__ == '__main__': _test()