Task

Base class for tasks.

class TaskKit.Task.Task

Bases: object

Abstract base class from which you have to derive your own tasks.

__init__()

Subclasses should invoke super for this method.

handle()

Return the task handle.

A task is scheduled by wrapping a handler around it. It knows everything about the scheduling (periodicity and the like). Under normal circumstances you should not need the handler, but if you want to write period modifying run() methods, it is useful to have access to the handler. Use it with care.

name()

Return the unique name under which the task was scheduled.

proceed()

Check whether this task should continue running.

Should be called periodically by long tasks to check if the system wants them to exit. Returns True if its OK to continue, False if it’s time to quit.

run()

Override this method for you own tasks.

Long running tasks can periodically use the proceed() method to check if a task should stop.