StopperThread

class privex.helpers.thread.StopperThread(*args, default_stop=False, default_pause=False, stop_events=None, pause_events=None, **kwargs)[source]

A threading.Thread thread sub-class which implements BetterEvent events allowing you to signal the thread when you want it to shutdown or pause.

You must check should_stop / should_run and should_pause within your thread run body to detect when your thread needs to shutdown / pause.

__init__(*args, default_stop=False, default_pause=False, stop_events=None, pause_events=None, **kwargs)[source]

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.

Methods

Methods

__init__(*args[, default_stop, …])

This constructor should always be called with keyword arguments.

emit_pause()

emit_start()

emit_stop()

emit_unpause()

Attributes

Attributes

should_pause

should_run

should_stop