Python装饰器详解

简介: Python里面,函数可以作为参数传入一个函数,函数也可以复制给变量,通过变量调用函数。装饰器可以扩展一个函数的功能,为函数做一个装饰器注解,可以把装饰器里面定义的功能于所有函数提前执行,提升代码的复用程度。

在Python里面,函数可以作为参数传入一个函数,函数也可以复制给变量,通过变量调用函数。装饰器可以扩展一个函数的功能,为函数做一个装饰器注解,可以把装饰器里面定义的功能于所有函数提前执行,提升代码的复用程度。


现在有这么个场景。


打卡


互联网公司里面有各种员工,程序员,前台...,程序员在打开电脑前,需要打卡,前台要早点来开门(我也不清楚,谁开门,这里假定,前台开门),前台开门前也需要打卡。也就是说,打卡是所有员工的最先的公共动作,那么可以把打卡这个功能抽出来作为公共逻辑。


普通函数调用方法



自然想到,可以实现如下。


def di(f):
    print('%s 打卡,滴...' % f.__name__)
    return f()
def boot():
    print('开机')
def open():
    print('开门')
if __name__ == '__main__':
    """
    程序员开机之前,前台开门之前,都需要先在门外指纹机打卡。
    """
    di(boot)
    di(open)


定义了一个函数di(f),可以打印f.__name__f的函数名信息,同时返回f()的执行结果。


注意:__name__如果作为模块导入,module.__name__就是模块自己的名字,如果模块自己作为脚本执行,返回__main__


执行结果:

boot 打卡,滴...
开机
open 打卡,滴...
开门


这样设计,如果有很多函数都要调用,就很麻烦,那么装饰器就排上了用场。


简单装饰器 与 @语法糖


装饰器:在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。


简单装饰器


定义一个di(f)方法,还是把要执行的逻辑的函数作为参数传入,里面定义一个wrapper函数,返回值是f的执行结果。


if __name__ == '__main__':里面,调用了这个装饰器,不修改定义好了的函数,在运行期间动态添加功能"打卡"。


import functools
# 简单装饰器
def di(f):
    """
    程序员开机之前,前台开门之前,都需要先在门外指纹机打卡。
    :param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡,滴...' % f.__name__)
        return f()
    return wrapper
def boot():
    print('开机')
def open():
    print('开门')
if __name__ == '__main__':
    # 第一种,简单装饰器
    a = di(boot)
    a1 = di(open)
    print(a.__name__) # 结果wrapper 加@functools.wraps(f)后结果为 boot
    a()
    a1()


di(boot)的返回值a就是wrapper函数,通过a()就调用了wrapper函数,得到boot的返回值。同理,di(open)一样。


结果

boot
boot 打卡,滴...
开机
open 打卡,滴...
开门


由于di(boot)的返回值a就是wrapper函数,那么print(a.__name__)的结果就理所当然是是wrapper,我们希望是boot,怎么办,functools.wraps(f)这个注解可以把原始函数boot__name__等属性复制到wrapper(),把这行代码注释也能运行,那么print(a.__name__)的结果就是wrapper


第二种,@ 语法糖


通过@语法糖,也能将装饰器应用于函数上面,推荐。


import functools
def di(f):
    """
    程序员开机之前,前台开门之前,都需要先在门外指纹机打卡。
    :param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到wrapper()
    @functools.wraps(f)
    def wrapper():
        print('%s 打卡,滴...' % f.__name__)
        return f()
    return wrapper
# @ 语法糖
@di
def boot2():
    print('开机')
@di
def open2():
    print('开门')
if __name__ == '__main__':
    # 第二种,@ 语法糖
    boot2()
    open2()


@di标记相当于,a2 = di(boot2) a2()。不用这么麻烦,因为加了@符号标记,直接用boot2()调用装饰器即可。


结果

boot2 打卡,滴...
开机
open2 打卡,滴...
开门


业务逻辑函数需要参数

业务逻辑函数可能需要参数,比如:


def boot(name):
    print('%s 开机' % name)


那么,只需要将前面的装饰器修改为:

import functools
# 业务逻辑函数需要参数
def di(f):
    """
    程序员开机之前,前台开门之前,都需要先在门外指纹机打卡。
    :param f: 传入一个函数
    :return:
    """
    # 把原始函数的__name__等属性复制到wrapper()
    @functools.wraps(f)
    def wrapper(*args, **kwargs):
        print('%s 打卡,滴...' % f.__name__)
        return f(*args, **kwargs)
    return wrapper
@di
def boot(name):
    print('%s 开机' % name)
if __name__ == '__main__':
    boot('keguang')


结果:

boot 打卡,滴...
keguang 开机


wrapper也加上*args, **kwargs参数,在boot里面直接调用f(*args, **kwargs)即可。顺便提一下:


  • *args:可以传入一个数组参数


  • **kwargs:可以传入一个k-v对参数


先后顺序对应,数组参数在前。举例:

def f(*args, **kwargs):
    print('args=', args)
    print('kwargs=', kwargs)
print(f(1, 2, 3, a = 'a', b = 'b'))
# 结果
# args= (1, 2, 3)
# kwargs= {'a': 'a', 'b': 'b'}


带参数的装饰器


如果装饰器也带参数,比如现在如果某个员工早晨上班来得早< 9:00,咱可以做个表扬,那么相当于只需要在前面的di()外面套一层函数,di_args即可,在wrapper里面。使用这个参数


import functools
# 带参数的装饰器
def di_args(time):
    def di(f):
        """
        程序员开机之前,前台开门之前,都需要先在门外指纹机打卡。
        :param f: 传入一个函数
        :return:
        """
        # 把原始函数的__name__等属性复制到wrapper()
        @functools.wraps(f)
        def wrapper(*args, **kwargs):
            if time < '9:00':
                print('来的真早,很棒。。。')
            print('%s 打卡,滴...' % f.__name__)
            return f(*args, **kwargs)
        return wrapper
    return di
@di_args('8:00')
def boot(name):
    print('%s 开机' % name)
if __name__ == '__main__':
    boot('keguang')


参数在@di_args('8:00')传入即可,有点像java里面的注解。最后还是通过boot('keguang')调用即可,结果:

来的真早,很棒。。。
boot 打卡,滴...
keguang 开机


类装饰器


类装饰器主要依靠类的__call__方法,当使用 @ 形式将装饰器附加到函数上时,就会调用此方法。


# 类装饰器
class di(object):
    def __init__(self, f):
        self._f = f
    def __call__(self, *args, **kwargs):
        print('decorator start...')
        self._f()
        print('decorator end...')
@di
def boot():
    print('开机')
if __name__ == '__main__':
    boot()


加上@di装饰器标识,会用boot去实例化di类,然后执行__call__函数,object表示这个类可以传入任何类型参数。


运行结果

decorator start...
开机
decorator end...


装饰器有一个典型的应用场景就是打log日志,如果所有逻辑都需要日志记录程序的运行状况,那么可以对这些逻辑(函数)加日志模块装饰器,就能达到相应目的。

目录
相关文章
|
27天前
|
Python
深入理解Python装饰器:从入门到实践####
本文旨在通过简明扼要的方式,为读者揭开Python装饰器的神秘面纱,从基本概念、工作原理到实际应用场景进行全面解析。不同于常规的摘要仅概述内容概要,本文将直接以一段精炼代码示例开篇,展示装饰器如何优雅地增强函数功能,激发读者探索兴趣,随后深入探讨其背后的机制与高级用法。 ####
51 11
|
23天前
|
设计模式 缓存 开发者
深入浅出Python装饰器
【10月更文挑战第39天】本文将通过浅显易懂的语言和生动的比喻,带你探索Python中一个神奇而又强大的特性——装饰器。我们将一起揭开装饰器的神秘面纱,了解它的工作原理,并通过实际代码示例学习如何应用它来美化我们的代码。无论你是编程新手还是有经验的开发者,这篇文章都将为你打开一扇新的大门,让你的代码更加优雅和高效。
|
23天前
|
缓存 测试技术 数据库
深入理解Python中的装饰器
在本文中,我们将探讨Python语言中一个强大而灵活的特性——装饰器。装饰器允许开发者在不修改原有函数或方法代码的情况下增加额外的功能,这大大提高了代码的复用性和可读性。通过具体示例和应用场景的讲解,本篇文章旨在为读者提供一个关于如何使用装饰器的全面指南,包括装饰器的定义、使用场景、以及如何自定义装饰器等内容。
|
28天前
|
设计模式 Python
掌握Python中的装饰器
【10月更文挑战第34天】装饰器是Python中一种强大的工具,它允许我们在不修改原函数代码的情况下增加其功能。本文通过简单易懂的语言和实例,引导你理解装饰器的概念、种类及其应用,帮助你在编程实践中灵活使用这一高级特性。
|
5天前
|
存储 缓存 Python
Python中的装饰器深度解析与实践
在Python的世界里,装饰器如同一位神秘的魔法师,它拥有改变函数行为的能力。本文将揭开装饰器的神秘面纱,通过直观的代码示例,引导你理解其工作原理,并掌握如何在实际项目中灵活运用这一强大的工具。从基础到进阶,我们将一起探索装饰器的魅力所在。
|
18天前
|
开发框架 缓存 测试技术
Python中的装饰器:魔法般的功能增强
在Python编程中,装饰器是一种强大而灵活的工具,它允许开发者修改或扩展函数和类的行为。本文将深入探讨Python装饰器的工作原理,并通过实例演示如何创建和使用自定义装饰器来增强代码的功能性和可读性。我们将从基础概念讲起,逐步深入到高级应用,揭示装饰器背后的“魔法”,并展示它们在实际开发中的多种用途。
|
24天前
|
缓存 监控 测试技术
Python中的装饰器:功能扩展与代码复用的利器###
本文深入探讨了Python中装饰器的概念、实现机制及其在实际开发中的应用价值。通过生动的实例和详尽的解释,文章展示了装饰器如何增强函数功能、提升代码可读性和维护性,并鼓励读者在项目中灵活运用这一强大的语言特性。 ###
|
27天前
|
缓存 开发者 Python
探索Python中的装饰器:简化代码,增强功能
【10月更文挑战第35天】装饰器在Python中是一种强大的工具,它允许开发者在不修改原有函数代码的情况下增加额外的功能。本文旨在通过简明的语言和实际的编码示例,带领读者理解装饰器的概念、用法及其在实际编程场景中的应用,从而提升代码的可读性和复用性。
|
23天前
|
设计模式 缓存 开发框架
Python中的装饰器:从入门到实践####
本文深入探讨了Python中装饰器的工作原理与应用,通过具体案例展示了如何利用装饰器增强函数功能、提高代码复用性和可读性。读者将学习到装饰器的基本概念、实现方法及其在实际项目开发中的实用技巧。 ####
26 3
|
28天前
|
设计模式 缓存 监控
Python中的装饰器:代码的魔法增强剂
在Python编程中,装饰器是一种强大而灵活的工具,它允许程序员在不修改函数或方法源代码的情况下增加额外的功能。本文将探讨装饰器的定义、工作原理以及如何通过自定义和标准库中的装饰器来优化代码结构和提高开发效率。通过实例演示,我们将深入了解装饰器的应用,包括日志记录、性能测量、事务处理等常见场景。此外,我们还将讨论装饰器的高级用法,如带参数的装饰器和类装饰器,为读者提供全面的装饰器使用指南。