Python装饰器用法实例总结
本文系统总结Python装饰器的核心用法。从装饰器定义、日志记录场景出发,详解语法糖@的使用、带参/无参函数的适配、functools.wraps修复元数据,以及类装饰器的优雅实现。通过完整代码示例,帮助开发者掌握装饰器在权限校验、缓存等切面编程中的应用。
本文通过具体实例深入解析Python装饰器的使用方法,旨在为读者提供清晰的参考与学习路径。
一、装饰器是什么
Python中的装饰器本质上是一个函数,其核心作用是在不修改原有函数代码的前提下,为其增加额外功能。装饰器的返回值依然是一个函数对象。简而言之,装饰器就是一个接收函数并返回新函数的工具。
装饰器常用于处理切面逻辑,例如插入日志记录、性能测试、事务管理、缓存机制或权限校验等场景。它是解决此类问题的理想设计模式,能够抽离与核心业务无关的重复代码,实现代码重用。
概括而言,装饰器的主要功能是为已存在的对象添加额外的行为或功能。
二、为什么需要装饰器
1、先来看一个简单例子:
def foo():
print('i am foo')
2、增加需求
假设现在需要记录函数的执行日志,我们可以在代码中直接添加日志打印语句:
def foo():
print('i am foo')
print("foo is running")
3、又有需求
如果现在有100个函数都需要增加日志记录功能,且后续可能还需要在函数执行前打印日志,难道要逐个修改代码吗?
显然不可取,这会导致大量重复代码。为了减少冗余,我们可以重新定义一个函数:专门用于处理日志逻辑,在日志处理完毕后,再执行真正的业务代码。
def use_logging(func):
print("%s is running" % func.__name__)
func()
def bar():
print('i am bar')
use_logging(bar)
#result:
#bar is running
#i am bar
通过上述use_logging函数,我们成功增加了日志功能。无论未来有多少函数需要添加或修改日志格式,只需调整use_logging函数,并调用use_logging(被装饰的函数)即可实现预期效果。
def use_logging(func):
print("%s is running" % func.__name__)
return func
@use_logging
def bar():
print('i am bar')
bar()
三、基础装饰器入门
1、装饰器语法糖
Python提供了@符号作为装饰器的语法糖,使应用装饰器更加便捷。但使用语法糖要求装饰函数必须返回一个函数对象。因此,我们将上面的func函数用内嵌函数包裹并返回:
装饰器的执行过程相当于先执行装饰函数use_logging,再返回被装饰函数bar。因此,调用bar()时相当于执行了两个函数,等价于use_logging(bar)()。
def use_logging(func):
def _deco():
print("%s is running" % func.__name__)
func()
return _deco
@use_logging
def bar():
print('i am bar')
bar()
2、对带参数的函数进行装饰
若被装饰函数需要传入两个参数并计算结果,我们需要对内层函数进行修改以接收这两个参数a和b,这等价于调用use_logging(bar)(1,2)。
def use_logging(func):
def _deco(a,b):
print("%s is running" % func.__name__)
func(a,b)
return _deco
@use_logging
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,2)
被装饰的函数参数数量和类型可能各不相同,每次修改装饰器显然不科学。因此,我们使用Python的变长参数*args和**kwargs来解决参数传递问题。
3、函数参数数量不确定
不带参数的装饰器版本,该格式适用于不带参数的装饰器场景。
经过以下修改,我们已经能够适应各种长度和类型的参数。这个版本的装饰器可以处理任意类型的无参数函数。
def use_logging(func):
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar(a,b):
print('i am bar:%s'%(a+b))
@use_logging
def foo(a,b,c):
print('i am bar:%s'%(a+b+c))
bar(1,2)
foo(1,2,3)
4、装饰器带参数
带参数的装饰器,该格式适用于需要向装饰器本身传递参数的场景。
某些情况下,我们需要让装饰器携带参数,这就需要编写一个返回装饰器的高阶函数,实现起来相对复杂。例如:
#! /usr/bin/env python
# -*- coding:utf-8 -*-
# __author__ = "TKQ"
def use_logging(level):
def _deco(func):
def __deco(*args, **kwargs):
if level == "warn":
print "%s is running" % func.__name__
return func(*args, **kwargs)
return __deco
return _deco
@use_logging(level="warn")
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)
# 等价于use_logging(level="warn")(bar)(1,3)
5、functools.wraps
使用装饰器极大地复用了代码,但它有一个缺点:原函数的元信息(如docstring、__name__、参数列表)会丢失。先看例子:
def use_logging(func):
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()
#bar is running
#i am bar
#_deco
#函数名变为_deco而不是bar,这个情况在使用反射的特性的时候就会造成问题。因此引入了functools.wraps解决这个问题。
使用functools.wraps修复元信息:
import functools
def use_logging(func):
@functools.wraps(func)
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()
#result:
#bar is running
#i am bar
#bar ,这个结果是我们想要的。OK啦!
6、实现带参数和不带参数的装饰器自适应
import functools
def use_logging(arg):
if callable(arg):#判断参入的参数是否是函数,不带参数的装饰器调用这个分支
@functools.wraps(arg)
def _deco(*args,**kwargs):
print("%s is running" % arg.__name__)
arg(*args,**kwargs)
return _deco
else:#带参数的装饰器调用这个分支
def _deco(func):
@functools.wraps(func)
def __deco(*args, **kwargs):
if arg == "warn":
print "warn%s is running" % func.__name__
return func(*args, **kwargs)
return __deco
return _deco
@use_logging("warn")
# @use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()
三、类装饰器
使用类装饰器可以实现带参数装饰器的效果,且实现方式更加优雅简洁,同时可以通过继承灵活扩展功能。
1、类装饰器
class loging(object):
def __init__(self,level="warn"):
self.level = level
def __call__(self,func):
@functools.wraps(func)
def _deco(*args, **kwargs):
if self.level == "warn":
self.notify(func)
return func(*args, **kwargs)
return _deco
def notify(self,func):
# logit只打日志,不做别的
print "%s is running" % func.__name__
@loging(level="warn")#执行__call__方法
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)
2、继承扩展类装饰器
class email_loging(Loging):
'''
一个loging的实现版本,可以在函数调用时发送email给管理员
'''
def __init__(self, email='admin@myproject.com', *args, **kwargs):
self.email = email
super(email_loging, self).__init__(*args, **kwargs)
def notify(self,func):
# 发送一封email到self.email
print "%s is running" % func.__name__
print "sending email to %s" %self.email
@email_loging(level="warn")
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)
更多关于Python相关内容可查看本站专题:《Python数据结构与算法教程》、《Python Socket编程技巧总结》、《Python函数使用技巧总结》、《Python字符串操作技巧汇总》及《Python入门与进阶经典教程》。
希望本文所述内容对大家学习Python程序设计有所帮助。
免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。









