views:

335

answers:

2

How to make a multi-thread python program response to Ctrl+C key event?

Edit: The code is like this:

import threading
current = 0

class MyThread(threading.Thread):
    def __init__(self, total):
        threading.Thread.__init__(self)
        self.total = total

    def stop(self):
        self._Thread__stop()

    def run(self):
        global current
        while current<self.total:
            lock = threading.Lock()
            lock.acquire()
            current+=1
            lock.release()
            print current

if __name__=='__main__':

    threads = []
    thread_count = 10
    total = 10000
    for i in range(0, thread_count):
        t = MyThread(total)
        t.setDaemon(True)
        threads.append(t)
    for i in range(0, thread_count):
        threads[i].start()

I tried to remove join() on all threads but it still doesn't work. Is it because the lock segment inside each thread's run() procedure?

Edit: The above code is supposed to work but it always interrupted when current variable was in 5,000-6,000 range and through out the errors as below

Exception in thread Thread-4 (most likely raised during interpreter shutdown):
Traceback (most recent call last):
  File "/usr/lib/python2.5/threading.py", line 486, in __bootstrap_inner
  File "test.py", line 20, in run
<type 'exceptions.TypeError'>: unsupported operand type(s) for +=: 'NoneType' and 'int'
Exception in thread Thread-2 (most likely raised during interpreter shutdown):
Traceback (most recent call last):
  File "/usr/lib/python2.5/threading.py", line 486, in __bootstrap_inner
  File "test.py", line 22, in run
+4  A: 

Make every thread except the main one a daemon (t.daemon = True in 2.6 or better, t.setDaemon(True) in 2.6 or less, for every thread object t before you start it). That way, when the main thread receives the KeyboardInterrupt, if it doesn't catch it or catches it but decided to terminate anyway, the whole process will terminate. See the docs.

edit: having just seen the OP's code (not originally posted) and the claim that "it doesn't work", it appears I have to add...:

Of course, if you want your main thread to stay responsive (e.g. to control-C), don't mire it into blocking calls, such as joining another thread -- especially not totally useless blocking calls, such as joining daemon threads. For example, just change the final loop in the main thread from the current (utterless and damaging):

for i in range(0, thread_count):
    threads[i].join()

to something more sensible like:

while threading.active_count() > 0:
    time.sleep(0.1)

if your main has nothing better to do than either for all threads to terminate on their own, or for a control-C (or other signal) to be received.

Of course, there are many other usable patterns if you'd rather have your threads not terminate abruptly (as daemonic threads may) -- unless they, too, are mired forever in unconditionally-blocking calls, deadlocks, and the like;-).

Alex Martelli
thanks for your answer but it doesn't work in my code.
jack
Ah, you're making a (useless) blocking call -- so of course there's no response to control-C. The solution is pretty simple: just **don't** make useless blocking calls if you want to stay responsive. Let me edit my answer to explain.
Alex Martelli
i supplemented more code in original post. I tried your method, it can detect KeyboardInterrupt event but main program just doesn't quit. Is it caused by the lock segment inside each thread's run() procedure?
jack
@Alex: `Thread.join()` has optional `timeout` parameter. Isn't it better than `sleep()`?
Denis Otkidach
@jack, the code you now give terminates immediately (of course, because the main thread "falls off the end" and that ends everything). So it can't be at all close to what you're actually trying and it's clear you haven't even tried the code you're posting; makes it really hard to help you! Please post code that you HAVE tried and DOES reproduce the issue you're having, so I can show you where your bug is in that code, instead of trying to guess what bugs your unseen code might perhaps have.
Alex Martelli
@Denis, in the code I posted, the time.sleep calls in main are just whiling time away because by assumption there's nothing to do but twiddle thumbs until all thread terminate or a control=C arrives. a t.join with a very short timeout would just be a somewhat more expensive way to twiddle thumbs, one with a long timeout would hurt responsitivity to control=C, so, what's the point?
Alex Martelli
@Alex, I did tried the code, the threads were even unable to complete. I appended the errors it through out.
jack
@jack, as I already mentioned, if that's your code then your main bug now is that "the main thread "falls off the end" and that ends everything". Try the code I've already given above: `while threading.active_count() > 0: time.sleep(0.1)` -- why make me repeat this?! You can do better (the `while` in the thread should `and` a global flag so it can be stopped cleanly) but you have pther horrible bugs to fix first: they include acquire/release on a lock that's a new local variable, which is just the same as no locking, instead of a lock shared by all threads.
Alex Martelli
+2  A: 

There're two main ways, one clean and one easy.

The clean way is to catch KeyboardInterrupt in your main thread, and set a flag your background threads can check so they know to exit; here's a simple/slightly-messy version using a global:

exitapp = False
if __name__ == '__main__':
    try:
        main()
    except KeyboardInterrupt:
        exitapp = True
        raise

def threadCode(...):
    while not exitapp:
        # do work here, watch for exitapp to be True

The messy but easy way is to catch KeyboardInterrupt and call os._exit(), which terminates all threads immediately.

Walter Mundt
Thanks a lot, this was bugging me intensely :)
Emil Stenström