60

在阅读了 Eli Bendersky关于通过 Python 协程实现状态机的文章后，我想...

  • 查看他在 Python3 下运行的示例
  • 并为生成器添加适当的类型注释

我成功地完成了第一部分（但没有使用async defs 或yield froms，我基本上只是移植了代码 - 所以任何改进都是最受欢迎的）。

但我需要一些协程类型注释方面的帮助：

#!/usr/bin/env python3

from typing import Callable, Generator

def unwrap_protocol(header: int=0x61,
                    footer: int=0x62,
                    dle: int=0xAB,
                    after_dle_func: Callable[[int], int]=lambda x: x,
                    target: Generator=None) -> Generator:
    """ Simplified protocol unwrapping co-routine."""
    #
    # Outer loop looking for a frame header
    #
    while True:
        byte = (yield)
        frame = []  # type: List[int]

        if byte == header:
            #
            # Capture the full frame
            #
            while True:
                byte = (yield)
                if byte == footer:
                    target.send(frame)
                    break
                elif byte == dle:
                    byte = (yield)
                    frame.append(after_dle_func(byte))
                else:
                    frame.append(byte)


def frame_receiver() -> Generator:
    """ A simple co-routine "sink" for receiving full frames."""
    while True:
        frame = (yield)
        print('Got frame:', ''.join('%02x' % x for x in frame))

bytestream = bytes(
    bytearray((0x70, 0x24,
               0x61, 0x99, 0xAF, 0xD1, 0x62,
               0x56, 0x62,
               0x61, 0xAB, 0xAB, 0x14, 0x62,
               0x7)))

frame_consumer = frame_receiver()
next(frame_consumer)  # Get to the yield

unwrapper = unwrap_protocol(target=frame_consumer)
next(unwrapper)  # Get to the yield

for byte in bytestream:
    unwrapper.send(byte)

这运行正常...

$ ./decoder.py 
Got frame: 99afd1
Got frame: ab14

...还有类型检查：

$ mypy --disallow-untyped-defs decoder.py 
$

但我很确定我可以做得比只Generator在类型规范中使用基类更好（就像我为Callable. 我知道它需要 3 个类型参数 ( Generator[A,B,C])，但我不确定它们在此处的具体指定方式。

欢迎任何帮助。

4

3 回答 3

70

我自己想出了答案。

我进行了搜索，但在 Python 3.5.2Generator的官方打字文档中没有找到 3 个类型参数的文档——除了真正神秘地提到...

class typing.Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])

幸运的是，最初的 PEP484（开始了这一切）更有帮助：

“生成器函数的返回类型可以通过 typing.py 模块提供的泛型 Generator[yield_type, send_type, return_type] 进行注解：

def echo_round() -> Generator[int, float, str]:
    res = yield
    while res:
        res = yield round(res)
    return 'OK'

基于此，我能够注释我的生成器，并mypy确认我的任务：

from typing import Callable, Generator

# A protocol decoder:
#
# - yields Nothing
# - expects ints to be `send` in his yield waits
# - and doesn't return anything.
ProtocolDecodingCoroutine = Generator[None, int, None]

# A frame consumer (passed as an argument to a protocol decoder):
#
# - yields Nothing
# - expects List[int] to be `send` in his waiting yields
# - and doesn't return anything.
FrameConsumerCoroutine = Generator[None, List[int], None]


def unwrap_protocol(header: int=0x61,
                    footer: int=0x62,
                    dle :int=0xAB,
                    after_dle_func: Callable[[int], int]=lambda x: x,
                    target: FrameConsumerCoroutine=None) -> ProtocolDecodingCoroutine:
    ...

def frame_receiver() -> FrameConsumerCoroutine:
    ...

我通过例如交换类型的顺序来测试我的作业 - 然后如预期的那样mypy抱怨并要求正确的作业（如上所示）。

完整的代码可以从这里访问。

我将把这个问题留几天，以防有人想插话——尤其是在使用 Python 3.5 的新协程样式（async def等）方面——我希望能得到关于它们的确切使用方式的提示这里。

于 2016-07-17T16:25:17.693 回答
44

如果您有一个简单的函数 using yield，那么您可以使用该Iterator类型来注释其结果，而不是Generator：

from typing import Iterator

def count_up() -> Iterator[int]:
    for x in range(10):
        yield x
于 2019-09-13T03:06:57.893 回答
7

在撰写本文时，Python 文档也明确提到了如何处理异步案例（已接受的答案中已经提到了非异步示例）。

从那里引用：

async def echo_round() -> AsyncGenerator[int, float]:
    sent = yield 0
    while sent >= 0.0:
        rounded = await round(sent)
        sent = yield rounded

（第一个参数是 yield-type，第二个是 send-type）或者对于简单的情况（其中 send-type 是 None）

async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)
于 2021-03-15T10:02:49.250 回答