37
votes

I've seen a lot of Python scripts that use Threads in a class and a lot of them use the threading.Event(). For example:

class TimerClass(threading.Thread):
    def __init__(self):
        threading.Thread.__init__(self)
        self.event = threading.Event()

    def run(self):
        while not self.event.is_set():
            print "something"
            self.event.wait(120)

In the while loop, why do they check the condition if they don't set self.event?

1
More correct probably: while not self.event.wait(120): print "something" - Mr_and_Mrs_D
@Mr_and_Mrs_D If this is (more) correct can't be determined unless you know it is really okay to wait before the print. If the Thread should do the first print or whatever work immediately after starting the thread then it is incorrect to wait in the while condition expression. - BlackJack

1 Answers

48
votes

Because someone else will set it.

You generally start a thread in one part of your application and continue to do whatever you do:

thread = TimerClass()
thread.start()
# Do your stuff

The thread does it's stuff, while you do your stuff. If you want to terminate the thread you just call:

thread.event.set()

And the thread will stop.

So the answer is: event, in this case, is not used for controlling the thread from inside the thread object itself. It is used for controlling the thread from outside (from the object which holds the reference to the thread).