462

I'm launching a subprocess with the following command:

p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)

However, when I try to kill using:

p.terminate()

or

p.kill()

The command keeps running in the background, so I was wondering how can I actually terminate the process.

Note that when I run the command with:

p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)

It does terminate successfully when issuing the p.terminate().

3
  • What does your cmd look like? It might contain a command which triggers several processes to be started. So it’s not clear which process you talk about. Commented Nov 27, 2014 at 15:47
  • 2
    related: Python: how to kill child process(es) when parent dies? Commented Jan 23, 2015 at 15:08
  • 4
    does not having shell=True make a big difference? Commented Mar 7, 2019 at 19:46

11 Answers 11

569

Use a process group so as to enable sending a signal to all the process in the groups. For that, you should attach a session id to the parent process of the spawned/child processes, which is a shell in your case. This will make it the group leader of the processes. So now, when a signal is sent to the process group leader, it's transmitted to all of the child processes of this group.

Here's the code:

import os
import signal
import subprocess

# The os.setsid() is passed in the argument preexec_fn so
# it's run after the fork() and before  exec() to run the shell.
pro = subprocess.Popen(cmd, stdout=subprocess.PIPE, 
                       shell=True, preexec_fn=os.setsid) 

os.killpg(os.getpgid(pro.pid), signal.SIGTERM)  # Send the signal to all the process groups
Sign up to request clarification or add additional context in comments.

18 Comments

How does subprocess.CREATE_NEW_PROCESS_GROUP relate to this?
our testing sugggests that setsid != setpgid, and that os.pgkill only kills subprocesses that still have the same process group id. processes that have changed process group are not killed, even though they may still have the same session id...
I would not recommend doing os.setsid(), since it has other effects as well. Among others, it disconnects the controlling TTY and makes the new process a process group leader. See win.tue.nl/~aeb/linux/lk/lk-10.html
How would you do this in Windows? setsid is only available on *nix systems.
|
150
p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
p.kill()

p.kill() ends up killing the shell process and cmd is still running.

I found a convenient fix this by:

p = subprocess.Popen("exec " + cmd, stdout=subprocess.PIPE, shell=True)

This will cause cmd to inherit the shell process, instead of having the shell launch a child process, which does not get killed. p.pid will be the id of your cmd process then.

p.kill() should work.

I don't know what effect this will have on your pipe though.

7 Comments

Nice and light solution for *nix, thanks! Works on Linux, should work for Mac as well.
Very nice solution. If your cmd happens to be a shell script wrapper for something else, do call the final binary there with exec too in order to have only one subprocess.
This is beautiful. I have been trying to figure out how to spawn and kill a subprocess per workspace on Ubuntu. This answer helped me. Wish i could upvote it more than once
this doesn't work if a semi-colon is used in the cmd
@speedyrazor - Does not work on Windows10. I think os specific answers should be clearly marked as such.
|
104

If you can use psutil, then this works perfectly:

import subprocess

import psutil


def kill(proc_pid):
    process = psutil.Process(proc_pid)
    for proc in process.children(recursive=True):
        proc.kill()
    process.kill()


proc = subprocess.Popen(["infinite_app", "param"], shell=True)
try:
    proc.wait(timeout=3)
except subprocess.TimeoutExpired:
    kill(proc.pid)

7 Comments

AttributeError: 'Process' object has no attribute 'get_children for pip install psutil.
I think get_children() should be children(). But it did not work for me on Windows, the process is still there.
@Godsmith - psutil API has changed and you're right: children() does the same thing as get_children() used to. If it doesn't work on Windows, then you might want to create a bug ticket in GitHub
this does not work if child X creates child SubX during calling proc.kill() for child A
For some reason the other solutions would not work for me after many attempts, but this one did!!
|
43

I could do it using

from subprocess import Popen

process = Popen(command, shell=True)
Popen("TASKKILL /F /PID {pid} /T".format(pid=process.pid))

it killed the cmd.exe and the program that i gave the command for.

(On Windows)

1 Comment

Or use the process name: Popen("TASKKILL /F /IM " + process_name), if you don't have it, you can get it from the command parameter.
21

When shell=True the shell is the child process, and the commands are its children. So any SIGTERM or SIGKILL will kill the shell but not its child processes, and I don't remember a good way to do it. The best way I can think of is to use shell=False, otherwise when you kill the parent shell process, it will leave a defunct shell process.

1 Comment

In order to avoid zombie processes one can terminate the process then wait and then poll the process to be sure that they are terminated, as described by "@SomeOne Maybe" in the following stackoverflow answer: stackoverflow.com/questions/2760652/…
20

None of these answers worked for me so I'm leaving the code that did work. In my case even after killing the process with .kill() and getting a .poll() return code the process didn't terminate.

Following the subprocess.Popen documentation:

"...in order to cleanup properly a well-behaved application should kill the child process and finish communication..."

proc = subprocess.Popen(...)
try:
    outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
    proc.kill()
    outs, errs = proc.communicate()

In my case I was missing the proc.communicate() after calling proc.kill(). This cleans the process stdin, stdout ... and does terminate the process.

5 Comments

This solution doesn't work for me in linux and python 2.7
@xyz It did work for me in Linux and python 3.5. Check the docs for python 2.7
@espinal, thanks, yes. It's possibly a linux issue. It's Raspbian linux running on a Raspberry 3
@mouad and Bryant answers are ok in my case if you use as you said the communicate after calling kill. Thanks.
This worked for me in Linux
9

As Sai said, the shell is the child, so signals are intercepted by it -- best way I've found is to use shell=False and use shlex to split the command line:

if isinstance(command, unicode):
    cmd = command.encode('utf8')
args = shlex.split(cmd)

p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)

Then p.kill() and p.terminate() should work how you expect.

4 Comments

In my case it doesn't really help given that cmd is "cd path && zsync etc etc". So that actually makes the command to fail!
Use absolute paths instead of changing directories... Optionally os.chdir(...) to that directory...
The ability to change the working directory for the child process is built-in. Just pass the cwd argument to Popen.
I used shlex, but still the issue persists, kill is not killing the child processes.
4

There is a very simple way for Python 3.5+ (actually tested on Python 3.8).

import subprocess, signal, time
p = subprocess.Popen(['cmd'], shell=True)
time.sleep(5) #Wait 5 secs before killing
p.send_signal(signal.CTRL_C_EVENT)

Then, your code may crash at some point if you have a keyboard input detection, or something like this. In this case, on the line of code/function where the error is given, just use:

try:
    FailingCode #here goes the code which is raising KeyboardInterrupt
except KeyboardInterrupt:
    pass

What this code is doing is just sending a "CTRL+C" signal to the running process, what will cause the process to get killed.

1 Comment

Note: this is Wndows-specific. There is no CTRL_C_EVENT defined in Mac or Linux implementations of signal. Some alternative code (which I have not tested) can be found here.
3

Send the signal to all the processes in group

    self.proc = Popen(commands, 
            stdout=PIPE, 
            stderr=STDOUT, 
            universal_newlines=True, 
            preexec_fn=os.setsid)

    os.killpg(os.getpgid(self.proc.pid), signal.SIGHUP)
    os.killpg(os.getpgid(self.proc.pid), signal.SIGTERM)

Comments

1

Solution that worked for me

if os.name == 'nt':  # windows
    subprocess.Popen("TASKKILL /F /PID {pid} /T".format(pid=process.pid))
else:
    os.kill(process.pid, signal.SIGTERM)

Comments

1

Full blown solution that will kill running process (including subtree) on timeout reached or specific conditions via a callback function. Works both on windows & Linux, from Python 2.7 up to 3.12, and pypy 3.6 to pypy 3.10 as of this writing, see https://github.com/netinvent/command_runner for more info

Install with pip install command_runner

Example for timeout:

from command_runner import command_runner

# Kills ping after 2 seconds
exit_code, output = command_runner('ping 127.0.0.1', shell=True, timeout=2)

Example for specific condition: Here we'll stop ping if current system time seconds digit is > 5

from time import time
from command_runner import command_runner

def my_condition():
    # Arbitrary condition for demo
    return True if int(str(int(time()))[-1]) > 5

# Calls my_condition() every second (check_interval) and kills ping if my_condition() returns True
exit_code, output = command_runner('ping 127.0.0.1', shell=True, stop_on=my_condition, check_interval=1)

2 Comments

For anyone getting this far down, command_runner uses psutil for this. The answer by @Jovik (stackoverflow.com/a/25134985/6831393) is a trimmed-down version of this.
Indeed, command_runner uses psutil. But it's code a bit more complex, using signals in order to avoid race conditions when using pids, and being 100% platform agnostic. Sure, the code can be trimmed down, but it will be less portable and more error prone.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.