【Python】(八)列表生成式、迭代器、生成器、装饰器2

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 【Python】(八)列表生成式、迭代器、生成器、装饰器2

4.装饰器


由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。

>>> def now():
...     print('2015-3-25')
...
>>> f = now
>>> f()
2015-3-25


函数对象有一个__name__属性,可以拿到函数的名字:

>>> now.__name__
'now'
>>> f.__name__
'now'


现在,假设我们要增强now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。


本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:

def log(func):
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return wrapper


观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:

@log
def now():
    print('2015-3-25')


调用now()函数,不仅会运行now()函数本身,还会在运行now()函数前打印一行日志:

>>> now()
call now():
2015-3-25


把@log放到now()函数的定义处,相当于执行了语句:

now = log(now)


由于log()是一个decorator,返回一个函数,所以,原来的now()函数仍然存在,只是现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即在log()函数中返回的wrapper()函数。


wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数。


如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:

def log(text):
    def decorator(func):
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return decorator


这个3层嵌套的decorator用法如下:

@log('execute')
def now():
    print('2015-3-25')


执行结果如下:

>>> now()
execute now():
2015-3-25


和两层嵌套的decorator相比,3层嵌套的效果是这样的:

>>> now = log('execute')(now)


我们来剖析上面的语句,首先执行log('execute'),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数。


以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__等属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的'now'变成了'wrapper':

>>> now.__name__
'wrapper'


因为返回的那个wrapper()函数名字就是'wrapper',所以,需要把原始函数的__name__等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。


不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:

import functools
def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return wrapper


或者针对带参数的decorator:

import functools
def log(text):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return decorator


import functools是导入functools模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。


总结


在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。


decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。


请编写一个decorator,能在函数调用的前后打印出'begin call'和'end call'的日志。


再思考一下能否写出一个@log的decorator,使它既支持:

@log
def f():
    pass


又支持:

@log('execute')
def f():
    pass
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
1天前
|
Python
python之列表生成式
python之列表生成式
|
1天前
|
设计模式 开发者 Python
Python中的装饰器:从入门到精通
【9月更文挑战第25天】本文深入浅出地介绍了Python装饰器的使用,包括其定义、语法和实际应用。通过实例演示如何利用装饰器增强函数功能,同时探讨了装饰器的高级用法如带参数的装饰器和装饰器嵌套。最后,文章强调了在设计装饰器时应避免的常见陷阱。
|
1天前
|
设计模式 Python
深入浅出Python装饰器
【9月更文挑战第25天】装饰器在Python中是改变函数或类行为的利器,它们通过简洁的语法糖为代码增添功能。本文将一步步揭开装饰器的神秘面纱,从基础概念出发,到实战应用,最后探讨其背后的原理。你将学会如何用装饰器简化代码、增加功能,甚至控制函数执行流程,让编程更加高效和优雅。
|
1天前
|
设计模式 缓存 中间件
探索Python中的装饰器:从入门到实践
【9月更文挑战第25天】本文通过直观的语言和生动的比喻,深入浅出地介绍Python装饰器的概念、原理及应用。我们将一起走进装饰器的魔法世界,解锁其在代码编写中的强大功能,让你的代码更加优雅和高效。
|
2天前
|
Python
Python中的装饰器:简化你的代码
【9月更文挑战第24天】本文旨在通过Python装饰器的介绍和示例,帮助读者理解和掌握这一强大的工具。我们将从装饰器的基本概念出发,逐步深入到其实现原理,并通过实际代码示例展示如何利用装饰器优化和简化代码结构。文章将避免使用复杂的专业术语,确保内容通俗易懂,同时保持逻辑清晰,让初学者也能轻松上手。
|
1天前
|
设计模式 测试技术 开发者
探索Python中的装饰器:从基础到高级应用
本文旨在深入探讨Python中一个强大而灵活的特性——装饰器(Decorators)。通过逐步解析其工作原理、常见用法以及如何自定义装饰器,我们希望帮助读者不仅能够理解装饰器的基本概念,还能掌握如何在实际编程中高效利用这一工具来优化代码结构、增强程序的可读性和可维护性。无论是Python初学者还是经验丰富的开发者,都能在本文中找到有价值的信息和启示。
|
1天前
|
设计模式 Python
探索Python的装饰器:从基础到高级应用
在本文中,我们将深入探讨Python中的装饰器,这是一种强大而灵活的工具,可以修改或增强函数和类的行为。通过逐步解析其工作原理、常见用法以及一些高级技巧,我们希望帮助读者更好地理解和利用装饰器来编写简洁且高效的代码。
|
2天前
|
存储 算法 Java
关于python3的一些理解(装饰器、垃圾回收、进程线程协程、全局解释器锁等)
该文章深入探讨了Python3中的多个重要概念,包括装饰器的工作原理、垃圾回收机制、进程与线程的区别及全局解释器锁(GIL)的影响等,并提供了详细的解释与示例代码。
9 0
|
4月前
|
Python
【Python操作基础】——字典,迭代器和生成器
【Python操作基础】——字典,迭代器和生成器
|
2月前
|
Python
python解包迭代器或生成器
【7月更文挑战第1天】
27 3