Python 和 Windows 命名管道

Question

在 Windows 上通过 Python 与命名管道进行通信的正确方法是什么？我用谷歌搜索了它，但找不到任何包含此通信的包。

有：

• 一些关于如何使用 pywin32 进行操作的描述（不过，我找不到如何使用它连接到现有管道）。
• 这个包：https://pypi.python.org/pypi/PyWPipe/（也没有运气）
• 这里有一段代码，我还没有测试过：http://jonathonreinhart.blogspot.ru/2012/12/named-pipes-between-c-and-python.html

我只需要连接到现有的命名管道并对其进行读/写。我以前只尝试过与串口通信（使用 pySerial），我很惊讶与它相比，我在命名管道上能找到的信息很少。通常有大量的 Python 指南。

我将不胜感激。

Answer 1

为了连接到现有的命名管道，您可以使用通过pywin32 包提供的CreateFile API。因为我花了一段时间才把一个工作基础放在一起，所以这里有一个示例客户端/服务器，它对我来说很好用（python 3.6.5，Windows 10 Pro x64 上的 pywin32 223）：

import time
import sys
import win32pipe, win32file, pywintypes


def pipe_server():
    print("pipe server")
    count = 0
    pipe = win32pipe.CreateNamedPipe(
        r'\\.\pipe\Foo',
        win32pipe.PIPE_ACCESS_DUPLEX,
        win32pipe.PIPE_TYPE_MESSAGE | win32pipe.PIPE_READMODE_MESSAGE | win32pipe.PIPE_WAIT,
        1, 65536, 65536,
        0,
        None)
    try:
        print("waiting for client")
        win32pipe.ConnectNamedPipe(pipe, None)
        print("got client")

        while count < 10:
            print(f"writing message {count}")
            # convert to bytes
            some_data = str.encode(f"{count}")
            win32file.WriteFile(pipe, some_data)
            time.sleep(1)
            count += 1

        print("finished now")
    finally:
        win32file.CloseHandle(pipe)


def pipe_client():
    print("pipe client")
    quit = False

    while not quit:
        try:
            handle = win32file.CreateFile(
                r'\\.\pipe\Foo',
                win32file.GENERIC_READ | win32file.GENERIC_WRITE,
                0,
                None,
                win32file.OPEN_EXISTING,
                0,
                None
            )
            res = win32pipe.SetNamedPipeHandleState(handle, win32pipe.PIPE_READMODE_MESSAGE, None, None)
            if res == 0:
                print(f"SetNamedPipeHandleState return code: {res}")
            while True:
                resp = win32file.ReadFile(handle, 64*1024)
                print(f"message: {resp}")
        except pywintypes.error as e:
            if e.args[0] == 2:
                print("no pipe, trying again in a sec")
                time.sleep(1)
            elif e.args[0] == 109:
                print("broken pipe, bye bye")
                quit = True


if __name__ == '__main__':
    if len(sys.argv) < 2:
        print("need s or c as argument")
    elif sys.argv[1] == "s":
        pipe_server()
    elif sys.argv[1] == "c":
        pipe_client()
    else:
        print(f"no can do: {sys.argv[1]}")

示例输出客户端

> python pipe_test.py c
pipe client
no pipe, trying again in a sec
no pipe, trying again in a sec
no pipe, trying again in a sec
message: (0, b'0')
message: (0, b'1')
message: (0, b'2')
message: (0, b'3')
message: (0, b'4')
message: (0, b'5')
message: (0, b'6')
message: (0, b'7')
message: (0, b'8')
message: (0, b'9')
broken pipe, bye bye

示例输出服务器

> python pipe_test.py s
pipe server
waiting for client
got client
writing message 0
writing message 1
writing message 2
writing message 3
writing message 4
writing message 5
writing message 6
writing message 7
writing message 8
writing message 9
finished now

显然，您需要围绕各种调用进行一些错误检查，但这应该可行。

附加说明：我的一位同事在客户端尝试对其执行 I/O 时遇到了管道关闭的问题（声称“所有管道实例都忙”的例外情况）。原来他是在客户端代码中使用os.path.exists来测试命名管道在运行CreateFile之前是否已经存在。这以某种方式打破了管道。所以使用上面的方法（CreateFile 包裹在一个 try-except 中）是尝试连接到管道直到它被服务器端创建的安全方法。

Answer 2

我在下面的片段中取得了成功。此代码源自CaptureSetup/Pipes — Python on Windows — Wireshark Wiki。它需要来自pywin32 包的win32pipe 和win32file。

# pipename should be of the form \\.\pipe\mypipename
pipe = win32pipe.CreateNamedPipe(
        pipename,
        win32pipe.PIPE_ACCESS_OUTBOUND,
        win32pipe.PIPE_TYPE_MESSAGE | win32pipe.PIPE_WAIT,
        1, 65536, 65536,
        300,
        None)
try:
    win32pipe.ConnectNamedPipe(pipe, None)

    while True:
        some_data = b'12345...'
        win32file.WriteFile(pipe, some_data)
        ...
finally:
    win32file.CloseHandle(pipe)

我不知道它关闭管道的方式是否 100% 正确。

您提到了The Perils and Triumphs of Being a Geek: Named Pipes between C# and Python—Jonathon Reinhart。我试过了，但它无法创建命名管道。我想知道该代码是否仅适用于打开已由另一个进程创建的命名管道。