Использование модуля "подпроцесс" с таймаутом
Вот код Python для запуска произвольной команды, возвращающей stdout данные, или вызовите исключение для ненулевых кодов выхода:
proc = subprocess.Popen(
cmd,
stderr=subprocess.STDOUT, # Merge stdout and stderr
stdout=subprocess.PIPE,
shell=True)
communicate используется для ожидания завершения процесса:
stdoutdata, stderrdata = proc.communicate()
subprocess модуль не поддерживает тайм-аут - возможность убить процесс, выполняющийся более чем на X секунд, поэтому communicate может потребоваться вечность, чтобы бежать.
Как проще всего реализовать таймауты в программе на Python, предназначенной для работы в Windows и Linux?
33 ответа
В Python 3.3+:
from subprocess import STDOUT, check_output
output = check_output(cmd, stderr=STDOUT, timeout=seconds)
output является байтовой строкой, которая содержит объединенный стандартный вывод команды stderr.
Этот код повышает CalledProcessError на ненулевой статус выхода, как указано в тексте вопроса в отличие proc.communicate() метод.
Я удалил shell=True потому что это часто используется без необходимости. Вы всегда можете добавить его обратно, если cmd действительно требует этого. Если вы добавите shell=True то есть, если дочерний процесс порождает своих потомков; check_output() может вернуться намного позже, чем указано в тайм-ауте, см. Ошибка тайм-аута подпроцесса.
Функция тайм-аута доступна в Python 2.x через subprocess32 Бэкпорт модуля 3.2+ подпроцесса.
Я не знаю много о деталях низкого уровня; но, учитывая, что в python 2.6 API предлагает возможность ждать потоков и завершать процессы, как насчет запуска процесса в отдельном потоке?
import subprocess, threading
class Command(object):
def __init__(self, cmd):
self.cmd = cmd
self.process = None
def run(self, timeout):
def target():
print 'Thread started'
self.process = subprocess.Popen(self.cmd, shell=True)
self.process.communicate()
print 'Thread finished'
thread = threading.Thread(target=target)
thread.start()
thread.join(timeout)
if thread.is_alive():
print 'Terminating process'
self.process.terminate()
thread.join()
print self.process.returncode
command = Command("echo 'Process started'; sleep 2; echo 'Process finished'")
command.run(timeout=3)
command.run(timeout=1)
Вывод этого фрагмента в моей машине:
Thread started
Process started
Process finished
Thread finished
0
Thread started
Process started
Terminating process
Thread finished
-15
где видно, что при первом выполнении процесс завершился правильно (код возврата 0), а во втором процессе был завершен (код возврата -15).
Я не проверял в Windows; но, помимо обновления примера команды, я думаю, что она должна работать, так как я не нашел в документации ничего, что говорит, что thread.join или process.terminate не поддерживаются.
Ответ jcollado может быть упрощен с помощью класса threading.Timer:
import shlex
from subprocess import Popen, PIPE
from threading import Timer
def run(cmd, timeout_sec):
proc = Popen(shlex.split(cmd), stdout=PIPE, stderr=PIPE)
timer = Timer(timeout_sec, proc.kill)
try:
timer.start()
stdout, stderr = proc.communicate()
finally:
timer.cancel()
# Examples: both take 1 second
run("sleep 1", 5) # process ends normally at 1 second
run("sleep 5", 1) # timeout happens at 1 second
Если вы на Unix,
import signal
...
class Alarm(Exception):
pass
def alarm_handler(signum, frame):
raise Alarm
signal.signal(signal.SIGALRM, alarm_handler)
signal.alarm(5*60) # 5 minutes
try:
stdoutdata, stderrdata = proc.communicate()
signal.alarm(0) # reset the alarm
except Alarm:
print "Oops, taking too long!"
# whatever else
Вот решение Алекса Мартелли как модуля с надлежащим процессом убийства. Другие подходы не работают, потому что они не используют proc.communicate(). Поэтому, если у вас есть процесс, который производит много выходных данных, он заполнит свой выходной буфер и затем заблокируется, пока вы не прочитаете что-то из него.
from os import kill
from signal import alarm, signal, SIGALRM, SIGKILL
from subprocess import PIPE, Popen
def run(args, cwd = None, shell = False, kill_tree = True, timeout = -1, env = None):
'''
Run a command with a timeout after which it will be forcibly
killed.
'''
class Alarm(Exception):
pass
def alarm_handler(signum, frame):
raise Alarm
p = Popen(args, shell = shell, cwd = cwd, stdout = PIPE, stderr = PIPE, env = env)
if timeout != -1:
signal(SIGALRM, alarm_handler)
alarm(timeout)
try:
stdout, stderr = p.communicate()
if timeout != -1:
alarm(0)
except Alarm:
pids = [p.pid]
if kill_tree:
pids.extend(get_process_children(p.pid))
for pid in pids:
# process might have died before getting to this line
# so wrap to avoid OSError: no such process
try:
kill(pid, SIGKILL)
except OSError:
pass
return -9, '', ''
return p.returncode, stdout, stderr
def get_process_children(pid):
p = Popen('ps --no-headers -o pid --ppid %d' % pid, shell = True,
stdout = PIPE, stderr = PIPE)
stdout, stderr = p.communicate()
return [int(p) for p in stdout.split()]
if __name__ == '__main__':
print run('find /', shell = True, timeout = 3)
print run('find', shell = True)
Я не знаю, почему это не упоминается, но начиная с Python 3.5, есть новый subprocess.run универсальная команда (которая предназначена для замены check_call, check_output...) и который имеет timeout параметр также.
subprocess.run (args, *, stdin = Нет, ввод = Нет, stdout = Нет, stderr = Нет, shell=False, cwd= Нет, тайм-аут = Нет, проверка = Ложь, кодировка = Нет, ошибки = Нет)
Run the command described by args. Wait for command to complete, then return a CompletedProcess instance.
Это поднимает subprocess.TimeoutExpired исключение по истечении времени ожидания.
timeout теперь поддерживается call() а также communicate() в модуле подпроцесса (по состоянию на Python3.3):
import subprocess
subprocess.call("command", timeout=20, shell=True)
Это вызовет команду и вызовет исключение
subprocess.TimeoutExpired
если команда не заканчивается через 20 секунд.
Затем вы можете обработать исключение, чтобы продолжить ваш код, например:
try:
subprocess.call("command", timeout=20, shell=True)
except subprocess.TimeoutExpired:
# insert code here
Надеюсь это поможет.
Удивил, что никто не упомянул timeout
timeout 5 ping -c 3 somehost
Это не будет работать для каждого варианта использования, но если вы работаете с простым сценарием, это трудно победить.
Также доступно как gtimeout в coreutils через homebrew для пользователей Mac.
Я изменил ответ sussudio. Теперь функция возвращает:(returncode, stdout, stderr, timeout) - stdout а также stderr декодируется в строку utf-8
def kill_proc(proc, timeout):
timeout["value"] = True
proc.kill()
def run(cmd, timeout_sec):
proc = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
timeout = {"value": False}
timer = Timer(timeout_sec, kill_proc, [proc, timeout])
timer.start()
stdout, stderr = proc.communicate()
timer.cancel()
return proc.returncode, stdout.decode("utf-8"), stderr.decode("utf-8"), timeout["value"]
Другой вариант - записать во временный файл, чтобы предотвратить блокировку stdout вместо необходимости опроса с connect (). Это сработало для меня, где другие ответы не сделали; например на окнах.
outFile = tempfile.SpooledTemporaryFile()
errFile = tempfile.SpooledTemporaryFile()
proc = subprocess.Popen(args, stderr=errFile, stdout=outFile, universal_newlines=False)
wait_remaining_sec = timeout
while proc.poll() is None and wait_remaining_sec > 0:
time.sleep(1)
wait_remaining_sec -= 1
if wait_remaining_sec <= 0:
killProc(proc.pid)
raise ProcessIncompleteError(proc, timeout)
# read temp streams from start
outFile.seek(0);
errFile.seek(0);
out = outFile.read()
err = errFile.read()
outFile.close()
errFile.close()
Предварительная команда Linux timeout неплохой обходной путь, и он сработал для меня.
cmd = "timeout 20 "+ cmd
subprocess.Popen(cmd.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
(output, err) = p.communicate()
Я добавил решение с резьбой из jcollado к моему модулю Python easyprocess.
Установка:
pip install easyprocess
Пример:
from easyprocess import Proc
# shell is not supported!
stdout=Proc('ping localhost').call(timeout=1.5).stdout
print stdout
Вот мое решение, я использовал Thread и Event:
import subprocess
from threading import Thread, Event
def kill_on_timeout(done, timeout, proc):
if not done.wait(timeout):
proc.kill()
def exec_command(command, timeout):
done = Event()
proc = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
watcher = Thread(target=kill_on_timeout, args=(done, timeout, proc))
watcher.daemon = True
watcher.start()
data, stderr = proc.communicate()
done.set()
return data, stderr, proc.returncode
В бою:
In [2]: exec_command(['sleep', '10'], 5)
Out[2]: ('', '', -9)
In [3]: exec_command(['sleep', '10'], 11)
Out[3]: ('', '', 0)
Решением, которое я использую, является префикс команды оболочки с ограничением по времени. Если команда занимает слишком много времени, timelimit остановит его, и Popen получит код возврата, установленный timelimit. Если это> 128, это означает, что ограничение по времени убило процесс.
Смотрите также подпроцесс python с тайм-аутом и большим выводом (>64K)
Если вы используете Python 2, попробуйте
import subprocess32
try:
output = subprocess32.check_output(command, shell=True, timeout=3)
except subprocess32.TimeoutExpired as e:
print e
Я реализовал то, что я мог собрать из нескольких из них. Это работает в Windows, и так как это вики сообщества, я думаю, я бы тоже поделился своим кодом:
class Command(threading.Thread):
def __init__(self, cmd, outFile, errFile, timeout):
threading.Thread.__init__(self)
self.cmd = cmd
self.process = None
self.outFile = outFile
self.errFile = errFile
self.timed_out = False
self.timeout = timeout
def run(self):
self.process = subprocess.Popen(self.cmd, stdout = self.outFile, \
stderr = self.errFile)
while (self.process.poll() is None and self.timeout > 0):
time.sleep(1)
self.timeout -= 1
if not self.timeout > 0:
self.process.terminate()
self.timed_out = True
else:
self.timed_out = False
Затем из другого класса или файла:
outFile = tempfile.SpooledTemporaryFile()
errFile = tempfile.SpooledTemporaryFile()
executor = command.Command(c, outFile, errFile, timeout)
executor.daemon = True
executor.start()
executor.join()
if executor.timed_out:
out = 'timed out'
else:
outFile.seek(0)
errFile.seek(0)
out = outFile.read()
err = errFile.read()
outFile.close()
errFile.close()
Пример захваченного вывода после тайм-аута, протестированного в Python 3.7.8:
try:
return subprocess.run(command, shell=True, capture_output=True, timeout=20, cwd=cwd, universal_newlines=True)
except subprocess.TimeoutExpired as e:
print(e.output.decode(encoding="utf-8", errors="ignore"))
assert False;
Исключение subprocess.TimeoutExpired имеет вывод и другие члены:
cmd - команда, которая использовалась для создания дочернего процесса.
timeout - Тайм-аут в секундах.
output - Вывод дочернего процесса, если он был захвачен run() или check_output(). В противном случае - Нет.
stdout - Псевдоним для вывода, для симметрии со stderr.
stderr - вывод дочернего процесса на Stderr, если он был захвачен run(). В противном случае - Нет.
Дополнительная информация: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired
Python 2.7
import time
import subprocess
def run_command(cmd, timeout=0):
start_time = time.time()
df = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
while timeout and df.poll() == None:
if time.time()-start_time >= timeout:
df.kill()
return -1, ""
output = '\n'.join(df.communicate()).strip()
return df.returncode, output
Поздний ответ для
Linux только, но в случае, если кто-то захочет использовать
subprocess.getstatusoutput(), если аргумент тайм-аута недоступен, вы можете использовать встроенный в Linux тайм-аут в начале команды, то есть:
import subprocess
timeout = 25 # seconds
cmd = f"timeout --preserve-status --foreground {timeout} ping duckgo.com"
exit_c, out = subprocess.getstatusoutput(cmd)
if (exit_c == 0):
print("success")
else:
print("Error: ", out)
timeout Аргументы:
-
--preserve-status: Сохранение статуса выхода -
--foreground: Бег на переднем плане -
25: значение тайм-аута в секундах
Вы можете сделать это используя select
import subprocess
from datetime import datetime
from select import select
def call_with_timeout(cmd, timeout):
started = datetime.now()
sp = subprocess.Popen(cmd, stdout=subprocess.PIPE)
while True:
p = select([sp.stdout], [], [], timeout)
if p[0]:
p[0][0].read()
ret = sp.poll()
if ret is not None:
return ret
if (datetime.now()-started).total_seconds() > timeout:
sp.kill()
return None
Когда вы поймете, что весь процесс работает в *unix, вы легко найдете более простое решение:
Рассмотрим этот простой пример того, как сделать методу timeabletable connect () meth с помощью select.select () (доступно почти всегда в *nix в настоящее время). Это также может быть записано с помощью epoll/poll/kqueue, но вариант select.select () может быть хорошим примером для вас. А основные ограничения select.select () (скорость и 1024 макс. Fds) не применимы для вашей задачи.
Это работает под *nix, не создает потоков, не использует сигналы, может быть запущено из любого потока (не только основного), и достаточно быстро для чтения 250 Мбит / с данных со стандартного выхода на моей машине (i5 2.3 ГГц).
Существует проблема в присоединении stdout/stderr в конце связи. Если у вас огромный вывод программы, это может привести к большому использованию памяти. Но вы можете вызывать connect () несколько раз с меньшим временем ожидания.
class Popen(subprocess.Popen):
def communicate(self, input=None, timeout=None):
if timeout is None:
return subprocess.Popen.communicate(self, input)
if self.stdin:
# Flush stdio buffer, this might block if user
# has been writing to .stdin in an uncontrolled
# fashion.
self.stdin.flush()
if not input:
self.stdin.close()
read_set, write_set = [], []
stdout = stderr = None
if self.stdin and input:
write_set.append(self.stdin)
if self.stdout:
read_set.append(self.stdout)
stdout = []
if self.stderr:
read_set.append(self.stderr)
stderr = []
input_offset = 0
deadline = time.time() + timeout
while read_set or write_set:
try:
rlist, wlist, xlist = select.select(read_set, write_set, [], max(0, deadline - time.time()))
except select.error as ex:
if ex.args[0] == errno.EINTR:
continue
raise
if not (rlist or wlist):
# Just break if timeout
# Since we do not close stdout/stderr/stdin, we can call
# communicate() several times reading data by smaller pieces.
break
if self.stdin in wlist:
chunk = input[input_offset:input_offset + subprocess._PIPE_BUF]
try:
bytes_written = os.write(self.stdin.fileno(), chunk)
except OSError as ex:
if ex.errno == errno.EPIPE:
self.stdin.close()
write_set.remove(self.stdin)
else:
raise
else:
input_offset += bytes_written
if input_offset >= len(input):
self.stdin.close()
write_set.remove(self.stdin)
# Read stdout / stderr by 1024 bytes
for fn, tgt in (
(self.stdout, stdout),
(self.stderr, stderr),
):
if fn in rlist:
data = os.read(fn.fileno(), 1024)
if data == '':
fn.close()
read_set.remove(fn)
tgt.append(data)
if stdout is not None:
stdout = ''.join(stdout)
if stderr is not None:
stderr = ''.join(stderr)
return (stdout, stderr)
Несмотря на то, что я не обращал на это внимания, этот декоратор, который я нашел в ActiveState, кажется весьма полезным для такого рода вещей. Вместе с subprocess.Popen(..., close_fds=True)По крайней мере, я готов к написанию сценариев в Python.
Я успешно использовал killableprocess в Windows, Linux и Mac. Если вы используете Cygwin Python, вам понадобится версия killableprocess OSAF, потому что в противном случае родные процессы Windows не будут уничтожены.
Есть идея создать подкласс класса Popen и расширить его с помощью нескольких простых декораторов методов. Давайте назовем это ExpurablePopen.
from logging import error
from subprocess import Popen
from threading import Event
from threading import Thread
class ExpirablePopen(Popen):
def __init__(self, *args, **kwargs):
self.timeout = kwargs.pop('timeout', 0)
self.timer = None
self.done = Event()
Popen.__init__(self, *args, **kwargs)
def __tkill(self):
timeout = self.timeout
if not self.done.wait(timeout):
error('Terminating process {} by timeout of {} secs.'.format(self.pid, timeout))
self.kill()
def expirable(func):
def wrapper(self, *args, **kwargs):
# zero timeout means call of parent method
if self.timeout == 0:
return func(self, *args, **kwargs)
# if timer is None, need to start it
if self.timer is None:
self.timer = thr = Thread(target=self.__tkill)
thr.daemon = True
thr.start()
result = func(self, *args, **kwargs)
self.done.set()
return result
return wrapper
wait = expirable(Popen.wait)
communicate = expirable(Popen.communicate)
if __name__ == '__main__':
from subprocess import PIPE
print ExpirablePopen('ssh -T git@bitbucket.org', stdout=PIPE, timeout=1).communicate()
Подпроцесс Popen.communicate теперь имеет
Если процесс не завершается по истечении истечения времени ожидания, будет возбуждено исключение TimeoutExpired. Перехват этого исключения и повторная попытка связи не приведут к потере результатов. Дочерний процесс не уничтожается по истечении тайм-аута, поэтому для правильной очистки правильное приложение должно завершить дочерний процесс и завершить связь.
proc = subprocess.Popen(...)
try:
outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
proc.kill()
outs, errs = proc.communicate()
Вы можете взглянуть на документы .
У меня была проблема с тем, что я хотел завершить многопоточный подпроцесс, если это заняло больше времени, чем заданное время ожидания. Я хотел установить тайм-аут в Popen(), но это не сработало. Затем я понял, что Popen().wait() равно call() и поэтому у меня была идея установить тайм-аут в .wait(timeout=xxx) метод, который наконец-то сработал. Таким образом, я решил это так:
import os
import sys
import signal
import subprocess
from multiprocessing import Pool
cores_for_parallelization = 4
timeout_time = 15 # seconds
def main():
jobs = [...YOUR_JOB_LIST...]
with Pool(cores_for_parallelization) as p:
p.map(run_parallel_jobs, jobs)
def run_parallel_jobs(args):
# Define the arguments including the paths
initial_terminal_command = 'C:\\Python34\\python.exe' # Python executable
function_to_start = 'C:\\temp\\xyz.py' # The multithreading script
final_list = [initial_terminal_command, function_to_start]
final_list.extend(args)
# Start the subprocess and determine the process PID
subp = subprocess.Popen(final_list) # starts the process
pid = subp.pid
# Wait until the return code returns from the function by considering the timeout.
# If not, terminate the process.
try:
returncode = subp.wait(timeout=timeout_time) # should be zero if accomplished
except subprocess.TimeoutExpired:
# Distinguish between Linux and Windows and terminate the process if
# the timeout has been expired
if sys.platform == 'linux2':
os.kill(pid, signal.SIGTERM)
elif sys.platform == 'win32':
subp.terminate()
if __name__ == '__main__':
main()
Это решение убивает дерево процессов в случае shell=True, передает параметры процессу (или нет), имеет тайм-аут и получает выходные данные stdout, stderr и процесса обратного вызова (он использует psutil для kill_proc_tree). Это было основано на нескольких решениях, опубликованных в SO, включая jcollado's. Публикация в ответ на комментарии Ансона и Храдице в ответ Jcollado. Протестировано в Windows Srvr 2012 и Ubuntu 14.04. Обратите внимание, что для Ubuntu вам нужно изменить вызов parent.children(...) на parent.get_children(...).
def kill_proc_tree(pid, including_parent=True):
parent = psutil.Process(pid)
children = parent.children(recursive=True)
for child in children:
child.kill()
psutil.wait_procs(children, timeout=5)
if including_parent:
parent.kill()
parent.wait(5)
def run_with_timeout(cmd, current_dir, cmd_parms, timeout):
def target():
process = subprocess.Popen(cmd, cwd=current_dir, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
# wait for the process to terminate
if (cmd_parms == ""):
out, err = process.communicate()
else:
out, err = process.communicate(cmd_parms)
errcode = process.returncode
thread = Thread(target=target)
thread.start()
thread.join(timeout)
if thread.is_alive():
me = os.getpid()
kill_proc_tree(me, including_parent=False)
thread.join()
Иногда вам нужно обработать (ffmpeg) без использования
communicate()и в этом случае вам нужен асинхронный тайм-аут, практический способ сделать это с помощью
ttldict
pip установить ttldict
from ttldict import TTLOrderedDict
sp_timeout = TTLOrderedDict(default_ttl=10)
def kill_on_timeout(done, proc):
while True:
now = time.time()
if sp_timeout.get('exp_time') == None:
proc.kill()
break
process = subprocess.Popen(cmd, stdout=subprocess.PIPE, text=True, stderr=subprocess.STDOUT)
sp_timeout['exp_time'] = time.time()
done = Event()
watcher = Thread(target=kill_on_timeout, args=(done, process))
watcher.daemon = True
watcher.start()
done.set()
for line in process.stdout:
.......
Для python 2.6+ используйте gevent
from gevent.subprocess import Popen, PIPE, STDOUT
def call_sys(cmd, timeout):
p= Popen(cmd, shell=True, stdout=PIPE)
output, _ = p.communicate(timeout=timeout)
assert p.returncode == 0, p. returncode
return output
call_sys('./t.sh', 2)
# t.sh example
sleep 5
echo done
exit 1
https://pypi.python.org/pypi/python-subprocess2 предоставляет расширения для модуля подпроцесса, которые позволяют ждать до определенного периода времени, в противном случае прерываются.
Итак, подождать до 10 секунд до завершения процесса, иначе убить:
pipe = subprocess.Popen('...')
timeout = 10
results = pipe.waitOrTerminate(timeout)
Это совместимо как с Windows, так и с Unix. "results" - это словарь, он содержит "returnCode", который является возвратом приложения (или "None", если его нужно было убить), а также "actionTaken". который будет "SUBPROCESS2_PROCESS_COMPLETED", если процесс завершен нормально, или маской "SUBPROCESS2_PROCESS_TERMINATED" и SUBPROCESS2_PROCESS_KILLED в зависимости от предпринятых действий (подробности см. в документации)