如何编写兼容同步与异步函数的零重复逻辑 Python 装饰器

雨明姑娘_4411

雨明姑娘_4411

2026-04-25

545人浏览

原创

本文介绍一种巧妙利用协程 send() 方法特性的装饰器实现方案,避免在同步/异步分支中重复编写“前置处理→调用原函数→后置处理”逻辑,真正实现单份核心逻辑、双模式无缝适配。

本文介绍一种巧妙利用协程 send() 方法特性的装饰器实现方案,避免在同步/异步分支中重复编写“前置处理→调用原函数→后置处理”逻辑,真正实现单份核心逻辑、双模式无缝适配。

在 Python 中为同步(def)和异步(async def)函数编写统一装饰器时,常见做法是通过 asyncio.iscoroutinefunction() 分支判断,再分别定义 async def decorated(...) 和 def decorated(...) —— 但这导致前置/后置逻辑被完全复制两次,违背 DRY 原则,也增加维护成本。

幸运的是,Python 协程对象具有可迭代性:一个 async def 函数返回的协程对象支持 .send(None) 触发执行,并在首次 await 或协程结束时抛出 StopIteration 异常,其 value 属性即为返回值。这一特性使我们能以同步方式“驱动”协程完成,无需事件循环参与 —— 从而将异步装饰器逻辑“复用”于同步场景。

以下是无代码重复的通用装饰器实现:

import asyncio
import typing as t
import functools
import time

R = t.TypeVar("R")
P = t.ParamSpec("P")


def is_coroutine(
    func: t.Callable[P, t.Any]
) -> t.TypeGuard[t.Callable[P, t.Coroutine[t.Any, t.Any, t.Any]]]:
    """精确判断是否为协程函数(支持 partial 和 __call__ 类)"""
    while isinstance(func, functools.partial):
        func = func.func
    if asyncio.iscoroutinefunction(func):
        return True
    if hasattr(func, "__call__"):
        return asyncio.iscoroutinefunction(func.__call__)
    return False


def decorator(func: t.Callable[P, R]) -> t.Callable[P, R]:
    is_sync = not is_coroutine(func)

    @functools.wraps(func)
    async def decorated(*args: P.args, **kwargs: P.kwargs) -> R:
        print("Before")  # ✅ 共享前置逻辑(仅写一次)
        result = func(*args, **kwargs)
        if not is_sync:
            result = await t.cast(t.Awaitable[R], result)
        print(f"After with {result=}")  # ✅ 共享后置逻辑(仅写一次)
        return result

    if is_sync:
        # 同步路径:用 send(None) 驱动协程,捕获 StopIteration 获取结果
        @functools.wraps(func)
        def decorated_sync(*args: P.args, **kwargs: P.kwargs) -> R:
            coro = decorated(*args, **kwargs)
            try:
                coro.send(None)  # 启动协程
            except StopIteration as e:
                return t.cast(R, e.value)  # 提取返回值
            raise RuntimeError("Unexpected coroutine state")  # mypy 友好兜底
        return decorated_sync

    return decorated  # 异步路径直接返回协程装饰器

✅ 关键优势与使用说明

  • 零逻辑重复:Before / After 等共用逻辑仅在 async def decorated 中定义一次;

    Python Testing
    Python Testing

    Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

    下载
  • 类型安全:借助 TypeGuard 和 ParamSpec + TypeVar,完整保留原函数签名与泛型类型;

  • 兼容类方法:is_coroutine 支持检测含 async def __call__ 的可调用类;

  • 开箱即用:

    @decorator
    def sync_call() -> str:
        time.sleep(0.1)
        return "sync"
    
    @decorator
    async def async_call() -> str:
        await asyncio.sleep(0.1)
        return "async"
    
    # 调用方式与原函数一致
    print(sync_call())           # → "sync"
    print(asyncio.run(async_call()))  # → "async"

⚠️ 重要注意事项

  • 禁止在同步路径中使用 asyncio 功能:当 is_sync=True 时,协程在无事件循环环境下运行,所有依赖 asyncio.get_event_loop() 或 await 的代码(如 asyncio.sleep, aiohttp)将崩溃;
  • 安全实践:所有共享逻辑(Before/After)应保持同步;异步操作(如日志异步写入、DB 查询)必须包裹在 if not is_sync: 分支内;
  • 调试友好:print(f"{is_sync=}") 可帮助快速验证模式识别是否正确。

该方案本质是将“装饰逻辑”升维至协程层面,再通过运行时驱动机制桥接同步世界,是 Python 协程底层机制的一次优雅应用。它不仅解决重复代码问题,更体现了对语言特性的深度理解与工程化抽象能力。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1631

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3964

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1629

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

22757

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2787

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2827

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1123

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2203

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程