Python怎么编写一个装饰器_Python装饰器原理与实战开发

Python装饰器核心是函数作为一等公民和闭包机制,通过@语法在不修改原函数代码的情况下为其添加新功能,如日志、权限控制、缓存等,提升代码复用性和可维护性。

python怎么编写一个装饰器_python装饰器原理与实战开发

Python装饰器,说白了,就是一种特殊函数,它能接收一个函数作为输入,然后给这个函数增加一些额外功能,最终返回一个全新的函数。它就像给你的老朋友穿上了一件新衣服,朋友还是那个朋友,但现在他可能更酷、更强大了,而且这一切都发生在不改变朋友本身代码的前提下。用起来很方便,一个

@

符号就能搞定。

解决方案

编写一个Python装饰器,核心在于理解函数作为一等公民的特性以及闭包的概念。最基础的装饰器,通常是一个接收函数、定义一个内部包装函数、然后返回这个包装函数的高阶函数。

我们先从一个最简单的例子开始。假设我们想在每次调用某个函数之前和之后都打印一些信息,但又不想每次都手动加

print

import functoolsdef log_calls(func):    """    这是一个简单的装饰器,用于记录函数被调用的信息。    """    @functools.wraps(func) # 这一行很重要,它能保留原函数的元信息,比如函数名、文档字符串等。    def wrapper(*args, **kwargs):        print(f"--- 函数 '{func.__name__}' 即将被调用 ---")        # 执行原函数        result = func(*args, **kwargs)        print(f"--- 函数 '{func.__name__}' 调用完毕,返回值为: {result} ---")        return result    return wrapper# 现在,我们用这个装饰器来装饰一个函数@log_callsdef add(a, b):    """一个简单的加法函数。"""    print(f"正在执行 add({a}, {b})")    return a + b@log_callsdef greet(name, greeting="Hello"):    """向指定的人打招呼。"""    print(f"正在执行 greet('{name}', '{greeting}')")    return f"{greeting}, {name}!"# 调用被装饰的函数print("调用 add(5, 3):")sum_result = add(5, 3)print(f"add 函数的最终结果是: {sum_result}n")print("调用 greet('Alice'):")greet_result = greet("Alice")print(f"greet 函数的最终结果是: {greet_result}n")print("调用 greet('Bob', greeting='Hi'):")greet_result_hi = greet("Bob", greeting="Hi")print(f"greet 函数的最终结果是: {greet_result_hi}n")# 如果没有 @log_calls 语法糖,手动装饰是这样的:# original_add = add# add = log_calls(original_add)# print(add(1, 2))

在这个例子里,

log_calls

就是我们的装饰器。它接收一个函数

func

,内部定义了一个

wrapper

函数,

wrapper

函数负责在调用

func

前后添加逻辑,并最终返回

func

的执行结果。最后,

log_calls

返回这个

wrapper

函数。当我们把

@log_calls

放在

add

函数上方时,Python解释器其实做了一件等价于

add = log_calls(add)

的事情,也就是说,

add

这个名字现在指向的不再是原来的加法函数,而是

log_calls

返回的那个

wrapper

函数。

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

functools.wraps

非常关键,它能把原函数的一些重要元信息(比如

__name__

__doc__

__module__

等)复制到

wrapper

函数上。如果没有它,当你调试或者查看

add.__name__

时,你会发现它变成了

wrapper

,而不是

add

,这会给调试带来不小的麻烦。

Python装饰器的核心工作原理是什么?

在我看来,理解Python装饰器的核心,主要抓住两点:函数是“一等公民”闭包

首先,Python中的函数是“一等公民”(First-Class Citizen)。这意味着函数可以像普通变量一样被赋值给其他变量,可以作为参数传递给其他函数,也可以作为其他函数的返回值。正是因为这个特性,我们才能把一个函数(被装饰的函数)传给另一个函数(装饰器),让装饰器对它进行操作。

其次,也是更关键的一点,是闭包(Closure)。当我们定义

log_calls

装饰器时,它内部的

wrapper

函数引用了外部

log_calls

函数的参数

func

。当

log_calls

执行完毕并返回

wrapper

时,即使

log_calls

的局部作用域已经消失,

wrapper

函数仍然能够“记住”并访问到它被创建时所处的环境中的

func

变量。这种机制就是闭包。

所以,当Python解释器看到

@log_calls

装饰器语法糖时,它会做以下几步:

定义时执行:

add

函数被定义时,

log_calls(add)

会被立即调用。返回包装函数:

log_calls

函数执行,它接收

add

作为参数

func

,然后定义并返回一个名为

wrapper

的新函数。替换原函数: 此时,

add

这个名字不再指向原始的

add

函数,而是指向

log_calls

返回的那个

wrapper

函数。调用时执行: 当你之后调用

add(5, 3)

时,实际执行的是

wrapper(5, 3)

wrapper

函数内部会先打印一些信息,然后通过闭包机制访问到它“记住”的原始

add

函数,并调用它,获取结果,最后再打印一些信息,并将结果返回。

整个过程巧妙地实现了在不修改原函数代码的情况下,为其添加新功能,这在很多场景下都非常有用,比如日志、权限控制、性能测量等等。

装饰器在实际项目中能解决哪些常见问题

实际开发中,装饰器简直是“万金油”,能优雅地解决很多跨领域、重复性的问题。它避免了代码的重复,让业务逻辑更聚焦。

日志记录与调试 (Logging & Debugging): 这是最常见的用途。我们经常需要知道哪个函数在什么时候被调用了,传入了什么参数,返回了什么结果,或者执行了多久。一个通用的日志装饰器能完美解决这些需求,而不需要在每个函数内部都写一堆

print

logging

语句。

import timeimport logginglogging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')def log_and_time(func):    @functools.wraps(func)    def wrapper(*args, **kwargs):        logging.info(f"Calling {func.__name__} with args: {args}, kwargs: {kwargs}")        start_time = time.time()        result = func(*args, **kwargs)        end_time = time.time()        logging.info(f"{func.__name__} finished in {end_time - start_time:.4f}s. Result: {result}")        return result    return wrapper@log_and_timedef complex_calculation(x, y):    time.sleep(0.1) # 模拟耗时操作    return x * y + 10complex_calculation(10, 20)

权限校验与认证 (Authentication & Authorization): 在Web应用中,很多视图函数都需要检查用户是否已登录,或者是否有足够的权限来访问某个资源。把这些检查逻辑封装成装饰器,能让视图函数专注于处理业务逻辑,而不是权限验证

def requires_admin(func):    @functools.wraps(func)    def wrapper(user, *args, **kwargs):        if not user.is_authenticated:            raise PermissionError("User not logged in.")        if not user.is_admin:            raise PermissionError("User does not have admin privileges.")        return func(user, *args, **kwargs)    return wrapperclass User:    def __init__(self, name, authenticated=False, admin=False):        self.name = name        self.is_authenticated = authenticated        self.is_admin = admin@requires_admindef delete_user_data(current_user, user_id):    print(f"Admin '{current_user.name}' deleting data for user {user_id}")    return True# try:#     admin_user = User("Alice", authenticated=True, admin=True)#     delete_user_data(admin_user, 123)#     guest_user = User("Bob", authenticated=True, admin=False)#     delete_user_data(guest_user, 456)# except PermissionError as e:#     print(e)

缓存 (Caching): 对于那些计算成本高昂且结果相对稳定的函数,我们可以用装饰器来缓存其返回值。当函数再次被相同的参数调用时,直接返回缓存结果,避免重复计算。

from functools import lru_cache@lru_cache(maxsize=None) # Python内置的LRU缓存装饰器def fibonacci(n):    if n < 2:        return n    return fibonacci(n-1) + fibonacci(n-2)# 第一次计算会比较慢print(fibonacci(30))# 第二次计算(相同参数)会非常快,因为结果已被缓存print(fibonacci(30))

重试机制 (Retry Mechanism): 当调用外部服务或执行可能失败的操作时,我们可能需要自动重试几次。一个重试装饰器可以优雅地处理这种场景。

import timeimport randomdef retry(max_attempts=3, delay=1):    def decorator_retry(func):        @functools.wraps(func)        def wrapper(*args, **kwargs):            for attempt in range(1, max_attempts + 1):                try:                    return func(*args, **kwargs)                except Exception as e:                    print(f"Attempt {attempt} failed: {e}")                    if attempt < max_attempts:                        time.sleep(delay)            raise Exception(f"Function {func.__name__} failed after {max_attempts} attempts.")        return wrapper    return decorator_retry@retry(max_attempts=5, delay=0.5)def unstable_api_call():    if random.random() < 0.7: # 70%的几率失败        raise ConnectionError("Simulated API connection error.")    return "Data fetched successfully!"# print(unstable_api_call()) # 尝试调用,可能会重试几次

参数验证 (Argument Validation): 在函数内部对参数进行类型或值检查,可以用装饰器来集中处理,保持函数体的简洁。

这些例子只是冰山一角,装饰器在Web框架(如Flask、Django路由装饰器)、ORM(如SQLAlchemy的事件监听)、以及各种库中都扮演着重要角色,极大地提高了代码的复用性和可维护性。

编写带参数的装饰器有哪些技巧和注意事项?

带参数的装饰器,相比不带参数的,多了一层嵌套。这其实是理解装饰器更深一步的关键。

当装饰器本身需要接收参数时,它就不能直接返回

wrapper

函数了。它需要先接收自己的参数,然后返回一个真正的装饰器函数,这个装饰器函数再接收被装饰的函数,最后返回

wrapper

。听起来有点绕,但看代码就清楚了。

import functoolsdef repeat(num_times):    """    一个带参数的装饰器,让被装饰的函数重复执行指定次数。    `num_times` 是装饰器自身的参数。    """    def decorator_repeat(func): # 这一层是真正的装饰器,它接收被装饰的函数        @functools.wraps(func)        def wrapper(*args, **kwargs): # 这一层是包装函数,它执行原函数            print(f"--- 函数 '{func.__name__}' 将重复执行 {num_times} 次 ---")            results = []            for i in range(num_times):                print(f"  执行第 {i+1} 次...")                result = func(*args, **kwargs)                results.append(result)            print(f"--- 函数 '{func.__name__}' 执行完毕 ---")            # 通常只返回最后一次执行的结果,或者根据需求返回所有结果            return results[-1] if results else None        return wrapper    return decorator_repeat # 装饰器函数返回的是真正的装饰器@repeat(num_times=3) # 这里 num_times=3 就是装饰器的参数def say_hello(name):    print(f"Hello, {name}!")    return f"Hello result for {name}"print("调用 say_hello('Charlie'):")final_result = say_hello("Charlie")print(f"say_hello 函数的最终结果是: {final_result}n")@repeat(num_times=2)def calculate_power(base, exp):    res = base ** exp    print(f"{base}^{exp} = {res}")    return resprint("调用 calculate_power(2, 3):")power_result = calculate_power(2, 3)print(f"calculate_power 函数的最终结果是: {power_result}n")

技巧和注意事项:

多一层嵌套: 最直观的变化就是多了一层函数嵌套。外层函数

repeat

接收装饰器的参数(如

num_times

),它返回的是内层函数

decorator_repeat

decorator_repeat

才是那个接收被装饰函数

func

的“真正的”装饰器。

执行时机:

@repeat(num_times=3)

这行代码,首先会执行

repeat(num_times=3)

repeat

函数会立即执行,并返回

decorator_repeat

这个函数对象。然后,Python解释器再用

decorator_repeat

去装饰

say_hello

函数,即执行

say_hello = decorator_repeat(say_hello)

。所以,带参数的装饰器,它的参数是在定义被装饰函数时就确定了的,而不是在调用被装饰函数时才确定。

functools.wraps

的位置:

functools.wraps(func)

应该放在最内层的

wrapper

函数上,因为它负责将

func

的元信息复制到最终被返回的

wrapper

函数上。

参数传递: 装饰器参数(如

num_times

)通过闭包机制,被

decorator_repeat

wrapper

函数“记住”并使用。

类作为装饰器: 除了函数,类也可以作为装饰器。如果一个类实现了

__call__

方法,它就可以被用作装饰器。当类被用作装饰器时,类的实例就是那个“包装函数”。

class CountCalls:    def __init__(self, func):        functools.update_wrapper(self, func) # 类似 functools.wraps        self.func = func        self.num_calls = 0    def __call__(self, *args, **kwargs):        self.num_calls += 1        print(f"函数 '{self.func.__name__}' 已被调用 {self.num_calls} 次")        return self.func(*args, **kwargs)@CountCallsdef say_whee():    print("Whee!")# say_whee() # 第一次调用# say_whee() # 第二次调用

类装饰器在需要维护状态(如上面的调用次数)时非常方便,因为状态可以直接存储在实例属性中。带参数的类装饰器也同样需要多一层嵌套,即外层函数返回一个类实例。

理解这些,就能更灵活地运用装饰器,为你的Python代码注入更多“魔力”和可维护性。

以上就是Python怎么编写一个装饰器_Python装饰器原理与实战开发的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1372968.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月14日 12:47:03
下一篇 2025年12月14日 12:47:22

相关推荐

  • Uniapp 中如何不拉伸不裁剪地展示图片?

    灵活展示图片:如何不拉伸不裁剪 在界面设计中,常常需要以原尺寸展示用户上传的图片。本文将介绍一种在 uniapp 框架中实现该功能的简单方法。 对于不同尺寸的图片,可以采用以下处理方式: 极端宽高比:撑满屏幕宽度或高度,再等比缩放居中。非极端宽高比:居中显示,若能撑满则撑满。 然而,如果需要不拉伸不…

    2025年12月24日
    400
  • 如何让小说网站控制台显示乱码,同时网页内容正常显示?

    如何在不影响用户界面的情况下实现控制台乱码? 当在小说网站上下载小说时,大家可能会遇到一个问题:网站上的文本在网页内正常显示,但是在控制台中却是乱码。如何实现此类操作,从而在不影响用户界面(UI)的情况下保持控制台乱码呢? 答案在于使用自定义字体。网站可以通过在服务器端配置自定义字体,并通过在客户端…

    2025年12月24日
    800
  • 如何在地图上轻松创建气泡信息框?

    地图上气泡信息框的巧妙生成 地图上气泡信息框是一种常用的交互功能,它简便易用,能够为用户提供额外信息。本文将探讨如何借助地图库的功能轻松创建这一功能。 利用地图库的原生功能 大多数地图库,如高德地图,都提供了现成的信息窗体和右键菜单功能。这些功能可以通过以下途径实现: 高德地图 JS API 参考文…

    2025年12月24日
    400
  • 如何使用 scroll-behavior 属性实现元素scrollLeft变化时的平滑动画?

    如何实现元素scrollleft变化时的平滑动画效果? 在许多网页应用中,滚动容器的水平滚动条(scrollleft)需要频繁使用。为了让滚动动作更加自然,你希望给scrollleft的变化添加动画效果。 解决方案:scroll-behavior 属性 要实现scrollleft变化时的平滑动画效果…

    2025年12月24日
    000
  • 如何为滚动元素添加平滑过渡,使滚动条滑动时更自然流畅?

    给滚动元素平滑过渡 如何在滚动条属性(scrollleft)发生改变时为元素添加平滑的过渡效果? 解决方案:scroll-behavior 属性 为滚动容器设置 scroll-behavior 属性可以实现平滑滚动。 html 代码: click the button to slide right!…

    2025年12月24日
    500
  • 如何选择元素个数不固定的指定类名子元素?

    灵活选择元素个数不固定的指定类名子元素 在网页布局中,有时需要选择特定类名的子元素,但这些元素的数量并不固定。例如,下面这段 html 代码中,activebar 和 item 元素的数量均不固定: *n *n 如果需要选择第一个 item元素,可以使用 css 选择器 :nth-child()。该…

    2025年12月24日
    200
  • 使用 SVG 如何实现自定义宽度、间距和半径的虚线边框?

    使用 svg 实现自定义虚线边框 如何实现一个具有自定义宽度、间距和半径的虚线边框是一个常见的前端开发问题。传统的解决方案通常涉及使用 border-image 引入切片图片,但是这种方法存在引入外部资源、性能低下的缺点。 为了避免上述问题,可以使用 svg(可缩放矢量图形)来创建纯代码实现。一种方…

    2025年12月24日
    100
  • 如何解决本地图片在使用 mask JS 库时出现的跨域错误?

    如何跨越localhost使用本地图片? 问题: 在本地使用mask js库时,引入本地图片会报跨域错误。 解决方案: 要解决此问题,需要使用本地服务器启动文件,以http或https协议访问图片,而不是使用file://协议。例如: python -m http.server 8000 然后,可以…

    2025年12月24日
    200
  • 如何让“元素跟随文本高度,而不是撑高父容器?

    如何让 元素跟随文本高度,而不是撑高父容器 在页面布局中,经常遇到父容器高度被子元素撑开的问题。在图例所示的案例中,父容器被较高的图片撑开,而文本的高度没有被考虑。本问答将提供纯css解决方案,让图片跟随文本高度,确保父容器的高度不会被图片影响。 解决方法 为了解决这个问题,需要将图片从文档流中脱离…

    2025年12月24日
    000
  • 为什么 CSS mask 属性未请求指定图片?

    解决 css mask 属性未请求图片的问题 在使用 css mask 属性时,指定了图片地址,但网络面板显示未请求获取该图片,这可能是由于浏览器兼容性问题造成的。 问题 如下代码所示: 立即学习“前端免费学习笔记(深入)”; icon [data-icon=”cloud”] { –icon-cl…

    2025年12月24日
    200
  • 如何利用 CSS 选中激活标签并影响相邻元素的样式?

    如何利用 css 选中激活标签并影响相邻元素? 为了实现激活标签影响相邻元素的样式需求,可以通过 :has 选择器来实现。以下是如何具体操作: 对于激活标签相邻后的元素,可以在 css 中使用以下代码进行设置: li:has(+li.active) { border-radius: 0 0 10px…

    2025年12月24日
    100
  • 如何模拟Windows 10 设置界面中的鼠标悬浮放大效果?

    win10设置界面的鼠标移动显示周边的样式(探照灯效果)的实现方式 在windows设置界面的鼠标悬浮效果中,光标周围会显示一个放大区域。在前端开发中,可以通过多种方式实现类似的效果。 使用css 使用css的transform和box-shadow属性。通过将transform: scale(1.…

    2025年12月24日
    200
  • 为什么我的 Safari 自定义样式表在百度页面上失效了?

    为什么在 Safari 中自定义样式表未能正常工作? 在 Safari 的偏好设置中设置自定义样式表后,您对其进行测试却发现效果不同。在您自己的网页中,样式有效,而在百度页面中却失效。 造成这种情况的原因是,第一个访问的项目使用了文件协议,可以访问本地目录中的图片文件。而第二个访问的百度使用了 ht…

    2025年12月24日
    000
  • 如何用前端实现 Windows 10 设置界面的鼠标移动探照灯效果?

    如何在前端实现 Windows 10 设置界面中的鼠标移动探照灯效果 想要在前端开发中实现 Windows 10 设置界面中类似的鼠标移动探照灯效果,可以通过以下途径: CSS 解决方案 DEMO 1: Windows 10 网格悬停效果:https://codepen.io/tr4553r7/pe…

    2025年12月24日
    000
  • 使用CSS mask属性指定图片URL时,为什么浏览器无法加载图片?

    css mask属性未能加载图片的解决方法 使用css mask属性指定图片url时,如示例中所示: mask: url(“https://api.iconify.design/mdi:apple-icloud.svg”) center / contain no-repeat; 但是,在网络面板中却…

    2025年12月24日
    000
  • 如何用CSS Paint API为网页元素添加时尚的斑马线边框?

    为元素添加时尚的斑马线边框 在网页设计中,有时我们需要添加时尚的边框来提升元素的视觉效果。其中,斑马线边框是一种既醒目又别致的设计元素。 实现斜向斑马线边框 要实现斜向斑马线间隔圆环,我们可以使用css paint api。该api提供了强大的功能,可以让我们在元素上绘制复杂的图形。 立即学习“前端…

    2025年12月24日
    000
  • 图片如何不撑高父容器?

    如何让图片不撑高父容器? 当父容器包含不同高度的子元素时,父容器的高度通常会被最高元素撑开。如果你希望父容器的高度由文本内容撑开,避免图片对其产生影响,可以通过以下 css 解决方法: 绝对定位元素: .child-image { position: absolute; top: 0; left: …

    2025年12月24日
    000
  • 使用 Mask 导入本地图片时,如何解决跨域问题?

    跨域疑难:如何解决 mask 引入本地图片产生的跨域问题? 在使用 mask 导入本地图片时,你可能会遇到令人沮丧的跨域错误。为什么会出现跨域问题呢?让我们深入了解一下: mask 框架假设你以 http(s) 协议加载你的 html 文件,而当使用 file:// 协议打开本地文件时,就会产生跨域…

    2025年12月24日
    200
  • CSS 帮助

    我正在尝试将文本附加到棕色框的左侧。我不能。我不知道代码有什么问题。请帮助我。 css .hero { position: relative; bottom: 80px; display: flex; justify-content: left; align-items: start; color:…

    2025年12月24日 好文分享
    200
  • 前端代码辅助工具:如何选择最可靠的AI工具?

    前端代码辅助工具:可靠性探讨 对于前端工程师来说,在HTML、CSS和JavaScript开发中借助AI工具是司空见惯的事情。然而,并非所有工具都能提供同等的可靠性。 个性化需求 关于哪个AI工具最可靠,这个问题没有一刀切的答案。每个人的使用习惯和项目需求各不相同。以下是一些影响选择的重要因素: 立…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信