7.5.7 Timer Objects

7.5.7 Timer Objects

This class represents an action that should be run only after a certain amount of time has passed -- a timer. Timer is a subclass of Thread and as such also functions as an example of creating custom threads.

Timers are started, as with threads, by calling their start() method. The timer can be stopped (before its action has begun) by calling the cancel() method. The interval the timer will wait before executing its action may not be exactly the same as the interval specified by the user.

For example:

def hello():
    print "hello, world"

t = Timer(30.0, hello)
t.start() # after 30 seconds, "hello, world" will be printed

class Timer(

interval, function, args=[], kwargs={})

Create a timer that will run function with arguments args and keyword arguments kwargs, after interval seconds have passed.

cancel(

)

Stop the timer, and cancel the execution of the timer's action. This will only work if the timer is still in its waiting stage.

---

Python Library Reference

Previous: 7.5.6 Thread Objects Up: 7.5 threading Next: 7.6 dummy_thread

---

Release 2.4, documentation updated on 29 November 2004.