pipedprocess.py
74 lines
| 2.5 KiB
| text/x-python
|
PythonLexer
|
r1437 | # encoding: utf-8 | ||
""" | ||||
|
r4872 | Object for encapsulating process execution by using callbacks for stdout, | ||
|
r1437 | stderr and stdin. | ||
""" | ||||
__docformat__ = "restructuredtext en" | ||||
#------------------------------------------------------------------------------- | ||||
# Copyright (C) 2008 The IPython Development Team | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#------------------------------------------------------------------------------- | ||||
#------------------------------------------------------------------------------- | ||||
# Imports | ||||
#------------------------------------------------------------------------------- | ||||
|
r1455 | from killableprocess import Popen, PIPE | ||
|
r1437 | from threading import Thread | ||
|
r1439 | from time import sleep | ||
|
r1506 | import os | ||
|
r1437 | |||
class PipedProcess(Thread): | ||||
|
r1457 | """ Class that encapsulates process execution by using callbacks for | ||
stdout, stderr and stdin, and providing a reliable way of | ||||
killing it. | ||||
""" | ||||
|
r1437 | |||
|
r4872 | def __init__(self, command_string, out_callback, | ||
|
r1437 | end_callback=None,): | ||
|
r1457 | """ command_string: the command line executed to start the | ||
|
r4872 | process. | ||
|
r1457 | |||
out_callback: the python callable called on stdout/stderr. | ||||
end_callback: an optional callable called when the process | ||||
finishes. | ||||
These callbacks are called from a different thread as the | ||||
thread from which is started. | ||||
""" | ||||
|
r1437 | self.command_string = command_string | ||
self.out_callback = out_callback | ||||
self.end_callback = end_callback | ||||
Thread.__init__(self) | ||||
|
r4872 | |||
|
r1437 | |||
def run(self): | ||||
""" Start the process and hook up the callbacks. | ||||
""" | ||||
|
r1506 | env = os.environ | ||
env['TERM'] = 'xterm' | ||||
|
r1662 | process = Popen(self.command_string + ' 2>&1', shell=True, | ||
|
r1506 | env=env, | ||
|
r1437 | universal_newlines=True, | ||
|
r1450 | stdout=PIPE, stdin=PIPE, ) | ||
|
r1437 | self.process = process | ||
while True: | ||||
out_char = process.stdout.read(1) | ||||
|
r1439 | if out_char == '': | ||
if process.poll() is not None: | ||||
# The process has finished | ||||
break | ||||
else: | ||||
# The process is not giving any interesting | ||||
# output. No use polling it immediatly. | ||||
sleep(0.1) | ||||
else: | ||||
self.out_callback(out_char) | ||||
|
r1437 | |||
if self.end_callback is not None: | ||||
self.end_callback() | ||||
|
r4872 | |||
|
r1437 | |||