如何使用 urwid 和 asyncio 使长任务不受阻塞？

Question

我正在编写一个 Python 诅咒应用程序，该应用程序通过分别通过进程'stdin和发送和接收字符串来控制外部（Linux，如果有帮助）进程stdout。该接口使用urwid. 我编写了一个类来控制外部进程，并为一些 urwid 组件编写了一些其他类。

我还有一个按钮，应该向外部进程发送命令。但是，该过程不会立即响应，其任务通常需要长达几秒钟的时间，在此期间我希望界面不要冻结。

这是我运行子进程的方式：

def run(self, args):
    import io, fcntl, os
    from subprocess import Popen, PIPE

    # Run wpa_cli with arguments, use a thread to feed the process with an input queue
    self._pss = Popen(["wpa_cli"] + args, stdout=PIPE, stdin=PIPE)
    self.stdout = io.TextIOWrapper(self._pss.stdout, encoding="utf-8")
    self.stdin = io.TextIOWrapper(self._pss.stdin, encoding="utf-8", line_buffering=True)

    # Make the process' stdout a non-blocking file
    fd = self.stdout.fileno()
    fl = fcntl.fcntl(fd, fcntl.F_GETFL)
    fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK)
    ...

我必须使进程的输出流非阻塞才能解析其输出。我不知道这对我的问题是否重要。

以下是我用来控制子进程输入和输出流的方法：

def read(self, parser=None, transform=None, sentinel='>'):
    """ Reads from the controlled process' standard output until a sentinel
    is found. Optionally execute a callable object with every line. Parsed
    lines are placed in a list, which the function returns upon exiting. """

    if not transform:
        transform = lambda str: str

    def readline():
        return transform(self.stdout.readline().strip())

    # Keep a list of (non-empty) parsed lines
    items = []
    for line in iter(readline, sentinel):
        if callable(parser):
            item = parser(line)
            if item is not None:
                items.append(item)
    return items

def send(self, command, echo=True):
    """ Sends a command to the controlled process. Action commands are
    echoed to the standard output. Argument echo controls whether or not
    they're removed by the reader function before parsing. """

    print(command, file=self.stdin)

    # Should we remove the echoed command?
    if not echo:
        self.read(sentinel=command)

我谈到的按钮只是从主脚本输入函数设置了它的回调。该回调应该向子进程发送命令并循环遍历结果输出行，直到找到给定的文本，在这种情况下回调函数退出。在此之前，该过程会输出一些我需要捕捉并显示在用户界面中的有趣信息。

例如：

def button_callback():
    # This is just an illustration

    filter = re.compile('(event1|event2|...)')

    def formatter(text):
        try:
            return re.search(filter, text).group(1)
        except AttributeError:
            return text

    def parser(text):
        if text == 'event1':
            # Update the info Text accordingly
        if text == 'event2':
            # Update the info Text accordingly

    controller.send('command')
    controller.read(sentinel='beacon', parser=parser, transform=formatter)

需要注意的是：

• 该read()函数旋转（我找不到另一种方式），即使过程输出流是静默的，直到从（可选）解析的行中读取标记值，
• urwid 界面在按钮回调函数退出之前不会刷新，这会阻止urwid的主循环刷新屏幕。

我可以使用一个线程，但是从我读过urwid的支持asyncio，这就是我想实现什么。您可以称我为笨蛋，因为即使在浏览urwidasyncio 示例和阅读 Pythonasyncio文档之后，我也无法清楚地弄清楚如何。

鉴于有改变任何这些方法的空间，我仍然希望保持进程控制类 - 即包含read()和send()- 尽可能通用的类。

到目前为止，我没有尝试过导致界面在进程繁忙时更新。接收进程“通知”的组件是一个普通的urwid.Text()小部件。

Answer 1

首先有两件事：

• 你不一定需要 asyncio 来用 urwid 做异步事情，因为它已经有一个简单的事件循环，通常已经足够好了，它有处理许多 IO 场景的原语。

• 在编写异步代码时，您需要小心编写同步代码，例如那些循环直到找到哨兵值的函数，因为它会阻止任何其他代码（包括事件循环本身）执行：这意味着 UI 将冻结，直到找到哨兵值为止函数返回

对于您的情况，您可能可以使用默认的简单事件循环并使用该MainLoop.watch_pipe方法，该方法创建一个准备在子进程中使用的管道（已经将其置于异步/非阻塞模式，顺便说一句:)）并接受回调当有新数据写入管道时调用。

这是一个使用它的简单示例，显示 shell 命令的输出，同时保持 UI 非阻塞（注意，因为懒惰而使用一些全局变量）：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import print_function, absolute_import, division
import subprocess
import urwid


def show_or_exit(key):
    if key in ('q', 'Q', 'esc'):
        raise urwid.ExitMainLoop()


def update_text(read_data):
    text.set_text(text.text + read_data)


def enter_idle():
    loop.remove_watch_file(pipe.stdout)


if __name__ == '__main__':
    widget = urwid.Pile([
        urwid.Button('Here is a button'),
        urwid.Button('And here another button'),
        urwid.Button('One more, just to be sure'),
        urwid.Button("Heck, let's add yet another one!"),
    ])
    text = urwid.Text('PROCESS OUTPUT:\n')
    widget = urwid.Columns([widget, text])
    widget = urwid.Filler(widget, 'top')

    loop = urwid.MainLoop(widget, unhandled_input=show_or_exit)
    stdout = loop.watch_pipe(update_text)
    stderr = loop.watch_pipe(update_text)
    pipe = subprocess.Popen('for i in $(seq 50); do echo -n "$i "; sleep 0.5; done',
                            shell=True, stdout=stdout, stderr=stderr)
    loop.run()

请注意回调中的代码如何update_text没有理由阻塞：它获取读取的数据，更新组件，仅此而已。没有 while 循环等待其他事情发生。

在您的情况下，您可能需要调整解析输出的函数wpa_cli，以便它们也没有理由阻止。例如，当他们找到或没有找到有趣的哨兵值时，他们可以设置一些变量或其他信号，而不是等待循环直到找到该值。

我希望这是有道理的，如果您需要澄清某些事情，请告诉我！:)