讲师中心 微信公众号
AI工具推荐 视频效率加速

Python 中实现同步与异步函数通用装饰器的无重复代码方案

夏杰姑娘_9099

夏杰姑娘_9099

发布时间:2026-04-26 22:36:04

|

888人浏览过

|

来源于php中文网

原创

本文介绍一种巧妙利用协程 send() 方法特性的装饰器设计,使单个装饰器逻辑同时支持 def 和 async def 函数,彻底避免传统双分支写法中的前后置逻辑重复。

本文介绍一种巧妙利用协程 `send()` 方法特性的装饰器设计,使单个装饰器逻辑同时支持 `def` 和 `async def` 函数,彻底避免传统双分支写法中的前后置逻辑重复。

在 Python 装饰器开发中,一个常见痛点是:为同时兼容同步函数(def)和异步函数(async def),开发者往往被迫编写两套几乎完全相同的逻辑——仅因调用方式不同(result = func(...) vs result = await func(...)),导致“执行前”“执行后”等核心逻辑被重复书写,违背 DRY 原则,也增加维护成本。

上述问题的优雅解法在于统一以异步方式编写装饰器主体,并通过协程的底层机制在同步上下文中安全驱动其执行。关键洞察来自 CPython 的一个实践:async def 函数返回的是一个协程对象(Coroutine),而协程对象是可迭代的——它实现了 __iter__ 和 send() 方法;对刚创建的协程调用 .send(None) 会启动执行,直到遇到第一个 await(若无 await,则直接运行至完成并抛出 StopIteration,其 value 即为返回值)。这意味着:一个纯 async def decorated(...) 可以在不依赖事件循环的前提下,被同步函数安全“驱动”完成。

以下是完整、类型安全、生产可用的实现:

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]]]:
    """精确判断函数是否为协程函数(支持 functools.partial 和 async __call__)"""
    # 解包 functools.partial
    while isinstance(func, functools.partial):
        func = func.func
    if asyncio.iscoroutinefunction(func):
        return True
    if hasattr(func, "__call__"):
        # 支持定义了 async __call__ 的类实例
        call_method = getattr(func, "__call__", None)
        if call_method and asyncio.iscoroutinefunction(call_method):
            return True
    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("Decorator internal error: coroutine did not terminate cleanly")

        return decorated_sync

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

✅ 核心优势:所有装饰逻辑(如日志、计时、参数校验、结果转换等)只需编写一次,位于 decorated 函数体内,天然消除重复。

立即学习“Python免费学习笔记(深入)”;

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载

⚠️ 重要限制与最佳实践:

  • 当 func 是同步函数时,decorated 内部不可使用任何需事件循环的 asyncio 功能(如 asyncio.sleep、asyncio.create_task、await 其他协程等),否则会抛出 RuntimeError: no running event loop。
  • 所有共享逻辑(Before/After 块)应严格保持同步;异步专属操作(如 await asyncio.sleep(0.1))必须包裹在 if not is_sync: 条件内。
  • 该方案兼容 functools.partial 和支持 async __call__ 的可调用对象,鲁棒性高。

使用示例:

@decorator
def sync_call() -> str:
    time.sleep(0.1)
    return "sync"

@decorator
async def async_call() -> str:
    await asyncio.sleep(0.1)  # ✅ 此处安全,因 is_sync=False
    return "async"

# 混合调用
async def run():
    res1 = sync_call()           # → 同步执行,输出 Before/After
    print(res1)                  # "sync"
    res2 = await async_call()    # → 异步执行,输出 Before/After
    print(res2)                  # "async"

asyncio.run(run())

输出:

Before
After with result='sync'
sync
Before
After with result='async'
async

此方案在 MyPy 严格模式下类型安全(在线验证),兼顾简洁性、可维护性与工程健壮性,是构建通用型跨范式装饰器的推荐范式。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1691

2023.07.20

python能做什么
python能做什么

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

4264

2023.07.25

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

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

1689

2023.07.31

python教程
python教程

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

24757

2023.08.03

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

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

3027

2023.08.04

python eval
python eval

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

3047

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn