私は サブプロセスモジュール を使用してサブプロセスを開始し、その出力ストリームに接続します(stdout)。標準出力でノンブロッキング読み取りを実行できるようにしたいです。 .readline
を呼び出す前に.readlineを非ブロック化する、またはストリーム上にデータがあるかどうかを確認する方法はありますか?私はこれを移植性があるか、少なくともWindowsとLinuxで動作させたいのです。
これが私の今のやり方です(データがない場合は.readline
をブロックしています):
p = subprocess.Popen('myprogram.exe', stdout = subprocess.PIPE)
output_str = p.stdout.readline()
fcntl
、 select
、 asyncproc
この場合、 は役に立ちません。
オペレーティングシステムに関係なくブロックせずにストリームを読み取る信頼できる方法は、 Queue.get_nowait()
を使用することです。
import sys
from subprocess import PIPE, Popen
from threading import Thread
try:
from queue import Queue, Empty
except ImportError:
from Queue import Queue, Empty # python 2.x
ON_POSIX = 'posix' in sys.builtin_module_names
def enqueue_output(out, queue):
for line in iter(out.readline, b''):
queue.put(line)
out.close()
p = Popen(['myprogram.exe'], stdout=PIPE, bufsize=1, close_fds=ON_POSIX)
q = Queue()
t = Thread(target=enqueue_output, args=(p.stdout, q))
t.daemon = True # thread dies with the program
t.start()
# ... do other things here
# read line without blocking
try: line = q.get_nowait() # or q.get(timeout=.1)
except Empty:
print('no output yet')
else: # got line
# ... do something with line
私はよく似た問題を抱えています。私がよく書くPythonプログラムは、コマンドライン(stdin)からのユーザー入力を同時に受けながら、いくつかの主要な機能を実行する能力を持つ必要があります。 readline()
はブロックされ、タイムアウトは発生しないため、単純にユーザー入力処理機能を別のスレッドに入れても問題は解決されません。主な機能が完成し、それ以上ユーザー入力を待つ必要がなくなったら、通常はプログラムを終了させますが、readline()
がまだ行を待っている他のスレッドでブロックされているため、できません。私がこの問題を解決した解決策は、fcntlモジュールを使って、stdinを非ブロッキングファイルにすることです。
import fcntl
import os
import sys
# make stdin a non-blocking file
fd = sys.stdin.fileno()
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
# user input handling thread
while mainThreadIsRunning:
try: input = sys.stdin.readline()
except: continue
handleInput(input)
私の意見では、これはselectまたはsignalモジュールを使用してこの問題を解決するよりも少しきれいですが、それでもUNIX上でしか機能しません。
Python 3.4では、非同期IOの新しい 暫定API が導入されました- asyncio
module 。
このアプローチは、 twisted
- @ Bryan Wardによるベースの回答 と似ています。プロトコルを定義し、データの準備ができるとすぐにそのメソッドが呼び出されます。
#!/usr/bin/env python3
import asyncio
import os
class SubprocessProtocol(asyncio.SubprocessProtocol):
def pipe_data_received(self, fd, data):
if fd == 1: # got stdout data (bytes)
print(data)
def connection_lost(self, exc):
loop.stop() # end loop.run_forever()
if os.name == 'nt':
loop = asyncio.ProactorEventLoop() # for subprocess' pipes on Windows
asyncio.set_event_loop(loop)
else:
loop = asyncio.get_event_loop()
try:
loop.run_until_complete(loop.subprocess_exec(SubprocessProtocol,
"myprogram.exe", "arg1", "arg2"))
loop.run_forever()
finally:
loop.close()
ドキュメントの「サブプロセス」 を参照してください。
Process
オブジェクト を返す高レベルのインターフェースasyncio.create_subprocess_exec()
があり、 StreamReader.readline()
coroutine (withを使用して非同期に行を読み取ることができます async
/await
Python 3.5+構文 ):
#!/usr/bin/env python3.5
import asyncio
import locale
import sys
from asyncio.subprocess import PIPE
from contextlib import closing
async def readline_and_kill(*args):
# start child process
process = await asyncio.create_subprocess_exec(*args, stdout=PIPE)
# read line (sequence of bytes ending with b'\n') asynchronously
async for line in process.stdout:
print("got line:", line.decode(locale.getpreferredencoding(False)))
break
process.kill()
return await process.wait() # wait for the child process to exit
if sys.platform == "win32":
loop = asyncio.ProactorEventLoop()
asyncio.set_event_loop(loop)
else:
loop = asyncio.get_event_loop()
with closing(loop):
sys.exit(loop.run_until_complete(readline_and_kill(
"myprogram.exe", "arg1", "arg2")))
readline_and_kill()
は次のタスクを実行します。
必要に応じて、タイムアウトごとに各ステップを制限できます。
asyncproc モジュールを試してください。例えば:
import os
from asyncproc import Process
myProc = Process("myprogram.app")
while True:
# check to see if process has ended
poll = myProc.wait(os.WNOHANG)
if poll != None:
break
# print any new output
out = myProc.read()
if out != "":
print out
S.Lottが提案しているように、モジュールはすべてのスレッドを処理します。
Selectを使って(1)を読んでください。
import subprocess #no new requirements
def readAllSoFar(proc, retVal=''):
while (select.select([proc.stdout],[],[],0)[0]!=[]):
retVal+=proc.stdout.read(1)
return retVal
p = subprocess.Popen(['/bin/ls'], stdout=subprocess.PIPE)
while not p.poll():
print (readAllSoFar(p))
Readline()の場合 - like:
lines = ['']
while not p.poll():
lines = readAllSoFar(p, lines[-1]).split('\n')
for a in range(len(lines)-1):
print a
lines = readAllSoFar(p, lines[-1]).split('\n')
for a in range(len(lines)-1):
print a
これは Twisted で簡単に行えます。既存のコードベースによっては、これはそれほど簡単ではないかもしれませんが、ねじれたアプリケーションを作成している場合は、このようなことはほとんど簡単になります。 ProcessProtocol
クラスを作成し、outReceived()
メソッドをオーバーライドします。ツイスト(使用されるリアクタによって異なります)は通常、異なるファイル記述子(多くの場合はネットワークソケット)からのデータを処理するためにインストールされたコールバックを持つ単なる大きなselect()
ループです。それでoutReceived()
メソッドは単にSTDOUT
から来るデータを扱うためのコールバックをインストールすることです。この動作を示す簡単な例は次のとおりです。
from twisted.internet import protocol, reactor
class MyProcessProtocol(protocol.ProcessProtocol):
def outReceived(self, data):
print data
proc = MyProcessProtocol()
reactor.spawnProcess(proc, './myprogram', ['./myprogram', 'arg1', 'arg2', 'arg3'])
reactor.run()
Twistedのドキュメント にはこれに関する良い情報があります。
Twistedを使ってアプリケーション全体を構築すると、ローカルまたはリモートの他のプロセスとの非同期通信が非常にエレガントになります。一方、あなたのプログラムがTwisted上で構築されていないのであれば、これはそれほど役に立ちません。あなたの特定のアプリケーションに適用できないとしても、これが他の読者に役立つことを願っています。
1つの解決策は、プロセスの読み取りを実行するために別のプロセスを作成するか、タイムアウト付きでプロセスのスレッドを作成することです。
これがタイムアウト関数のスレッド版です。
http://code.activestate.com/recipes/473878/
しかし、標準出力が入ってきたときにそれを読む必要がありますか。別の解決策は、出力をファイルにダンプして、p.wait()を使用してプロセスが終了するのを待つことです。
f = open('myprogram_output.txt','w')
p = subprocess.Popen('myprogram.exe', stdout=f)
p.wait()
f.close()
str = open('myprogram_output.txt','r').read()
既存の解決策は私にはうまくいきませんでした(詳細は下記)。やっとうまくいったのはread(1)を使ってreadlineを実装することです( この答えに基づいて )。後者はブロックしません:
from subprocess import Popen, PIPE
from threading import Thread
def process_output(myprocess): #output-consuming thread
nextline = None
buf = ''
while True:
#--- extract line using read(1)
out = myprocess.stdout.read(1)
if out == '' and myprocess.poll() != None: break
if out != '':
buf += out
if out == '\n':
nextline = buf
buf = ''
if not nextline: continue
line = nextline
nextline = None
#--- do whatever you want with line here
print 'Line is:', line
myprocess.stdout.close()
myprocess = Popen('myprogram.exe', stdout=PIPE) #output-producing process
p1 = Thread(target=process_output, args=(dcmpid,)) #output-consuming thread
p1.daemon = True
p1.start()
#--- do whatever here and then kill process and thread if needed
if myprocess.poll() == None: #kill process; will automatically stop thread
myprocess.kill()
myprocess.wait()
if p1 and p1.is_alive(): #wait for thread to finish
p1.join()
既存の解決策がうまくいかなかった理由:
免責事項:これは竜巻にのみ機能します
これを行うには、fdをノンブロッキングに設定してから、ioloopを使用してコールバックを登録します。これを tornado_subprocess というEggにパッケージ化しました。PyPIでインストールできます。
easy_install tornado_subprocess
今、あなたはこのようなことをすることができます:
import tornado_subprocess
import tornado.ioloop
def print_res( status, stdout, stderr ) :
print status, stdout, stderr
if status == 0:
print "OK:"
print stdout
else:
print "ERROR:"
print stderr
t = tornado_subprocess.Subprocess( print_res, timeout=30, args=[ "cat", "/etc/passwd" ] )
t.start()
tornado.ioloop.IOLoop.instance().start()
requestHandlerと一緒に使うこともできます
class MyHandler(tornado.web.RequestHandler):
def on_done(self, status, stdout, stderr):
self.write( stdout )
self.finish()
@tornado.web.asynchronous
def get(self):
t = tornado_subprocess.Subprocess( self.on_done, timeout=30, args=[ "cat", "/etc/passwd" ] )
t.start()
このバージョンのノンブロッキングreadは特別なモジュールを必要とせず、ほとんどのLinuxディストリビューションでそのまま使用できます。
import os
import sys
import time
import fcntl
import subprocess
def async_read(fd):
# set non-blocking flag while preserving old flags
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
# read char until EOF hit
while True:
try:
ch = os.read(fd.fileno(), 1)
# EOF
if not ch: break
sys.stdout.write(ch)
except OSError:
# waiting for data be available on fd
pass
def Shell(args, async=True):
# merge stderr and stdout
proc = subprocess.Popen(args, Shell=False, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
if async: async_read(proc.stdout)
sout, serr = proc.communicate()
return (sout, serr)
if __== '__main__':
cmd = 'ping 8.8.8.8'
sout, serr = Shell(cmd.split())
私はいくつかのサブプロセスを読むためにこの問題を追加します。標準出力を開きます。これが私のノンブロッキング読み取りソリューションです。
import fcntl
def non_block_read(output):
fd = output.fileno()
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
try:
return output.read()
except:
return ""
# Use example
from subprocess import *
sb = Popen("echo test && sleep 1000", Shell=True, stdout=PIPE)
sb.kill()
# sb.stdout.read() # <-- This will block
non_block_read(sb.stdout)
'test\n'
これが私のコードで、部分行も含めてサブプロセスASAPからのすべての出力をキャッチするために使用されます。それは同時に、標準出力と標準エラー出力をほぼ正しい順序で送ります。
テスト済みで正しくPython 2.7 LinuxおよびWindows上で動作しました。
#!/usr/bin/python
#
# Runner with stdout/stderr catcher
#
from sys import argv
from subprocess import Popen, PIPE
import os, io
from threading import Thread
import Queue
def __main__():
if (len(argv) > 1) and (argv[-1] == "-sub-"):
import time, sys
print "Application runned!"
time.sleep(2)
print "Slept 2 second"
time.sleep(1)
print "Slept 1 additional second",
time.sleep(2)
sys.stderr.write("Stderr output after 5 seconds")
print "Eol on stdin"
sys.stderr.write("Eol on stderr\n")
time.sleep(1)
print "Wow, we have end of work!",
else:
os.environ["PYTHONUNBUFFERED"]="1"
try:
p = Popen( argv + ["-sub-"],
bufsize=0, # line-buffered
stdin=PIPE, stdout=PIPE, stderr=PIPE )
except WindowsError, W:
if W.winerror==193:
p = Popen( argv + ["-sub-"],
Shell=True, # Try to run via Shell
bufsize=0, # line-buffered
stdin=PIPE, stdout=PIPE, stderr=PIPE )
else:
raise
inp = Queue.Queue()
sout = io.open(p.stdout.fileno(), 'rb', closefd=False)
serr = io.open(p.stderr.fileno(), 'rb', closefd=False)
def Pump(stream, category):
queue = Queue.Queue()
def rdr():
while True:
buf = stream.read1(8192)
if len(buf)>0:
queue.put( buf )
else:
queue.put( None )
return
def clct():
active = True
while active:
r = queue.get()
try:
while True:
r1 = queue.get(timeout=0.005)
if r1 is None:
active = False
break
else:
r += r1
except Queue.Empty:
pass
inp.put( (category, r) )
for tgt in [rdr, clct]:
th = Thread(target=tgt)
th.setDaemon(True)
th.start()
Pump(sout, 'stdout')
Pump(serr, 'stderr')
while p.poll() is None:
# App still working
try:
chan,line = inp.get(timeout = 1.0)
if chan=='stdout':
print "STDOUT>>", line, "<?<"
Elif chan=='stderr':
print " ERROR==", line, "=?="
except Queue.Empty:
pass
print "Finish"
if __== '__main__':
__main__()
WindowsとUnixでノンブロッキングパイプを設定する機能を提供するので、ここにこの答えを追加します。
すべてのctypes
の詳細は @ techtonikの回答 に感謝します。
UnixシステムとWindowsシステムの両方で使用されるように少し修正されたバージョンがあります。
このようにして、あなたはUnixとWindowsコードのために同じ機能と例外を使うことができます。
# pipe_non_blocking.py (module)
"""
Example use:
p = subprocess.Popen(
command,
stdout=subprocess.PIPE,
)
pipe_non_blocking_set(p.stdout.fileno())
try:
data = os.read(p.stdout.fileno(), 1)
except PortableBlockingIOError as ex:
if not pipe_non_blocking_is_error_blocking(ex):
raise ex
"""
__all__ = (
"pipe_non_blocking_set",
"pipe_non_blocking_is_error_blocking",
"PortableBlockingIOError",
)
import os
if os.name == "nt":
def pipe_non_blocking_set(fd):
# Constant could define globally but avoid polluting the name-space
# thanks to: https://stackoverflow.com/questions/34504970
import msvcrt
from ctypes import windll, byref, wintypes, WinError, POINTER
from ctypes.wintypes import HANDLE, DWORD, BOOL
LPDWORD = POINTER(DWORD)
PIPE_NOWAIT = wintypes.DWORD(0x00000001)
def pipe_no_wait(pipefd):
SetNamedPipeHandleState = windll.kernel32.SetNamedPipeHandleState
SetNamedPipeHandleState.argtypes = [HANDLE, LPDWORD, LPDWORD, LPDWORD]
SetNamedPipeHandleState.restype = BOOL
h = msvcrt.get_osfhandle(pipefd)
res = windll.kernel32.SetNamedPipeHandleState(h, byref(PIPE_NOWAIT), None, None)
if res == 0:
print(WinError())
return False
return True
return pipe_no_wait(fd)
def pipe_non_blocking_is_error_blocking(ex):
if not isinstance(ex, PortableBlockingIOError):
return False
from ctypes import GetLastError
ERROR_NO_DATA = 232
return (GetLastError() == ERROR_NO_DATA)
PortableBlockingIOError = OSError
else:
def pipe_non_blocking_set(fd):
import fcntl
fl = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
return True
def pipe_non_blocking_is_error_blocking(ex):
if not isinstance(ex, PortableBlockingIOError):
return False
return True
PortableBlockingIOError = BlockingIOError
不完全なデータを読み取らないようにするために、私は自分のreadlineジェネレータ(各行のバイト文字列を返す)を書くことにしました。
あなたが例えばすることができますので、そのジェネレータ...
def non_blocking_readlines(f, chunk=1024):
"""
Iterate over lines, yielding b'' when nothings left
or when new data is not yet available.
stdout_iter = iter(non_blocking_readlines(process.stdout))
line = next(stdout_iter) # will be a line or b''.
"""
import os
from .pipe_non_blocking import (
pipe_non_blocking_set,
pipe_non_blocking_is_error_blocking,
PortableBlockingIOError,
)
fd = f.fileno()
pipe_non_blocking_set(fd)
blocks = []
while True:
try:
data = os.read(fd, chunk)
if not data:
# case were reading finishes with no trailing newline
yield b''.join(blocks)
blocks.clear()
except PortableBlockingIOError as ex:
if not pipe_non_blocking_is_error_blocking(ex):
raise ex
yield b''
continue
while True:
n = data.find(b'\n')
if n == -1:
break
yield b''.join(blocks) + data[:n + 1]
data = data[n + 1:]
blocks.clear()
blocks.append(data)
私は最初の質問者の問題を抱えていますが、スレッドを呼び出したくありませんでした。 Jesseの解決策とパイプからの直接read()、そして行を読むための私自身のバッファハンドラを混ぜ合わせました(ただし、私のサブプロセス - ping - は常にシステムページサイズの全行を書きました)。私はgobjectに登録したioウォッチを読むだけで忙しいのを避けます。最近は、スレッドを避けるために、gobjectのMainLoop内でコードを実行するのが普通です。
def set_up_ping(ip, w):
# run the sub-process
# watch the resultant pipe
p = subprocess.Popen(['/bin/ping', ip], stdout=subprocess.PIPE)
# make stdout a non-blocking file
fl = fcntl.fcntl(p.stdout, fcntl.F_GETFL)
fcntl.fcntl(p.stdout, fcntl.F_SETFL, fl | os.O_NONBLOCK)
stdout_gid = gobject.io_add_watch(p.stdout, gobject.IO_IN, w)
return stdout_gid # for shutting down
ウォッチャーは
def watch(f, *other):
print 'reading',f.read()
return True
そしてメインプログラムはpingを設定してからgobjectメールループを呼び出します。
def main():
set_up_ping('192.168.1.8', watch)
# discard gid as unused here
gobject.MainLoop().run()
その他の作業はすべてgobjectのコールバックに添付されています。
私の場合は、バックグラウンドアプリケーションからの出力を受け取り、それを補強する(タイムスタンプ、色などを追加する)ロギングモジュールが必要でした。
実際のI/Oを実行するバックグラウンドスレッドになりました。以下のコードはPOSIXプラットフォーム専用です。重要でない部分は取り除きました。
誰かがこの獣を長期的に使用しようとしている場合は、オープン記述子の管理を検討してください。私の場合、それは大きな問題ではありませんでした。
# -*- python -*-
import fcntl
import threading
import sys, os, errno
import subprocess
class Logger(threading.Thread):
def __init__(self, *modules):
threading.Thread.__init__(self)
try:
from select import epoll, EPOLLIN
self.__poll = epoll()
self.__evt = EPOLLIN
self.__to = -1
except:
from select import poll, POLLIN
print 'epoll is not available'
self.__poll = poll()
self.__evt = POLLIN
self.__to = 100
self.__fds = {}
self.daemon = True
self.start()
def run(self):
while True:
events = self.__poll.poll(self.__to)
for fd, ev in events:
if (ev&self.__evt) != self.__evt:
continue
try:
self.__fds[fd].run()
except Exception, e:
print e
def add(self, fd, log):
assert not self.__fds.has_key(fd)
self.__fds[fd] = log
self.__poll.register(fd, self.__evt)
class log:
logger = Logger()
def __init__(self, name):
self.__name = name
self.__piped = False
def fileno(self):
if self.__piped:
return self.write
self.read, self.write = os.pipe()
fl = fcntl.fcntl(self.read, fcntl.F_GETFL)
fcntl.fcntl(self.read, fcntl.F_SETFL, fl | os.O_NONBLOCK)
self.fdRead = os.fdopen(self.read)
self.logger.add(self.read, self)
self.__piped = True
return self.write
def __run(self, line):
self.chat(line, nl=False)
def run(self):
while True:
try: line = self.fdRead.readline()
except IOError, exc:
if exc.errno == errno.EAGAIN:
return
raise
self.__run(line)
def chat(self, line, nl=True):
if nl: nl = '\n'
else: nl = ''
sys.stdout.write('[%s] %s%s' % (self.__name, line, nl))
def system(command, param=[], cwd=None, env=None, input=None, output=None):
args = [command] + param
p = subprocess.Popen(args, cwd=cwd, stdout=output, stderr=output, stdin=input, env=env, bufsize=0)
p.wait()
ls = log('ls')
ls.chat('go')
system("ls", ['-l', '/'], output=ls)
date = log('date')
date.chat('go')
system("date", output=date)
なぜスレッド&キューを煩わせるのですか? readline()とは異なり、BufferedReader.read1()は\ r\nを待ってブロックしません。出力があるとASAPを返します。
#!/usr/bin/python
from subprocess import Popen, PIPE, STDOUT
import io
def __main__():
try:
p = Popen( ["ping", "-n", "3", "127.0.0.1"], stdin=PIPE, stdout=PIPE, stderr=STDOUT )
except: print("Popen failed"); quit()
sout = io.open(p.stdout.fileno(), 'rb', closefd=False)
while True:
buf = sout.read1(1024)
if len(buf) == 0: break
print buf,
if __== '__main__':
__main__()
select モジュールを使うと、次に役に立つ入力がどこにあるかを判断するのに役立ちます。
しかし、あなたはほとんどの場合別々のスレッドを使って幸せです。 1つは標準入力をブロックし、もう1つはブロックされたくない場所はどこでもします。
J.F. Sebastianの回答とその他のいくつかの情報源から作業して、私は簡単なサブプロセスマネージャをまとめました。それは、要求のノンブロッキング読み取り、ならびにいくつかのプロセスを並行して実行することを提供します。 OS固有の呼び出し(私は知っている)を使用していないので、どこでも動作するはずです。
それはpypiから入手可能なので、pip install shelljob
だけです。例と完全なドキュメントについては プロジェクトページ を参照してください。
編集:この実装はまだブロックされます。代わりにJ.F.Sebastianの 答え を使用してください。
私は トップの答え を試しましたが、スレッドコードの追加のリスクとメンテナンスは気になりました。
ioモジュール を見て(そして2.6に制限されています)、BufferedReaderが見つかりました。これは私のスレッドレス、ノンブロッキングソリューションです。
import io
from subprocess import PIPE, Popen
p = Popen(['myprogram.exe'], stdout=PIPE)
SLEEP_DELAY = 0.001
# Create an io.BufferedReader on the file descriptor for stdout
with io.open(p.stdout.fileno(), 'rb', closefd=False) as buffer:
while p.poll() == None:
time.sleep(SLEEP_DELAY)
while '\n' in bufferedStdout.peek(bufferedStdout.buffer_size):
line = buffer.readline()
# do stuff with the line
# Handle any remaining output after the process has ended
while buffer.peek():
line = buffer.readline()
# do stuff with the line
現代のPythonでは物事はずっと良くなっています。
これが簡単な子プログラム "hello.py"です。
#!/usr/bin/env python3
while True:
i = input()
if i == "quit":
break
print(f"hello {i}")
それと対話するためのプログラム:
import asyncio
async def main():
proc = await asyncio.subprocess.create_subprocess_exec(
"./hello.py", stdin=asyncio.subprocess.PIPE, stdout=asyncio.subprocess.PIPE
)
proc.stdin.write(b"bob\n")
print(await proc.stdout.read(1024))
proc.stdin.write(b"alice\n")
print(await proc.stdout.read(1024))
proc.stdin.write(b"quit\n")
await proc.wait()
asyncio.run(main())
それはプリントアウトします:
b'hello bob\n'
b'hello alice\n'
ここでもまた関連する質問でも、これまでのほとんどすべての回答による実際のパターンは、子のstdoutファイル記述子を非ブロックに設定してから、ある種の選択ループでポーリングすることです。最近では、もちろん、そのループはasyncioによって提供されます。
これはサブプロセスで対話式コマンドを実行する例です。標準出力は疑似端末を使用して対話式です。あなたが参照することができます: https://stackoverflow.com/a/43012138/3555925
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import os
import sys
import select
import termios
import tty
import pty
from subprocess import Popen
command = 'bash'
# command = 'docker run -it --rm centos /bin/bash'.split()
# save original tty setting then set it to raw mode
old_tty = termios.tcgetattr(sys.stdin)
tty.setraw(sys.stdin.fileno())
# open pseudo-terminal to interact with subprocess
master_fd, slave_fd = pty.openpty()
# use os.setsid() make it run in a new process group, or bash job control will not be enabled
p = Popen(command,
preexec_fn=os.setsid,
stdin=slave_fd,
stdout=slave_fd,
stderr=slave_fd,
universal_newlines=True)
while p.poll() is None:
r, w, e = select.select([sys.stdin, master_fd], [], [])
if sys.stdin in r:
d = os.read(sys.stdin.fileno(), 10240)
os.write(master_fd, d)
Elif master_fd in r:
o = os.read(master_fd, 10240)
if o:
os.write(sys.stdout.fileno(), o)
# restore tty settings back
termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
実行中のプロセスからstdoutとstderrの両方を収集したい場合、私の問題は少し異なりますが、生成されたとおりにウィジェットで出力をレンダリングしたいので、最終的には同じです。
別のスクリプトを実行してその出力を収集するなどの一般的なタスクを実行するために必要ではないはずなので、私はキューまたは追加のスレッドを使用して提案された回避策の多くに頼りたくありませんでした。
提案されたソリューションとPythonドキュメントを読んだ後、私は以下の実装で私の問題を解決しました。はい、私はselect
関数呼び出しを使用しているので、POSIXに対してのみ機能します。
このような一般的なスクリプト作成作業では、ドキュメントがわかりにくく、実装が面倒であることに同意します。私は、古いバージョンのpythonではPopen
のデフォルトや説明が異なるため、混乱を招くと思います。これはPython 2.7.12と3.5.2の両方でうまく機能するようです。
重要なのは、ラインバッファリングのためにbufsize=1
を設定し、次にuniversal_newlines=True
を設定するときのデフォルトとなるバイナリの代わりにテキストファイルとして処理するためにbufsize=1
を設定することでした。
class workerThread(QThread):
def __init__(self, cmd):
QThread.__init__(self)
self.cmd = cmd
self.result = None ## return code
self.error = None ## flag indicates an error
self.errorstr = "" ## info message about the error
def __del__(self):
self.wait()
DEBUG("Thread removed")
def run(self):
cmd_list = self.cmd.split(" ")
try:
cmd = subprocess.Popen(cmd_list, bufsize=1, stdin=None
, universal_newlines=True
, stderr=subprocess.PIPE
, stdout=subprocess.PIPE)
except OSError:
self.error = 1
self.errorstr = "Failed to execute " + self.cmd
ERROR(self.errorstr)
finally:
VERBOSE("task started...")
import select
while True:
try:
r,w,x = select.select([cmd.stdout, cmd.stderr],[],[])
if cmd.stderr in r:
line = cmd.stderr.readline()
if line != "":
line = line.strip()
self.emit(SIGNAL("update_error(QString)"), line)
if cmd.stdout in r:
line = cmd.stdout.readline()
if line == "":
break
line = line.strip()
self.emit(SIGNAL("update_output(QString)"), line)
except IOError:
pass
cmd.wait()
self.result = cmd.returncode
if self.result < 0:
self.error = 1
self.errorstr = "Task terminated by signal " + str(self.result)
ERROR(self.errorstr)
return
if self.result:
self.error = 1
self.errorstr = "exit code " + str(self.result)
ERROR(self.errorstr)
return
return
ERROR、DEBUG、およびVERBOSEは、端末に出力を印刷する単なるマクロです。
この解決法はブロッキングreadline
関数をまだ使っているので私見99.99%の効果があります、それで我々はサブプロセスがNiceであると仮定してそして完全な行を出力します。
私はまだPythonに慣れていないので、解決策を改善するためのフィードバックを歓迎します。
私は Jに基づいてライブラリを作成しました。 F. Sebastianの解 。あなたはそれを使うことができます。
このソリューションは、IOストリームから「利用可能なデータを読み取る」ためにselect
モジュールを使用します。この関数は、データが利用可能になるまで最初はブロックしますが、利用可能なデータのみを読み取り、それ以上ブロックしません。
select
モジュールを使用しているという事実を考えると、これはUnix上でのみ機能します。
コードは完全にPEP8に準拠しています。
import select
def read_available(input_stream, max_bytes=None):
"""
Blocks until any data is available, then all available data is then read and returned.
This function returns an empty string when end of stream is reached.
Args:
input_stream: The stream to read from.
max_bytes (int|None): The maximum number of bytes to read. This function may return fewer bytes than this.
Returns:
str
"""
# Prepare local variables
input_streams = [input_stream]
empty_list = []
read_buffer = ""
# Initially block for input using 'select'
if len(select.select(input_streams, empty_list, empty_list)[0]) > 0:
# Poll read-readiness using 'select'
def select_func():
return len(select.select(input_streams, empty_list, empty_list, 0)[0]) > 0
# Create while function based on parameters
if max_bytes is not None:
def while_func():
return (len(read_buffer) < max_bytes) and select_func()
else:
while_func = select_func
while True:
# Read single byte at a time
read_data = input_stream.read(1)
if len(read_data) == 0:
# End of stream
break
# Append byte to string buffer
read_buffer += read_data
# Check if more data is available
if not while_func():
break
# Return read buffer
return read_buffer
また、 Jesse によって記述された問題に直面し、 Bradley 、 として「select」を使用して解決しました。 Andy と他の人たちは、ビジーループを避けるためにブロッキングモードにしました。偽の標準入力としてダミーのPipeを使用します。選択はブロックされ、標準入力またはパイプの準備が整うのを待ちます。キーが押されると標準入力のブロックが解除され、キーの値はread(1)で取得することができます。別のスレッドがパイプに書き込むと、そのパイプは選択を解除し、それは標準入力の必要性が終了したことを示すものと見なすことができます。ここにいくつかの参照コードがあります:
import sys
import os
from select import select
# -------------------------------------------------------------------------
# Set the pipe (fake stdin) to simulate a final key stroke
# which will unblock the select statement
readEnd, writeEnd = os.pipe()
readFile = os.fdopen(readEnd)
writeFile = os.fdopen(writeEnd, "w")
# -------------------------------------------------------------------------
def getKey():
# Wait for stdin or pipe (fake stdin) to be ready
dr,dw,de = select([sys.__stdin__, readFile], [], [])
# If stdin is the one ready then read it and return value
if sys.__stdin__ in dr:
return sys.__stdin__.read(1) # For Windows use ----> getch() from module msvcrt
# Must finish
else:
return None
# -------------------------------------------------------------------------
def breakStdinRead():
writeFile.write(' ')
writeFile.flush()
# -------------------------------------------------------------------------
# MAIN CODE
# Get key stroke
key = getKey()
# Keyboard input
if key:
# ... do your stuff with the key value
# Faked keystroke
else:
# ... use of stdin finished
# -------------------------------------------------------------------------
# OTHER THREAD CODE
breakStdinRead()
私は最近、ノンブロッキングモードでストリーム(サブプロセスのテールラン)から1行ずつ読み込む必要があるのと同じ問題に遭遇しました。次の問題は避けたいと思いました。 readlineがしたように)など
これが私の実装です https://Gist.github.com/grubberr/5501e1a9760c3eab5e0a それはウィンドウをサポートしていません(ポーリング)、EOFを処理しませんしかし、それは私のためにうまくいきます