Python装饰器基础概念与用法详解


Posted in Python onDecember 22, 2018

本文实例讲述了Python装饰器基础概念与用法。分享给大家供大家参考,具体如下:

装饰器基础

前面快速介绍了装饰器的语法,在这里,我们将深入装饰器内部工作机制,更详细更系统地介绍装饰器的内容,并学习自己编写新的装饰器的更多高级语法。

什么是装饰器

装饰是为函数和类指定管理代码的一种方式。Python装饰器以两种形式呈现:

【1】函数装饰器在函数定义的时候进行名称重绑定,提供一个逻辑层来管理函数和方法或随后对它们的调用。
【2】类装饰器在类定义的时候进行名称重绑定,提供一个逻辑层来管理类,或管理随后调用它们所创建的实例。

简而言之,装饰器提供了一种方法,在函数和类定义语句的末尾插入自动运行的代码——对于函数装饰器,在def的末尾;对于类装饰器,在class的末尾。这样的代码可以扮演不同的角色。

装饰器提供了一些和代码维护性和审美相关的有点。此外,作为结构化工具,装饰器自然地促进了代码封装,这减少了冗余性并使得未来变得更容易。

函数装饰器

通过在一个函数的def语句的末尾运行另一个函数,把最初的函数名重新绑定到结果。

用法

装饰器在紧挨着定义一个函数或方法的def语句之前的一行编写,并且它由@符号以及紧随其后的对于元函数的一个引用组成——这是管理另一个函数的一个函数(或其他可调用对象)。

在编码上,函数装饰器自动将如下语法:

@decorator
def F(arg):
  ...
F(99)

映射为这个对等形式:

def F(arg):
  ...
F = decorator(F)
F(99)

这里的装饰器是一个单参数的可调用对象,它返回与F具有相同数目的参数的一个可调用对象。

当随后调用F函数的时候,它自动调用装饰器所返回的对象。

换句话说,装饰实际把如下的第一行映射为第二行(尽管装饰器只在装饰的时候运行一次)

fun(6,7)
decorator(func)(6,7)

这一自动名称重绑定也解释了之前介绍的静态方法和property装饰器语法的原因:

class C:
  @staticmethod
  def meth(...):...
  @property
  def name(self):...

实现

装饰器自身是返回可调用对象的可调用对象。实际上,它可以是任意类型的可调用对象,并且返回任意类型的可调用对象:函数和类的任何组合都可以使用,尽管一些组合更适合于特定的背景。

有一种常用的编码模式——装饰器返回了一个包装器,包装器把最初的函数保持到一个封闭的作用域中:

def decorator(F):
  def wrapper(*args):
    # 使用 F 和 *args
    # 调用原来的F(*args)
  return wrapper
@decorator
def func(x,y):
  ...
func(6,7)

当随后调用名称func的时候,它确实调用装饰器所返回的包装器函数;随后包装器函数可能运行最初的func,因为它在一个封闭的作用域中仍然可以使用。

为了对类做同样的事情,我们可以重载调用操作:

class decorator:
  def __init__(self,func):
    self.func = func
  def __call__(self,*args):
    # 使用self.func和args
    # self.func(*args)调用最初的func
@decorator
def func(x,y):
  ...
func(6,7)

但是,要注意的是,基于类的代码中,它对于拦截简单函数有效,但当它应用于类方法函数时,并不很有效:

如下反例:

class decorator:
  def __init__(self,func):
    self.func = func
  def __call__(self,*args):
    # 调用self.func(*args)失败,因为C实例参数无法传递
class C:
  @decorator
  def method(self,x,y):
    ...

这时候装饰的方法重绑定到一个类的方法上,而不是一个简单的函数,这一点带来的问题是,当装饰器的方法__call__随后运行的时候,其中的self接受装饰器类实例,并且类C的实例不会包含到一个*args中。

这时候,嵌套函数的替代方法工作得更好:

def decorator:
  def warpper(*args):
    # ...
  return wrapper
@decorator
def func(x,y):
  ...
func(6,7)
class C:
  @decorator
  def method(self,x,y):
    ...
x = C()
x.method(6,7)

类装饰器

类装饰器与函数装饰器使用相同的语法和非常相似的编码方式。类装饰器是管理类的一种方式,或者用管理或扩展类所创建的实例的额外逻辑,来包装实例构建调用。

用法

假设类装饰器返回一个可调用对象的一个单参数的函数,类装饰器的语法为:

@decorator
class C:
  ...
x = C(99)

等同于下面的语法:

class C:
  ...
C = decorator(C)
x = C(99)

直接效果是随后调用类名会创建一个实例,该实例会触发装饰器所返回的可调用对象,而不是调用最初的类自身。

实现

类装饰器返回的可调用对象,通常创建并返回最初的类的一个新的实例,以某种方式来扩展对其接口的管理。例如,下面的实例插入一个对象来拦截一个类实例的未定义的属性:

def decorator(cls):
  class Wrapper:
    def __init__(self,*args):
      self.wrapped = cls(*args)
    def __getattr__(self,name):
      return getattr(self.wrapped,name)
  return Wrapper
@decorator
class C:        # C = decorator(C)
  def __init__(self,x,y):    # Run by Wrapper.__init__
    self.attr = 'spam'
x = C(6,7)        # 等价于Wrapper(6,7)
print(x.attr)

在这个例子中,装饰器把类的名称重新绑定到另一个类,这个类在一个封闭的作用域中保持了最初的类。

就像函数装饰器一样,类装饰器通常可以编写为一个创建并返回可调用对象的“工厂”函数。

装饰器嵌套

有时候,一个装饰器不够,装饰器语法允许我们向一个装饰器的函数或方法添加包装器逻辑的多个层。这种形式的装饰器的语法为:

@A
@B
@C
def f(...):
  ...

如下这样转换:

def f(...):
  ...
f = A(B(C(f)))

这里,最初的函数通过3个不同的装饰器传递,每个装饰器处理前一个结果。

装饰器参数

函数装饰器和类装饰器都能接受参数,如下:

@decorator(A,B)
def F(arg):
  ...
F(99)

自动映射到其对等形式:

def F(arg):
  ...
F = decorator(A,B)(F)
F(99)

装饰器参数在装饰之前就解析了,并且它们通常用来保持状态信息供随后的调用使用。例如,这个例子中的装饰器函数,可能采用如下形式:

def decorator(A,B):
  # 保存或使用A和B
  def actualDecorator(F):
    # 保存或使用函数 F
    # 返回一个可调用对象
    return callable
  return actualDecorator

以上,这是装饰器的基础知识,接下来将学习编写自己的装饰器

更多关于Python相关内容可查看本站专题:《Python数据结构与算法教程》、《Python Socket编程技巧总结》、《Python函数使用技巧总结》、《Python字符串操作技巧汇总》及《Python入门与进阶经典教程》

希望本文所述对大家Python程序设计有所帮助。

Python 相关文章推荐
Python中模拟enum枚举类型的5种方法分享
Nov 22 Python
python脚本作为Windows服务启动代码详解
Feb 11 Python
浅谈Series和DataFrame中的sort_index方法
Jun 07 Python
IntelliJ IDEA安装运行python插件方法
Dec 10 Python
对python判断是否回文数的实例详解
Feb 08 Python
对python3 Serial 串口助手的接收读取数据方法详解
Jun 12 Python
python 采用paramiko 远程执行命令及报错解决
Oct 21 Python
深入了解如何基于Python读写Kafka
Dec 31 Python
Pytorch使用PIL和Numpy将单张图片转为Pytorch张量方式
May 25 Python
python实现在线翻译
Jun 18 Python
详解pycharm连接远程linux服务器的虚拟环境的方法
Nov 13 Python
python中os.remove()用法及注意事项
Jan 31 Python
python 文本单词提取和词频统计的实例
Dec 22 #Python
python 删除字符串中连续多个空格并保留一个的方法
Dec 22 #Python
Python函数装饰器实现方法详解
Dec 22 #Python
使用python对文件中的单词进行提取的方法示例
Dec 21 #Python
Python类装饰器实现方法详解
Dec 21 #Python
Python实现的字典排序操作示例【按键名key与键值value排序】
Dec 21 #Python
Python简单获取二维数组行列数的方法示例
Dec 21 #Python
You might like
php多文件上传实现代码
2014/02/20 PHP
必须收藏的23个php实用代码片段
2016/02/02 PHP
详解php中空字符串和0之间的关系
2016/10/23 PHP
php基于数组函数实现关联表的编辑操作示例
2017/07/04 PHP
php让json_encode不自动转义斜杠“/”的方法
2020/04/27 PHP
判断用户的在线状态 onbeforeunload事件
2011/03/05 Javascript
js中scrollHeight,scrollWidth,scrollLeft,scrolltop等差别介绍
2012/05/16 Javascript
js的匿名函数使用介绍
2013/12/11 Javascript
提高jQuery性能优化的技巧
2015/08/03 Javascript
javascript中对变量类型的判断方法
2015/08/09 Javascript
学习JavaScript图片预加载模块
2016/11/07 Javascript
Vue组件开发初探
2017/02/14 Javascript
Koa2微信公众号开发之消息管理
2018/05/16 Javascript
实例详解Node.js 函数
2018/06/10 Javascript
详解JavaScript 中 if / if...else...替换方式
2018/07/15 Javascript
详解在HTTPS 项目中使用百度地图 API
2019/04/26 Javascript
JS秒杀倒计时功能完整实例【使用jQuery3.1.1】
2019/09/03 jQuery
微信小程序按钮点击动画效果的实现
2019/09/04 Javascript
javascript设计模式 ? 状态模式原理与用法实例分析
2020/04/22 Javascript
[02:09]2018DOTA2亚洲邀请赛TNC赛前采访
2018/04/04 DOTA
Python实现登录人人网并抓取新鲜事的方法
2015/05/11 Python
Python fileinput模块使用实例
2015/06/03 Python
在Apache服务器上同时运行多个Django程序的方法
2015/07/22 Python
使用pandas读取csv文件的指定列方法
2018/04/21 Python
python中dict字典的查询键值对 遍历 排序 创建 访问 更新 删除基础操作方法
2018/09/13 Python
python生成任意频率正弦波方式
2020/02/25 Python
Python绘制动态水球图过程详解
2020/06/03 Python
使用PyCharm安装pytest及requests的问题
2020/07/31 Python
浅谈three.js中的needsUpdate的应用
2012/11/12 HTML / CSS
迪卡侬英国官网:Decathlon英国
2017/04/08 全球购物
开办大学饮食联盟创业计划书
2014/01/29 职场文书
个人委托书格式
2014/04/04 职场文书
公司总经理岗位职责
2015/04/01 职场文书
手把手教你制定暑期学习计划,让你度过充实的暑假
2019/08/22 职场文书
「睡美人」爱洛公主粘土人开订
2022/03/22 日漫
在Oracle表中进行关键词搜索的过程
2022/06/10 Oracle