如何确保Python抽象方法的实现必为协程？

在实现子类时，开发者需自行保证抽象方法被定义为协程。如下示例中，基类MyBase定义了抽象方法the_coroutine并期望它是协程，但子类ImplBaseB将其实现为普通函数，导致调用时触发异常：

from abc import ABC, abstractmethod

class MyBase(ABC):
    @abstractmethod
    def the_coroutine(self):
        """
        期望这是一个协程
        """

class ImplBaseA(MyBase):
    async def the_coroutine(self):
        return "awaited"

class ImplBaseB(MyBase):
    def the_coroutine(self):
        # 一个高频触发的条件
        if True:
            raise ValueError("乍一看好像能被await，但实际不是协程")
        return "not the coroutine"

调用时的异常场景：

await a.the_coroutine()
# 正常执行
await b.the_coroutine()
# 抛出异常：不能对普通函数执行await操作

可行解决方案 #

1. 静态类型检查（推荐，最Pythonic） #

使用mypy这类静态类型检查工具，通过给抽象方法标注协程返回类型，在代码编写阶段就发现不符合要求的实现。

修改基类定义，明确标注返回类型：

from abc import ABC, abstractmethod
from typing import Coroutine, Any

class MyBase(ABC):
    @abstractmethod
    def the_coroutine(self) -> Coroutine[Any, Any, str]:
        """
        明确要求返回协程类型
        """

此时若子类用普通函数实现，mypy会直接抛出类型不匹配的错误，无需等到运行时才暴露问题。

2. 运行时校验 #

如果需要在程序运行阶段强制校验，可以在基类的__init_subclass__方法中检查子类方法是否为协程：

from abc import ABC, abstractmethod
import inspect

class MyBase(ABC):
    @abstractmethod
    def the_coroutine(self):
        """
        期望这是一个协程
        """

    def __init_subclass__(cls):
        super().__init_subclass__()
        method = cls.the_coroutine
        if not inspect.iscoroutinefunction(method):
            raise TypeError(f"子类 {cls.__name__} 中的the_coroutine必须是async协程函数")

这样子类在被定义时就会触发校验，不符合要求的实现会直接抛出错误，避免后续调用时才出问题。

3. 自定义抽象协程装饰器 #

通过自定义装饰器标记抽象方法的协程要求，再结合运行时校验：

from abc import ABC, abstractmethod
import inspect

def abstract_coroutine(func):
    func.__is_abstract_coroutine__ = True
    return abstractmethod(func)

class MyBase(ABC):
    @abstract_coroutine
    def the_coroutine(self):
        pass

    def __init_subclass__(cls):
        super().__init_subclass__()
        method = cls.the_coroutine
        if getattr(method, '__is_abstract_coroutine__', False) and not inspect.iscoroutinefunction(method):
            raise TypeError(f"{cls.__name__}.the_coroutine 必须是async协程函数")

这种方式更清晰地表达了基类对方法的协程要求，同时提供运行时的强制校验。

内容的提问来源于stack exchange，提问作者GopherM