如何创建一个仅支持 with 语句、不支持装饰器用法的上下文管理器

夜杰姑娘_8411

夜杰姑娘_8411

2026-04-30

697人浏览

原创

如何创建一个仅支持 with 语句、不支持装饰器用法的上下文管理器

本文介绍一种标准库兼容的方案,通过封装 contextlib._GeneratorContextManager 并禁用 __call__ 方法,构建出仅可作为上下文管理器(with)、不可用作装饰器(@)的函数,从而在 API 层面杜绝误用。

本文介绍一种标准库兼容的方案,通过封装 `contextlib._generatorcontextmanager` 并禁用 `__call__` 方法,构建出仅可作为上下文管理器(`with`)、不可用作装饰器(`@`)的函数,从而在 api 层面杜绝误用。

Python 的 @contextlib.contextmanager 虽然简洁易用,但其返回对象继承自 contextlib.ContextDecorator,天然支持双重用途:既可作为 with 上下文管理器,也可作为函数装饰器。然而在许多场景中(如资源独占初始化、状态临时切换等),将其用于装饰器会导致逻辑错误或难以调试的副作用——例如意外地将整个函数体包裹进上下文生命周期中,而开发者本意仅是临时进入某环境执行一段代码。

为严格区分语义、强化 API 约束,我们可以构造一个轻量级替代工具 contextmanager_without_decorator。它复用 contextlib 内部已验证的 _GeneratorContextManager(负责核心 __enter__/__exit__ 行为),但通过类型与运行时双重手段移除装饰器能力:

  • 关键技巧:将 __call__ 属性显式设为 None,使实例不可调用;
  • 安全封装:使用 functools.wraps 保留原函数元信息;
  • 类型友好:支持 Python 3.12+ 的 ParamSpec 和协变泛型,确保 IDE 和类型检查器(如 mypy)能正确推导签名。

以下是完整实现(兼容 Python 3.9+,含类型提示):

from __future__ import annotations

import contextlib
import functools
import typing as t

if t.TYPE_CHECKING:
    import collections.abc as cx
    import typing_extensions as tx

    _P = tx.ParamSpec("_P")
    _T_co = t.TypeVar("_T_co", covariant=True)
    _ContextManagerDecoratee: tx.TypeAlias = cx.Callable[
        _P, cx.Generator[_T_co, None, None]
    ]


class _GeneratorContextManager(contextlib._GeneratorContextManager[t.Any]):
    __call__: t.ClassVar[None] = None  # type: ignore[assignment]


def contextmanager_without_decorator(
    func: _ContextManagerDecoratee[_P, _T_co],
) -> t.Callable[_P, _GeneratorContextManager[_T_co]]:
    @functools.wraps(func)
    def helper(*args: _P.args, **kwds: _P.kwargs) -> _GeneratorContextManager[_T_co]:
        return _GeneratorContextManager(func, args, kwds)

    return helper

使用方式与 @contextlib.contextmanager 完全一致,但行为更严格:

@contextmanager_without_decorator
def db_transaction():
    print("BEGIN")
    try:
        yield "transaction_id"
    finally:
        print("COMMIT")

# ✅ 正确:作为上下文管理器使用
with db_transaction() as tx_id:
    print(f"Inside: {tx_id}")

# ❌ 运行时报错:TypeError: 'NoneType' object is not callable
# @db_transaction()
# def risky_function():
#     ...

注意事项:

  • 该方案依赖 contextlib._GeneratorContextManager(虽为“私有”但自 Python 3.7 起稳定且被广泛使用,CPython 源码中明确标注为“供内部和 contextlib.contextmanager 使用”,实际可视为受支持的底层构件);
  • 若需完全避免私有 API,可手动实现 __enter__/__exit__(但会失去 yield 的简洁性与异常传播逻辑);
  • 在单元测试中建议显式验证装饰器调用是否抛出 TypeError,以保障约束有效性。

综上,contextmanager_without_decorator 是一个精准、轻量、类型安全的解决方案:它在零侵入原有开发习惯的前提下,通过最小化修改(仅禁用一个方法),将潜在的误用转化为清晰的运行时错误,显著提升 API 的健壮性与可维护性。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1731

4

python能做什么
python能做什么

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

2023.07.25

4384

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

25617

23

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

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

2023.08.04

3127

5

python eval
python eval

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

2023.08.04

3127

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2443

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习