sched.py 4.43 KB
Newer Older
1
"""A generally useful event scheduler class.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

Each instance of this class manages its own queue.
No multi-threading is implied; you are supposed to hack that
yourself, or use a single instance per application.

Each instance is parametrized with two functions, one that is
supposed to return the current time, one that is supposed to
implement a delay.  You can implement real-time scheduling by
substituting time and sleep from built-in module time, or you can
implement simulated time by writing your own functions.  This can
also be used to integrate scheduling with STDWIN events; the delay
function is allowed to modify the queue.  Time can be expressed as
integers or floating point numbers, as long as it is consistent.

Events are specified by tuples (time, priority, action, argument).
As in UNIX, lower priority numbers mean higher priority; in this
Raymond Hettinger's avatar
Raymond Hettinger committed
18
way the queue can be maintained as a priority queue.  Execution of the
19 20 21 22 23 24
event means calling the action function, passing it the argument.
Remember that in Python, multiple function arguments can be packed
in a tuple.   The action function may be an instance method so it
has another way to reference private data (besides global variables).
Parameterless functions or methods cannot be used, however.
"""
Guido van Rossum's avatar
Guido van Rossum committed
25

26 27 28
# XXX The timefunc and delayfunc should have been defined as methods
# XXX so you can define new kinds of schedulers using subclassing
# XXX instead of having to define a module or class just to hold
29
# XXX the global state of your particular time and delay functions.
30

Raymond Hettinger's avatar
Raymond Hettinger committed
31
import heapq
32

33 34
__all__ = ["scheduler"]

Guido van Rossum's avatar
Guido van Rossum committed
35
class scheduler:
36 37 38 39 40 41 42 43 44 45
    def __init__(self, timefunc, delayfunc):
        """Initialize a new instance, passing the time and delay
        functions"""
        self.queue = []
        self.timefunc = timefunc
        self.delayfunc = delayfunc

    def enterabs(self, time, priority, action, argument):
        """Enter a new event in the queue at an absolute time.

Tim Peters's avatar
Tim Peters committed
46 47
        Returns an ID for the event which can be used to remove it,
        if necessary.
48

Tim Peters's avatar
Tim Peters committed
49
        """
50
        event = time, priority, action, argument
Raymond Hettinger's avatar
Raymond Hettinger committed
51
        heapq.heappush(self.queue, event)
52 53 54 55 56
        return event # The ID

    def enter(self, delay, priority, action, argument):
        """A variant that specifies the time as a relative time.

Tim Peters's avatar
Tim Peters committed
57
        This is actually the more commonly used interface.
58

Tim Peters's avatar
Tim Peters committed
59
        """
60 61 62 63 64 65
        time = self.timefunc() + delay
        return self.enterabs(time, priority, action, argument)

    def cancel(self, event):
        """Remove an event from the queue.

Tim Peters's avatar
Tim Peters committed
66 67
        This must be presented the ID as returned by enter().
        If the event is not in the queue, this raises RuntimeError.
68

Tim Peters's avatar
Tim Peters committed
69
        """
70
        self.queue.remove(event)
Raymond Hettinger's avatar
Raymond Hettinger committed
71
        heapq.heapify(self.queue)
72 73 74

    def empty(self):
        """Check whether the queue is empty."""
Raymond Hettinger's avatar
Raymond Hettinger committed
75
        return not not self.queue
76 77 78

    def run(self):
        """Execute events until the queue is empty.
Tim Peters's avatar
Tim Peters committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

        When there is a positive delay until the first event, the
        delay function is called and the event is left in the queue;
        otherwise, the event is removed from the queue and executed
        (its action function is called, passing it the argument).  If
        the delay function returns prematurely, it is simply
        restarted.

        It is legal for both the delay function and the action
        function to to modify the queue or to raise an exception;
        exceptions are not caught but the scheduler's state remains
        well-defined so run() may be called again.

        A questionably hack is added to allow other threads to run:
        just after an event is executed, a delay of 0 is executed, to
        avoid monopolizing the CPU when other threads are also
        runnable.

        """
Raymond Hettinger's avatar
Raymond Hettinger committed
98 99
        # localize variable access to minimize overhead
        # and to improve thread safety
100
        q = self.queue
Raymond Hettinger's avatar
Raymond Hettinger committed
101 102 103
        delayfunc = self.delayfunc
        timefunc = self.timefunc
        pop = heapq.heappop
104
        while q:
Raymond Hettinger's avatar
Raymond Hettinger committed
105 106
            time, priority, action, argument = checked_event = q[0]
            now = timefunc()
107
            if now < time:
Raymond Hettinger's avatar
Raymond Hettinger committed
108
                delayfunc(time - now)
109
            else:
Raymond Hettinger's avatar
Raymond Hettinger committed
110 111 112 113 114 115 116 117
                event = pop(q)
                # Verify that the event was not removed or altered
                # by another thread after we last looked at q[0].
                if event is checked_event:
                    void = action(*argument)
                    delayfunc(0)   # Let other threads run
                else:
                    heapq.heappush(event)