web-dev-qa-db-ja.com

pythonのサブプロセスreadlineのタイムアウト

解決方法がよくわからない小さな問題があります。最小限の例を次に示します。

私が持っているもの

scan_process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
while(some_criterium):
    line = scan_process.stdout.readline()
    some_criterium = do_something(line)

私が欲しいもの

scan_process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
while(some_criterium):
    line = scan_process.stdout.readline()
    if nothing_happens_after_10s:
        break
    else:
        some_criterium = do_something(line)

サブプロセスから行を読み取り、それで何かをします。一定の時間間隔が経過しても回線が届かない場合は、終了する必要があります。推奨事項はありますか?

38
Tom

すべての答えをありがとう! select.pollを使用して標準出力を覗くだけで問題を解決する方法を見つけました。

import select
...
scan_process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
poll_obj = select.poll()
poll_obj.register(scan_process.stdout, select.POLLIN)   
while(some_criterium and not time_limit):
    poll_result = poll_obj.poll(0)
    if poll_result:
        line = scan_process.stdout.readline()
        some_criterium = do_something(line)
    update(time_limit)
20
Tom

asyncio を使用して単一行を読み取るためのタイムアウトを強制するポータブルソリューションを次に示します。

#!/usr/bin/env python3
import asyncio
import sys
from asyncio.subprocess import PIPE, STDOUT

async def run_command(*args, timeout=None):
    # start child process
    # NOTE: universal_newlines parameter is not supported
    process = await asyncio.create_subprocess_exec(*args,
            stdout=PIPE, stderr=STDOUT)

    # read line (sequence of bytes ending with b'\n') asynchronously
    while True:
        try:
            line = await asyncio.wait_for(process.stdout.readline(), timeout)
        except asyncio.TimeoutError:
            pass
        else:
            if not line: # EOF
                break
            Elif do_something(line): 
                continue # while some criterium is satisfied
        process.kill() # timeout or some criterium is not satisfied
        break
    return await process.wait() # wait for the child process to exit


if sys.platform == "win32":
    loop = asyncio.ProactorEventLoop() # for subprocess' pipes on Windows
    asyncio.set_event_loop(loop)
else:
    loop = asyncio.get_event_loop()

returncode = loop.run_until_complete(run_command("cmd", "arg 1", "arg 2",
                                                 timeout=10))
loop.close()
16
jfs

python(IIRCもSOの質問から構成されていますが、どの質問を思い出せません)でもう少し一般的なものを使用しました。

import thread
from threading import Timer

def run_with_timeout(timeout, default, f, *args, **kwargs):
    if not timeout:
        return f(*args, **kwargs)
    try:
        timeout_timer = Timer(timeout, thread.interrupt_main)
        timeout_timer.start()
        result = f(*args, **kwargs)
        return result
    except KeyboardInterrupt:
        return default
    finally:
        timeout_timer.cancel()

ただし、これは割り込みを使用して、指定した機能を停止します。これはすべての機能にとって良いアイデアではないかもしれません。また、タイムアウト中にctrl + cでプログラムを閉じることもできません(つまり、ctrl + cはタイムアウトとして処理されます)。

scan_process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
while(some_criterium):
    line = run_with_timeout(timeout, None, scan_process.stdout.readline)
    if line is None:
        break
    else:
        some_criterium = do_something(line)

ただし、少しやり過ぎかもしれません。私は知らないあなたのケースのためのより簡単なオプションがあると思う。

10
Flogo

移植可能な解決策は、行の読み取りに時間がかかりすぎる場合に、スレッドを使用して子プロセスを強制終了することです。

#!/usr/bin/env python3
from subprocess import Popen, PIPE, STDOUT

timeout = 10
with Popen(command, stdout=PIPE, stderr=STDOUT,
           universal_newlines=True) as process:  # text mode
    # kill process in timeout seconds unless the timer is restarted
    watchdog = WatchdogTimer(timeout, callback=process.kill, daemon=True)
    watchdog.start()
    for line in process.stdout:
        # don't invoke the watcthdog callback if do_something() takes too long
        with watchdog.blocked:
            if not do_something(line):  # some criterium is not satisfied
                process.kill()
                break
            watchdog.restart()  # restart timer just before reading the next line
    watchdog.cancel()

WatchdogTimerクラスはthreading.Timer再起動および/またはブロックできる:

from threading import Event, Lock, Thread
from subprocess import Popen, PIPE, STDOUT
from time import monotonic  # use time.time or monotonic.monotonic on Python 2

class WatchdogTimer(Thread):
    """Run *callback* in *timeout* seconds unless the timer is restarted."""

    def __init__(self, timeout, callback, *args, timer=monotonic, **kwargs):
        super().__init__(**kwargs)
        self.timeout = timeout
        self.callback = callback
        self.args = args
        self.timer = timer
        self.cancelled = Event()
        self.blocked = Lock()

    def run(self):
        self.restart() # don't start timer until `.start()` is called
        # wait until timeout happens or the timer is canceled
        while not self.cancelled.wait(self.deadline - self.timer()):
            # don't test the timeout while something else holds the lock
            # allow the timer to be restarted while blocked
            with self.blocked:
                if self.deadline <= self.timer() and not self.cancelled.is_set():
                    return self.callback(*self.args)  # on timeout

    def restart(self):
        """Restart the watchdog timer."""
        self.deadline = self.timer() + self.timeout

    def cancel(self):
        self.cancelled.set()
4
jfs

Signal.alarmを使用してみてください。

#timeout.py
import signal,sys

def timeout(sig,frm):
  print "This is taking too long..."
  sys.exit(1)

signal.signal(signal.SIGALRM, timeout)
signal.alarm(10)
byte=0

while 'IT' not in open('/dev/urandom').read(2):
  byte+=2
print "I got IT in %s byte(s)!" % byte

それが機能することを示すためのいくつかの実行:

$ python timeout.py 
This is taking too long...
$ python timeout.py 
I got IT in 4672 byte(s)!

より詳細な例については、 pGuides を参照してください。

4
AXE-Labs

Python 3では、タイムアウトオプションがサブプロセスモジュールに追加されました。

try:
    o, e = process.communicate(timeout=10)
except TimeoutExpired:
    process.kill()
    o, e = process.communicate()

analyze(o)

適切なソリューションになります。

出力には改行文字が含まれることが予想されるため、テキスト(印刷可能、読み取り可能)であると想定しても安全です。その場合はuniversal_newlines=Trueフラグを強くお勧めします。

Python2が必須の場合は、 https://pypi.python.org/pypi/subprocess32/ (バックポート)を使用してください

Pure-python Python 2ソリューションについては、 タイムアウト付きのモジュール 'subprocess'の使用 をご覧ください。

3

(Tomの)ソリューションは機能しますが、Cイディオムでselect()を使用するとよりコンパクトになります。これはあなたの答えと同等です

from select import select
scan_process = subprocess.Popen(command, 
                                stdout=subprocess.PIPE,
                                stderr=subprocess.STDOUT,
                                bufsize=1)  # line buffered
while some_criterium and not time_limit:
    poll_result = select([scan_process.stdout], [], [], time_limit)[0]

残りは同じです。

見る pydoc select.select

[注:これはUnix固有であり、他の回答もいくつかあります。]

[注2:OPリクエストごとに行バッファリングを追加するように編集]

[注3:ラインバッファリングはすべての状況で信頼できるとは限らないため、readline()がブロックされる]

1
jcomeau_ictx