讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

SoundView
SoundView

字幕擦除翻译、配音口型同步

Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

使用装饰器和字典缓存函数结果:避免 setdefault 的陷阱

夏芳酱_4291

夏芳酱_4291

发布时间:2025-09-23 16:37:01

|

343人浏览过

|

来源于php中文网

原创

使用装饰器和字典缓存函数结果:避免 setdefault 的陷阱

本文旨在帮助读者理解如何使用 Python 装饰器实现函数结果缓存,提高代码执行效率。我们将深入探讨使用 dict.setdefault 方法的潜在问题,并提供一种更健壮的缓存实现方案,包括处理可变参数和关键字参数,以及如何避免全局缓存带来的问题。

装饰器与函数缓存

装饰器是 Python 中一种强大的元编程工具,允许我们在不修改函数本身代码的情况下,增强函数的功能。函数缓存是一种常见的优化技术,通过存储函数调用结果,避免重复计算,从而提高程序性能。

setdefault 的陷阱

最初,我们可能会尝试使用字典的 setdefault 方法来实现缓存。setdefault 的本意是:如果键不存在于字典中,则插入具有指定值的键。然而,在函数缓存的场景下,直接使用 setdefault 可能会导致不必要的函数调用。

考虑以下代码片段:

def wrapper2(*args, **kwargs):
    global cache
    return cache.setdefault(args, func(*args, **kwargs))

这段代码看起来似乎很简洁,但实际上 func(*args, **kwargs) 会在 setdefault 被调用 之前 执行。也就是说,无论 args 是否已经存在于 cache 中,func 都会被调用一次。这违背了缓存的初衷,即避免重复计算。

return cache.setdefault(args, func(*args, **kwargs)) 等价于:

result = func(*args, **kwargs)
return cache.setdefault(args, result)

因此,func 总是在 cache.setdefault 之前被调用。

Python 环境工具基础版
Python 环境工具基础版

管理 Python 项目环境,支持虚拟环境创建、依赖安装与环境诊断

下载

改进的缓存装饰器

为了避免 setdefault 的陷阱,我们需要显式地检查缓存中是否存在结果,如果不存在才调用函数。同时,为了让装饰器更具通用性,我们需要解决以下几个问题:

  1. 避免全局缓存: 每个被装饰的函数应该拥有自己的缓存,而不是共享一个全局缓存。
  2. 处理可变参数和关键字参数: 缓存键需要包含 *args 和 **kwargs 的信息。
  3. 保留原始函数信息: 使用 functools.wraps 装饰器可以保留原始函数的元数据,例如函数名和文档字符串,这对于调试和代码维护非常重要。

以下是一个改进后的缓存装饰器示例:

import functools

def cacheDecorator(func):
    cache = {}  # 每个函数一个缓存

    @functools.wraps(func)  # 保留原始函数信息
    def wrapper(*args, **kwargs):
        # 创建缓存键,包含 args 和 kwargs
        cache_key = (args, tuple(sorted(kwargs.items()))) # Ensure kwargs are consistently ordered
        if cache_key in cache:
            return cache[cache_key]
        else:
            ret_val = func(*args, **kwargs)
            cache[cache_key] = ret_val
            return ret_val

    return wrapper

代码解释:

  1. cache = {}: 在 cacheDecorator 函数内部创建了一个字典 cache,用于存储当前函数的缓存。
  2. @functools.wraps(func): 使用 functools.wraps 装饰器,将原始函数 func 的元数据复制到 wrapper 函数,例如 __name__、__doc__ 等。
  3. cache_key = (args, tuple(sorted(kwargs.items()))): 创建缓存键。这里将 args 和 kwargs 都包含在内。由于字典是无序的,为了确保相同的关键字参数以相同的顺序出现,我们对 kwargs.items() 进行了排序。tuple()的使用是因为字典的键必须是可哈希的,而字典本身是不可哈希的,元组可以作为字典的键。
  4. if cache_key in cache:: 检查缓存中是否存在对应的结果。
  5. return cache[cache_key]: 如果缓存命中,直接返回缓存中的结果。
  6. *`ret_val = func(args, kwargs)`: 如果缓存未命中,调用原始函数 func 计算结果。
  7. cache[cache_key] = ret_val: 将计算结果存储到缓存中。
  8. return ret_val: 返回计算结果。

使用示例:

import time

@cacheDecorator
def expensive_function(a, b, c=1):
    """
    一个耗时的函数,用于演示缓存效果。
    """
    print("Executing expensive_function...")
    time.sleep(2)  # 模拟耗时操作
    return a * b + c

print(expensive_function(1, 2))
print(expensive_function(1, 2))
print(expensive_function(1, 2, c=3)) # Different arguments, so not cached
print(expensive_function(1, 2, c=3)) # Now cached

在这个例子中,expensive_function 只会在第一次调用时执行耗时操作。后续使用相同参数的调用将直接从缓存中获取结果,大大提高了效率。

注意事项

  • 可变数据类型: 如果函数的参数是可变数据类型(例如列表或字典),并且在函数内部被修改,那么缓存可能会失效,因为缓存键对应的对象已经发生了变化。 在这种情况下,应该考虑复制参数,或者避免缓存具有可变参数的函数。
  • 缓存大小限制: 在实际应用中,应该考虑缓存的大小限制,避免占用过多的内存。可以使用 lru_cache 装饰器(functools.lru_cache)来实现带有 LRU (Least Recently Used) 策略的缓存。

总结

通过自定义装饰器,我们可以轻松地为函数添加缓存功能,提高代码执行效率。避免直接使用 setdefault 方法,并注意处理可变参数和关键字参数,可以构建更健壮、更通用的缓存装饰器。 在实际应用中,还需要根据具体情况考虑缓存大小限制和缓存失效策略。

热门AI工具

更多
二狗PPT
二狗PPT Hot

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

咔片AIPPT

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

Laper
Laper Hot

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

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

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

PixTV
PixTV Hot

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

WorkBuddy

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

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

相关专题

更多
数据类型有哪几种
数据类型有哪几种

数据类型有整型、浮点型、字符型、字符串型、布尔型、数组、结构体和枚举等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3631

2023.10.31

php数据类型
php数据类型

本专题整合了php数据类型相关内容,阅读专题下面的文章了解更多详细内容。

574

2025.10.31

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

622

2026.02.12

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1958

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

3264

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6444

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

6709

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

8214

2024.03.22

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

热门下载

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

精品课程

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

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