python 装饰器的讲解
所谓装饰器就是把函数包装一下,为函数添加一些附加功能,装饰器就是一个函数,参数为被包装的函数,返回包装后的函数
装饰器本身就是一个函数, 将所装饰的函数, 作为一个参数传进来, 然后在执行这个函数之前, 进行一个处理,这就是装饰器. 所以和正常函数执行顺序是一样的
1. 闭包函数
在看装饰器之前,我们先来搞清楚什么是闭包函数。python是一种面向对象的编程语言,在python中一切皆对象,这样就使得变量所拥有的属性,函数也同样拥有。这样我们就可以理解在函数内创建一个函数的行为是完全合法的。这种函数被叫做内嵌函数,这种函数只可以在外部函数的作用域内被正常调用,在外部函数的作用域之外调用会报错,例如:
而如果内部函数里引用了外部函数里定义的对象(甚至是外层之外,但不是全局变量),那么此时内部函数就被称为闭包函数。闭包函数所引用的外部定义的变量被叫做自由变量。闭包从语法上看非常简单,但是却有强大的作用。闭包可以将其自己的代码和作用域以及外部函数的作用结合在一起。下面给出一个简单的闭包的例子:
def count():a = 1b = 1def sum():c = 1return a + c # a - 自由变量return sum
总结:什么函数可以被称为闭包函数呢?主要是满足两点:函数内部定义的函数;引用了外部变量但非全局变量。
2. python装饰器
有了闭包函数的概念,我们再去理解装饰器会相对容易一些。python装饰器本质上就是一个函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外的功能,装饰器的返回值也是一个函数对象(函数的指针)。装饰器函数的外部函数传入我要装饰的函数名字,返回经过修饰后函数的名字;内层函数(闭包)负责修饰被修饰函数。从上面这段描述中我们需要记住装饰器的几点属性,以便后面能更好的理解:
实质: 是一个函数
参数:是你要装饰的函数名(并非函数调用)
返回:是装饰完的函数名(也非函数调用)
作用:为已经存在的对象添加额外的功能
特点:不需要对对象做任何的代码上的变动
python装饰器有很多经典的应用场景,比如:插入日志、性能测试、事务处理、权限校验等。装饰器是解决这类问题的绝佳设计。并且从引入中的列子中我们也可以归纳出:装饰器最大的作用就是对于我们已经写好的程序,我们可以抽离出一些雷同的代码组建多个特定功能的装饰器,这样我们就可以针对不同的需求去使用特定的装饰器,这时因为源码去除了大量泛化的内容而使得源码具有更加清晰的逻辑。
2.1 函数装饰器
函数的函数装饰器
我们还是以为函数添加计时功能为例,讲述函数装饰器。
import timedef decorator(func):def wrapper(*args, **kwargs):start_time = time.time()func()end_time = time.time()print(end_time - start_time)return wrapper@decorator
def func():time.sleep(0.8)func() # 函数调用# 输出:0.800644397735595
在上面代码中 func是我要装饰器的函数,我想用装饰器显示func函数运行的时间。@decorator这个语法相当于 执行 func = decorator(func),为func函数装饰并返回。在来看一下我们的装饰器函数 - decorator,该函数的传入参数是func (被装饰函数),返回参数是内层函数。这里的内层函数-wrapper,其实就相当于闭包函数,它起到装饰给定函数的作用,wrapper参数为*args, **kwargs。*args表示的参数以列表的形式传入;**kwargs表示的参数以字典的形式传入:
从图中我们可以看到:凡是以key=value形式的参数均存在kwargs中,剩下的所有参数都以列表的形式存于args中。这里要注意的是:为了不破坏原函数的逻辑,我们要保证内层函数wrapper和被装饰函数func的传入参数和返回值类型必须保持一致。
类方法的函数装饰器
类方法的函数装饰器和函数的函数装饰器类似。
import timedef decorator(func):def wrapper(me_instance):start_time = time.time()func(me_instance)end_time = time.time()print(end_time - start_time)return wrapperclass Method(object):@decorator def func(self):time.sleep(0.8)p1 = Method()p1.func() # 函数调用
对于类方法来说,都会有一个默认的参数self,它实际表示的是类的一个实例,所以在装饰器的内部函数wrapper也要传入一个参数 - me_instance就表示将类的实例p1传给wrapper,其他的用法都和函数装饰器相同。
2.2 类装饰器
前面我们提到的都是让 函数作为装饰器去装饰其他的函数或者方法,那么可不可以让 一个类发挥装饰器的作用呢?答案肯定是可以的,一切皆对象嚒,函数和类本质没有什么不一样。类的装饰器是什么样子的呢?
class Decorator(object):def __init__(self, f):self.f = fdef __call__(self):print("decorator start")self.f()print("decorator end")@Decorator
def func():print("func")func()
这里有注意的是:__call__()是一个特殊方法,它可将一个类实例变成一个可调用对象:
p = Decorator(func) # p是类Decorator的一个实例
p() # 实现了__call__()方法后,p可以被调用
要使用类装饰器必须实现类中的__call__()方法,就相当于将实例变成了一个方法。
2.3 装饰器链
一个python函数也可以被多个装饰器修饰,要是有多个装饰器时,这些装饰器的执行顺序是怎么样的呢?
可见,多个装饰器的执行顺序:是从近到远依次执行。
2.4 python装饰器库 - functools
def decorator(func):def inner_function():passreturn inner_function@decorator
def func():passprint(func.__name__)# 输出: inner_function
上述代码最后执行的结果不是 func,而是 inner_function!这表示被装饰函数自身的信息丢失了!怎么才能避免这种问题的发生呢?
可以借助functools.wraps()函数:
from functools import wraps
def decorator(func):@wraps(func) def inner_function():passreturn inner_function@decorator
def func():passprint(func.__name__)#输出: func
01. 装饰器语法糖
如果你接触 Python 有一段时间了的话,想必你对 @ 符号一定不陌生了,没错 @ 符号就是装饰器的语法糖。
它放在一个函数开始定义的地方,它就像一顶帽子一样戴在这个函数的头上。和这个函数绑定在一起。在我们调用这个函数的时候,第一件事并不是执行这个函数,而是将这个函数做为参数传入它头顶上这顶帽子,这顶帽子我们称之为装饰函数 或 装饰器。
你要问我装饰器可以实现什么功能?我只能说你的脑洞有多大,装饰器就有多强大。
装饰器的使用方法很固定:
- 先定义一个装饰函数(帽子)(也可以用类、偏函数实现)
- 再定义你的业务函数、或者类(人)
- 最后把这顶帽子带在这个人头上
装饰器的简单的用法有很多,这里举两个常见的。
- 日志打印器
- 时间计时器
02. 入门用法:日志打印器
首先是日志打印器。
它要实现的功能是
- 在函数执行前,先打印一行日志告知一下主人,我要执行函数了。
- 在函数执行完,也不能拍拍屁股就走人了,咱可是有礼貌的代码,再打印一行日志告知下主人,我执行完啦。
# 这是装饰函数
def logger(func):def wrapper(*args, **kw):print('我准备开始计算:{} 函数了:'.format(func.__name__))# 真正执行的是这行。func(*args, **kw)print('啊哈,我计算完啦。给自己加个鸡腿!!')return wrapper
假如,我的业务函数是,计算两个数之和。写好后,直接给它带上帽子。
@logger
def add(x, y):print('{} + {} = {}'.format(x, y, x+y))
然后我们来计算一下。
add(200, 50)
快来看看输出了什么,神奇不?
我准备开始计算:add 函数了:
200 + 50 = 250
啊哈,我计算完啦。给自己加个鸡腿!
03. 入门用法:时间计时器
再来看看 时间计时器
实现功能:顾名思义,就是计算一个函数的执行时长。
# 这是装饰函数
def timer(func):def wrapper(*args, **kw):t1=time.time()# 这是函数真正执行的地方func(*args, **kw)t2=time.time()# 计算下时长cost_time = t2-t1 print("花费时间:{}秒".format(cost_time))return wrapper
假如,我们的函数是要睡眠10秒。这样也能更好的看出这个计算时长到底靠不靠谱。
import time@timer
def want_sleep(sleep_time):time.sleep(sleep_time)want_sleep(10)
来看看,输出。真的是10秒。
花费时间:10.0073800086975098秒
04. 进阶用法:带参数的函数装饰器
通过上面简单的入门,你大概已经感受到了装饰的神奇魅力了。
不过,装饰器的用法远不止如此。我们今天就要把这个知识点学透。
上面的例子,装饰器是不能接收参数的。其用法,只能适用于一些简单的场景。不传参的装饰器,只能对被装饰函数,执行固定逻辑。
如果你有经验,你一定经常在项目中,看到有的装饰器是带有参数的。
装饰器本身是一个函数,既然做为一个函数都不能携带函数,那这个函数的功能就很受限。只能执行固定的逻辑。这无疑是非常不合理的。而如果我们要用到两个内容大体一致,只是某些地方不同的逻辑。不传参的话,我们就要写两个装饰器。小明觉得这不能忍。
那么装饰器如何实现传参呢,会比较复杂,需要两层嵌套。
同样,我们也来举个例子。
我们要在这两个函数的执行的时候,分别根据其国籍,来说出一段打招呼的话。
def american():print("I am from America.")def chinese():print("我来自中国。")
在给他们俩戴上装饰器的时候,就要跟装饰器说,这个人是哪国人,然后装饰器就会做出判断,打出对应的招呼。
戴上帽子后,是这样的。
@say_hello("china")
def chinese():print("我来自中国。")@say_hello("america")
def american():print("I am from America.")
万事俱备,只差帽子了。来定义一下,这里需要两层嵌套。
def say_hello(contry):def wrapper(func):def deco(*args, **kwargs):if contry == "china":print("你好!")elif contry == "america":print('hello.')else:return# 真正执行函数的地方func(*args, **kwargs)return decoreturn wrapper
执行一下
american()
print("------------")
chinese()
看看输出结果。
你好!
我来自中国。
------------
hello.
I am from America
emmmm,这很NB。。。
05. 高阶用法:不带参数的类装饰器
以上都是基于函数实现的装饰器,在阅读别人代码时,还可以时常发现还有基于类实现的装饰器。
基于类装饰器的实现,必须实现 __call__ 和 __init__两个内置函数。
- __init__ :接收被装饰函数
- __call__ :实现装饰逻辑。
class logger(object):def __init__(self, func):self.func = funcdef __call__(self, *args, **kwargs):print("[INFO]: the function {func}() is running..."\.format(func=self.func.__name__))return self.func(*args, **kwargs)@logger
def say(something):print("say {}!".format(something))say("hello")
执行一下,看看输出
[INFO]: the function say() is running...
say hello!
06. 高阶用法:带参数的类装饰器
上面不带参数的例子,你发现没有,只能打印INFO级别的日志,正常情况下,我们还需要打印DEBUG WARNING等级别的日志。 这就需要给类装饰器传入参数,给这个函数指定级别了。
带参数和不带参数的类装饰器有很大的不同。
- __init__ :不再接收被装饰函数,而是接收传入参数。
- __call__ :接收被装饰函数,实现装饰逻辑。
class logger(object):def __init__(self, level='INFO'):self.level = leveldef __call__(self, func): # 接受函数def wrapper(*args, **kwargs):print("[{level}]: the function {func}() is running..."\.format(level=self.level, func=func.__name__))func(*args, **kwargs)return wrapper #返回函数@logger(level='WARNING')
def say(something):print("say {}!".format(something))say("hello")
我们指定WARNING级别,运行一下,来看看输出。
[WARNING]: the function say() is running...
say hello!
07. 使用偏函数与类实现装饰器
绝大多数装饰器都是基于函数和闭包实现的,但这并非制造装饰器的唯一方式。
事实上,Python 对某个对象是否能通过装饰器( @decorator)形式使用只有一个要求:decorator 必须是一个“可被调用(callable)的对象。
对于这个 callable 对象,我们最熟悉的就是函数了。
除函数之外,类也可以是 callable 对象,只要实现了__call__ 函数(上面几个盒子已经接触过了),还有比较少人使用的偏函数也是 callable 对象。
接下来就来说说,如何使用 类和偏函数结合实现一个与众不同的装饰器。
https://www.cnblogs.com/lianyingteng/p/7743876.html :闭包函数,自由变量
https://www.jb51.net/article/168276.htm 各种类型的装饰器
python 装饰器的讲解相关推荐
- python装饰器参数讲解_python装饰器的详细解析
写在前面: python装饰器(fuctional decorators)就是用于拓展原来函数功能的一种函数,目的是在不改变原函数名(或类名)的情况下,给函数增加新的功能. 这个函数的特殊之处在于它的 ...
- python装饰器深度讲解_python核心知识讲解,干货!!!
大家好,为大家带来python中核心知识的讲解,不讲最基础的语法,这个大家都能轻松学会,不耽误时间,只有干货. ###查看当前作用域内的所有变量 >>>help('__main__' ...
- python装饰器-如何更通俗地讲解Python的装饰器?
我从以下几点,由浅入深详细讲解一下Python装饰器:什么是装饰器? 为什么用装饰器? 在哪里用装饰器? 然后以示例+讲解相结合的方式阐述,同时会讲解一些在很多教程和书籍中不会涉及到的内容. 什么是P ...
- python装饰器详解-如何更通俗地讲解Python的装饰器?
我从以下几点,由浅入深详细讲解一下Python装饰器:什么是装饰器? 为什么用装饰器? 在哪里用装饰器? 然后以示例+讲解相结合的方式阐述,同时会讲解一些在很多教程和书籍中不会涉及到的内容. 什么是P ...
- python装饰器原理-看完这篇文章还不懂Python装饰器?
原标题:看完这篇文章还不懂Python装饰器? 1.必备 2.需求来了 初创公司有N个业务部门,1个基础平台部门,基础平台负责提供底层的功能,如:数据库操作.redis调用.监控API等功能.业务部门 ...
- python装饰器-Python——装饰器(Decorator)
1.什么是装饰器? 装饰器放在一个函数开始定义的地方,它就像一顶帽子一样戴在这个函数的头上.和这个函数绑定在一起.在我们调用这个函数的时候,第一件事并不是执行这个函数,而是将这个函数做为参数传入它头顶 ...
- python装饰器原理-深刻理解python装饰器
我们要完全理解python装饰器,不是很容易,主要归结有如下困难: 1. 关于函数"变量"(或"变量"函数)的理解 2. 关于高阶函数的理解 3. 关于嵌套函数 ...
- python装饰器函数-Python精进-装饰器与函数对象
本文为<爬着学Python>系列第四篇文章. 从本篇开始,本专栏在顺序更新的基础上,会有不规则的更新. 在Python的学习与运用中,我们迟早会遇到装饰器,这个概念对于初识装饰器的新手来说 ...
- python装饰器-如何理解Python装饰器?
我从以下几点,由浅入深详细讲解一下Python装饰器:什么事装饰器? 为什么用装饰器? 在哪里用装饰器? 然后以示例+讲解相结合的方式阐述,同时会讲解一些在很多教程和书籍中不会涉及到的内容. 什么是P ...
最新文章
- 你写的接口都测试吗?测什么?怎么测?
- CSDN开源夏令营 百度数据可视化实践 ECharts(8)
- 再来一波PHP程序员必看书籍
- android120 zhihuibeijing 开机页面
- vmware_vcenter_api
- python基础技巧总结(五)
- 利用Dockefile将Python的py文件项目代码打包为Docker镜像
- springboot统一封装返回结果
- Bootstrap3 模态对话框的事件
- CentOS上使用netstat命令查证DDOS***
- 如何修改游戏服务器端的数据,如何修改网络游戏服务器数据
- Java日志组件间关系
- Win10微软帐户切换不回Administrator本地帐户的解决方法--(转,虽转但亲测有效)
- MINIEYE完成B轮融资,四维图新基金战略领投
- python指数函数ks检验_python指数函数不正确的指数值
- C# 生成word文件 小学一年级口算题生成器(代码)
- 如何零成本实现微信公众号自助查券返利机器人(二)
- jQuery 操作属性
- 核芯显卡和集成显卡、独立显卡的区别是什么
- 程序员之死,没一个产品是无辜的!