jztools.parallelization.threading.util#

Classes

RepeatTimer(action[, interval])

Runs an action every interval seconds, and stops after finishing the currently executing action if stop() is called

Exceptions

LoopExitRequested([sources])

This exception is raised by *_loop functiones (e.g., get_loop(), put_loop(), wait_for_loop()) to signal that the main thread has set the exit event.

ThreadWorkerError([msg])

Can be used by the main thread to signal that a thread error occurred.

exception jztools.parallelization.threading.util.LoopExitRequested(sources=None)#

Bases: Exception

This exception is raised by *_loop functiones (e.g., get_loop(), put_loop(), wait_for_loop()) to signal that the main thread has set the exit event.

exception jztools.parallelization.threading.util.ThreadWorkerError(msg='Error detected in worker thread!')#

Bases: Exception

Can be used by the main thread to signal that a thread error occurred.

class jztools.parallelization.threading.util.RepeatTimer(action, interval=1)#

Bases: Thread

Runs an action every interval seconds, and stops after finishing the currently executing action if stop() is called

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run()#

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.