Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Terminating a subprocess with KeyboardInterrupt

I'm using Python to call a C++ program using the subprocess module. Since the program takes some time to run, I'd like to be able to terminate it using Ctrl+C. I've seen a few questions regarding this on StackOverflow but none of the solutions seem to work for me.

What I would like is for the subprocess to be terminated on KeyboardInterrupt. This is the code that I have (similar to suggestions in other questions):

import subprocess

binary_path = '/path/to/binary'
args = 'arguments' # arbitrary

call_str = '{} {}'.format(binary_path, args)

proc = subprocess.Popen(call_str)

try:
    proc.wait()
except KeyboardInterrupt:
    proc.terminate()

However, if I run this, the code is hung up waiting for the process to end and never registers the KeyboardInterrupt. I have tried the following as well:

import subprocess
import time

binary_path = '/path/to/binary'
args = 'arguments' # arbitrary

call_str = '{} {}'.format(binary_path, args)

proc = subprocess.Popen(call_str)
time.sleep(5)
proc.terminate()

This code snippet works fine at terminating the program, so it's not the actual signal that's being sent to terminate that is the problem.

How can I change the code so that the subprocess can be terminated on KeyboardInterrupt?

I'm running Python 2.7 and Windows 7 64-bit. Thanks in advance!

Some related questions that I tried:

Python sub process Ctrl+C

Kill subprocess.call after KeyboardInterrupt

kill subprocess when python process is killed?

like image 677
limi44 Avatar asked Sep 14 '16 21:09

limi44


2 Answers

I figured out a way to do this, similar to Jean-Francois's answer with the loop but without the multiple threads. The key is to use Popen.poll() to determine if the subprocess has finished (will return None if still running).

import subprocess
import time

binary_path = '/path/to/binary'
args = 'arguments' # arbitrary

call_str = '{} {}'.format(binary_path, args)

proc = subprocess.Popen(call_str)

try:
    while proc.poll() is None:
        time.sleep(0.1)

except KeyboardInterrupt:
    proc.terminate()
    raise

I added an additional raise after KeyboardInterrupt so the Python program is also interrupted in addition to the subprocess.

EDIT: Changed pass to time.sleep(0.1) as per eryksun's comment to reduce CPU consumption.

like image 88
limi44 Avatar answered Oct 27 '22 00:10

limi44


My ugly but successfull attempt on Windows:

import subprocess
import threading

import time

binary_path = 'notepad'
args = 'foo.txt' # arbitrary

proc = None
done = False

def s():
    call_str = '{} {}'.format(binary_path, args)
    global done
    global proc
    proc = subprocess.Popen(call_str,stdout=subprocess.PIPE)
    proc.wait()
    done = True


t = threading.Thread(target=s)
t.start()


try:
    while not done:
        time.sleep(0.1)

except KeyboardInterrupt:
    print("terminated")
    proc.terminate()

Create a thread where the subprocess runs. Export the proc variable.

Then wait forever in a non-active loop. When CTRL+C is pressed, the exception is triggered. Inter-process communication (ex: proc.wait()) is conflicting with CTRL+C handling otherwise. When running in a thread, no such issue.

note: I have tried to avoid this time loop using threading.lock() but stumbled on the same CTRL+C ignore.

like image 34
Jean-François Fabre Avatar answered Oct 27 '22 00:10

Jean-François Fabre