python呼叫外部子程式，通過管道實現非同步標準輸入和輸出的

pythontab發表於2014-05-30
Python非同步

我們通常會遇到這樣的需求：通過C++或其他較底層的語言實現了一個複雜的功能模組，需要搭建一個基於Web的Demo，方法查詢資料。由於Python語言的強大和簡潔，其用來搭建Demo非常合適，Flask框架和jinja2模組功能為python提供了方便的web開發能力。同時，python能夠很方便的同其他語言的程式碼互動。因此我們選擇python作為開發Demo的工具。假設我們需要呼叫的模組（提供底層服務）通過標準輸入迴圈讀入資料，處理完畢後把結果寫出到標出輸出，這樣的場景在Linux環境下很常見，依賴於Linux強大的重定向能力。然而，非常不幸的是，底層模組有一個很重的初始化過程，因此我們不能夠每次查詢請求都去重新生成呼叫底層模組的子程式。解決方案就是隻生成一次子程式，然後對每個請求通過管道（pipe）來和子程式互動。

Python的subprocess模組可以很容易地生成子程式，類似Linux系統呼叫fork和exec。subprocess模組的Popen物件可能以非阻塞的方式呼叫外部可執行程式，因此我們使用Poen物件來實現需求。如果我們想要把資料寫入子程式的標準輸入stdin，那麼在建立Popen物件的時候就需要指定引數stdin為subprocess.PIPE；同樣，如果我們需要從子程式的標準輸出中讀取資料，那麼在建立Popen物件的時候就需要指定引數stdout為subprocess.PIPE。先看一個簡單的例子：

from subprocess import Popen, PIPE
p = Popen('less', stdin=PIPE, stdout=PIPE)
p.communicate('Line number %d.\n' % x)

communicate函式返回一個二元組(stdoutdata, stderrdata)，包含了子程式的標準輸出和標出錯誤的輸出資料。然而，由於Popen物件的communicate函式會阻塞父程式，同時還會關閉管道，因此每個Popen物件只能呼叫一次communicate函式，如果有多個請求必須重新生成Popen物件（重新初始化子程式），不能滿足我們的需求。

因此，我們只有往Popen物件的stdin和stdout物件裡寫入和讀取資料才能實現我們的需求。然而，不幸的是subprocess模組預設情況下只執行在子程式結束的時候讀取一次標準輸出。Both subprocess and os.popen* only allow input and output one time, and the output to be read only when the process terminates. 

進過一番研究之後我發現通過fcntl模組的fcntl函式可以把子程式的標準輸出改為非阻塞的方式，從而達到我們的目的。這樣困擾我許久的問題終於得到了完美解決。程式碼如下：

#!/usr/bin/python                                                                                                                                                      
# -*- coding: utf-8 -*-
# author: weisu.yxd@taobao.com
from subprocess import Popen, PIPE
import fcntl, os
import time
class Server(object):
  def __init__(self, args, server_env = None):
    if server_env:
      self.process = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE, env=server_env)
    else:
      self.process = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE)
    flags = fcntl.fcntl(self.process.stdout, fcntl.F_GETFL)
    fcntl.fcntl(self.process.stdout, fcntl.F_SETFL, flags | os.O_NONBLOCK)
  def send(self, data, tail = '\n'):
    self.process.stdin.write(data + tail)
    self.process.stdin.flush()
  def recv(self, t=.1, e=1, tr=5, stderr=0):
    time.sleep(t)
    if tr < 1:
        tr = 1 
    x = time.time()+t
    r = ''
    pr = self.process.stdout
    if stderr:
      pr = self.process.stdout
    while time.time() < x or r:
        r = pr.read()
        if r is None:
            if e:
                raise Exception(message)
            else:
                break
        elif r:
            return r.rstrip()
        else:
            time.sleep(max((x-time.time())/tr, 0))
    return r.rstrip()
if __name__ == "__main__":
  ServerArgs = ['/home/weisu.yxd/QP/trunk/bin/normalizer', '/home/weisu.yxd/QP/trunk/conf/stopfile.txt']
  server = Server(ServerArgs)
  test_data = '在雲端', '雲梯', '摩薩德', 'Alisa', 'iDB', '阿里大資料'
  for x in test_data:
    server.send(x)
    print x, server.recv()

 另外，呼叫一些外部程式時，可能需要指定相應的環境變數，方式如下：

  my_env = os.environ
  my_env["LD_LIBRARY_PATH"] = "/path/to/lib"
  server = server.Server(cmd, my_env)


相關文章