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

如何编写兼容同步与异步函数的零重复代码装饰器

梦宇同学_2272

梦宇同学_2272

发布时间:2026-04-25 23:50:12

|

419人浏览过

|

来源于php中文网

原创

如何编写兼容同步与异步函数的零重复代码装饰器

本文介绍一种巧妙利用协程 send() 机制的 Python 装饰器实现,仅用一套核心逻辑即可统一处理 def 和 async def 函数,彻底消除传统双分支写法中的代码重复,并保持类型安全与运行时正确性。

本文介绍一种巧妙利用协程 `send()` 机制的 python 装饰器实现,仅用一套核心逻辑即可统一处理 `def` 和 `async def` 函数,彻底消除传统双分支写法中的代码重复,并保持类型安全与运行时正确性。

在 Python 中为同步与异步函数编写通用装饰器时,常见方案需分别定义 def decorated(...) 和 async def decorated(...),导致“前置逻辑”“后置逻辑”等核心行为被复制两次——不仅违反 DRY 原则,更易引入维护偏差与类型注解不一致问题。

本文提供一个真正零逻辑重复的解决方案:统一使用 async def 定义装饰器内层函数,并通过 coroutine.send(None) 同步驱动协程完成,绕过事件循环依赖。其核心思想源于 CPython 社区对协程底层行为的洞察:任何 async def 函数返回的协程对象是可迭代的,调用 .send(None) 即可启动并执行至首个 await(若无 await 则直接完成并抛出 StopIteration)。

以下是完整、生产就绪的实现:

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]]]:
    """精确判断 func 是否为协程函数(支持 functools.partial 和 async __call__)"""
    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 is not None 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("协程未正常结束:请勿在同步路径中使用 asyncio.* 或 await")  # mypy 兼容占位

        return decorated_sync

    return decorated  # 异步路径直接返回协程函数

✅ 关键优势:

  • ✅ 零业务逻辑重复:Before / result = ... / After 等所有装饰逻辑仅书写一次,位于 async def decorated 内;
  • ✅ 类型安全:借助 TypeGuard 和 ParamSpec + TypeVar,完美保留原始函数签名与返回类型;
  • ✅ 无缝兼容:支持普通函数、async def、带 functools.partial 的函数,甚至含 async __call__ 的可调用对象。

⚠️ 重要限制与注意事项:

  • 同步调用路径(即 decorated_sync)不可访问事件循环:asyncio.sleep()、await aiohttp.get() 等均会崩溃。所有异步操作必须严格限定在 if not is_sync: 分支内;
  • 推荐仅在装饰器的“横切逻辑”(如日志、计时、参数校验、结果包装)中使用此模式;若需复杂异步 I/O,应明确区分 sync/async 装饰器;
  • 生产环境建议增加 @overload 声明或 typing.runtime_checkable 协议增强 IDE 支持。

使用示例:

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

@decorator
async def async_call() -> str:
    await asyncio.sleep(0.1)
    return "async"

# 在异步上下文中混合调用
async def main():
    print(sync_call())          # → "sync"
    print(await async_call())   # → "async"

asyncio.run(main())

输出清晰印证双路径正确性:

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

该方案以少量底层协程知识为代价,换取了装饰器逻辑的极致简洁与可维护性——是 Python 高级装饰器设计中兼具巧思与实用性的典范实践。

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

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

WorkBuddy

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

火山引擎

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

咔片AIPPT

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

DeepSeek

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

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

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

1831

2023.07.20

python能做什么
python能做什么

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

4884

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29117

2023.08.03

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

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

3487

2023.08.04

python eval
python eval

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

3487

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

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

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