如何实现一个python函数装饰器(Decorator)

 更新时间:2020年10月12日 09:13:14   作者:半杯茶的小酒杯  
这篇文章主要介绍了如何实现一个python函数装饰器(Decorator),帮助大家更好的理解和学习python,感兴趣的朋友可以了解下

装饰器本质上是一个 Python 函数或类,它可以让其他函数或类在不需要做任何代码修改的前提下增加额外功能,装饰器的返回值也是一个函数/类对象。它经常用于为已有函数/类添加记录日志、计时统计、性能测试等。

首先定义一个倒计时函数,这个函数的功能非常简单,就是把n从当前值减少到0。

def countdown(n):
 while n > 0:
  print('time' + str(n))
  n -= 1

print(countdown.__name__)

程序输出:

countdown

1.为函数增加一个日志装饰器

假设现在要增强countdown的功能,在函数调用前后自动打印日志,又不想修改函数自身的功能。这种在代码运行期间动态增加功能的方式,称之为装饰器(Decorator)。

能打印日志的decorator,可以定义如下:

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

然后我们借助Python的@语法,把decorator置于函数的定义处:

@log
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

countdown(10)

程序输出:

call countdown().
time:10
time:9
time:8
time:7
time:6
time:5
time:4
time:3
time:2
time:1

但此时我们再打印函数的name:

print(countdown.__name__)

程序输出:

wrapper

我们发现函数的元数据信息变了,这显然不是我们想要的结果。

2. 在装饰器中拷贝元数据

为了把函数的元数据信息都保留下来,我们可以直接使用Python提供的functools库中的@wraps装饰器。

from functools import wraps

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

@log
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

print(countdown.__name__)

程序输出:

countdown

3.为函数增加一个计时装饰器

添加函数装饰器的方法已经讲清楚了,现在再实现一个完整的函数计时耗时装饰器。

import time
from functools import wraps

def TimeCost(func):
 @wraps(func)
 def wrapper(*arg, **kwargs):
  start = time.time()
  result = func(*args, **kwargs)
  end = time.time()
  print(func.__name__, end - start)
  return result
 return wrapper

@TimeCost
def countdown(n):
 while n > 0:
  print('time:' + str(n))
  n -= 1

countdown(10000)

函数输出:

('countdown', 0.0004801750183105469)

参考资料:

https://www.liaoxuefeng.com/wiki/1016959663602400/1017451662295584

Python Cookbook中文版

以上就是如何实现一个python函数装饰器(Decorator)的详细内容,更多关于python函数装饰器的资料请关注脚本之家其它相关文章!

相关文章

  • Python学习笔记(一)(基础入门之环境搭建)

    Python学习笔记(一)(基础入门之环境搭建)

    本系列为Python学习相关笔记整理所得,IT人,多学无害,多多探索,激发学习兴趣,开拓思维,不求高大上,只求懂点皮毛,作为知识储备,不至于落后太远。本文主要介绍Python的相关背景,环境搭建。
    2014-06-06
  • Empty test suite.(PyCharm程序运行错误的解决方法)

    Empty test suite.(PyCharm程序运行错误的解决方法)

    今天小编就为大家分享一篇Empty test suite.(PyCharm程序运行错误的解决方法),具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-11-11
  •  分享一个Python 遇到数据库超好用的模块

     分享一个Python 遇到数据库超好用的模块

    这篇文章主要介绍了 分享一个Python 遇到数据库超好用的模块,SQLALchemy这个模块,该模块是Python当中最有名的ORM框架,该框架是建立在数据库API之上,使用关系对象映射进行数据库的操作,,需要的朋友可以参考下
    2022-04-04
  • Python 字符串定义

    Python 字符串定义

    字符串是程序中最常见的数据类型。在Python中,可以使用三种方式定义字符串。单引号、双引号和三引号。
    2009-09-09
  • python模型集成知识点总结

    python模型集成知识点总结

    在本篇文章里小编给大家整理了一篇关于python模型集成知识点总结,有需要的朋友们可以学习参考下。
    2021-08-08
  • Python通过cv2读取多个USB摄像头

    Python通过cv2读取多个USB摄像头

    这篇文章主要为大家详细介绍了Python通过cv2读取多个USB摄像头,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • python中的列表推导浅析

    python中的列表推导浅析

    这篇文章主要介绍了python中的列表推导,需要的朋友可以参考下
    2014-04-04
  • 用Python解数独的方法示例

    用Python解数独的方法示例

    这篇文章主要介绍了用Python解数独的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • python GUI库图形界面开发之PyQt5下拉列表框控件QComboBox详细使用方法与实例

    python GUI库图形界面开发之PyQt5下拉列表框控件QComboBox详细使用方法与实例

    这篇文章主要介绍了python GUI库图形界面开发之PyQt5下拉列表框控件QComboBox详细使用方法与实例,需要的朋友可以参考下
    2020-02-02
  • python面向对象之类属性和类方法案例分析

    python面向对象之类属性和类方法案例分析

    这篇文章主要介绍了python面向对象之类属性和类方法,结合案例形式分析了Python面相对象中类属性和类方法的相关概念、原理与使用技巧,需要的朋友可以参考下
    2019-12-12

最新评论