python3 第二十二章 - 函数式编程之Decorator(装饰器)
前面我们说了,在python中,一切皆对象。函数也是一个对象,而且函数对象可以被赋值给变量,通过变量也能调用该函数。如:
def sayHello(name):
print(name + ' hello') fn = sayHello
fn('roy')
以上代码,输出:
roy hello
函数对象有一个__name__属性,可以拿到函数的名字:
def sayHello(name):
print(name + ' hello') f =sayHello print(f.__name__)
print(sayHello.__name__)
以上代码,输出:
sayHello
sayHello
你会发现,上例中的变量 f 也获得了sayHello函数的功能,而且本质上它就是 sayHello 函数
如果,我想sayHello()这个函数在调用前先打印一句话,你可能会立刻想到,在函数的实现里再加一个print。这当然能达到效果,但是这也修改了函数的定义。
事实上,很多时候我们希望在不修改函数定义的情况下增强函数的功能,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。
装饰器其实就是一个以函数作为参数并返回一个替换函数的可执行函数。让我们先从简单的开始:
def log(fn):
def inner():
print('调用 fn 之前')
fn() return inner def sayHello():
print('say hello') decorated = log(sayHello)
decorated()
以上代码,输出:
调用 fn 之前
say hello
我们可以说变量 decorated 是 sayHello 的装饰版——即 sayHello加上一些东西。事实上,如果写了一个实用的装饰器,可能会想用装饰版来代替 sayHello,这样就总能得到“附带其他东西”的 sayHello版本。用不着学习任何新的语法,通过将包含函数的变量重新赋值就能轻松做到这一点:
def log(fn):
def inner():
print('调用 fn 之前')
fn() return inner def sayHello():
print('say hello') sayHello = log(sayHello)
sayHello()
以上代码,输出:
调用 fn 之前
say hello
现在任意调用 sayHello() 都不会得到原来的 sayHello,而是新的装饰器版!明白了吗?
现在这个sayHello函数是不带参数的,那假如带有参数的,又该怎么写呢?看实例:
def log(fn):
def inner(name):
print('调用 fn 之前')
fn(name) return inner def sayHello(name):
print(name, 'say hello') sayHello = log(sayHello)
sayHello('roy')
以上代码,输出:
调用 fn 之前
roy say hello
在上面代码示例中,用了一个包装的函数来替换包含函数的变量来实现了装饰函数:
sayHello = log(sayHello)
sayHello('roy')
在Python3中通过在函数定义前添加一个装饰器名和 @ 符号,来实现对函数的包装,如:
def log(fn):
def inner(name):
print('调用 fn 之前')
fn(name) return inner @log
def sayHello(name):
print(name, 'say hello') sayHello('roy')
以上代码,输出:
调用 fn 之前
roy say hello
值得注意的是,这种方式和简单的使用 log 函数的返回值来替换原始变量的做法没有什么不同—— Python 只是添加了一些语法糖来使之看起来更加明确。
上面我们写了一个装饰器,但它是硬编码的,只适用于特定类型的函数——带有1个参数的函数。内部函数 inner 接收1个参数,然后继续将参数传给闭包中的函数。如果我们想要一个能适用任何函数的装饰器呢?这意味着这个装饰器必须接收它所装饰的任何函数的调用信息,并且在调用这些函数时将传递给该装饰器的任何参数都传递给它们,所幸python提供这样的语法,我们来写一个通用的装饰器:
def log(fn):
"""
通用的装饰器
:param fn:
:return:
"""
def inner(*args, **kwargs):
print('调用 %s 之前' % fn.__name__)
fn(*args, **kwargs) return inner @log
def sayHello(name):
print(name, 'say hello') @log
def sayGoodbye():
print('say goodbye') @log
def sayMessage(name, message):
print(name, 'say', message) sayHello('roy')
print() sayGoodbye()
print() sayMessage('roy', 'Hello World')
以上代码,输出:
调用 sayHello 之前
roy say hello 调用 sayGoodbye 之前
say goodbye 调用 sayMessage 之前
roy say Hello World
注:当定义一个函数时,*args 可以表示在调用函数时从迭代器中取出位置参数, 也可以表示在定义函数时接收额外的位置参数。使用 **kwargs 来表示所有未捕获的关键字参数将会被存储在字典 kwargs 中。此前 args 和 kwargs 都不是 Python 中语法的一部分,但在函数定义时使用这两个变量名是一种惯例。和 * 的使用一样,可以在函数调用和定义时使用 **
但,还有个问题,由于log函数是一个Decorator(装饰器),返回一个函数,所以,原来的 sayGoodbye 函数仍然存在,只是现在同名的sayGoodbye变量指向了新的函数,于是调用sayGoodbye()将执行新函数,即在log函数中返回的inner函数。但你去看经过log函数装饰之后的函数,它们的__name__已经从原来的'sayGoodbye'变成了'inner'了:
def log(fn):
"""
通用的装饰器
:param fn:
:return:
"""
def inner(*args, **kwargs):
print('调用 %s 之前' % fn.__name__)
fn(*args, **kwargs) return inner @log
def sayGoodbye():
print('say goodbye') print(sayGoodbye.__name__)
以上代码,输出:
inner
因为log函数中返回的那个函数名字就是'inner',所以,需要把原始函数的__name__等属性复制到inner函数中,否则,有些依赖函数签名的代码执行就会出错。
不需要编写inner.__name__ = fn.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:
import functools
def log(fn):
"""
通用的装饰器
:param fn:
:return:
"""
@functools.wraps(fn)
def inner(*args, **kwargs):
print('调用 %s 之前' % fn.__name__)
fn(*args, **kwargs) return inner @log
def sayGoodbye():
print('say goodbye') print(sayGoodbye.__name__)
以上代码,输出:
sayGoodbye
如果Decorator(装饰器)本身需要传入参数,那要怎么做呢?那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:
import functools def log(msg): def decorator(fn):
"""
通用的装饰器
:param fn:
:return:
""" @functools.wraps(fn)
def inner(*args, **kwargs):
print('调用 %s 之前' % fn.__name__)
print('msg:',msg)
fn(*args, **kwargs) return inner return decorator @log('这是一个自定义消息')
def sayGoodbye():
print('say goodbye') sayGoodbye()
以上代码,输出:
调用 sayGoodbye 之前
msg: 这是一个自定义消息
say goodbye
python3 第二十二章 - 函数式编程之Decorator(装饰器)的更多相关文章
- python3 第二十四章 - 函数式编程之Anonymous function(匿名函数)
匿名函数指一类无须定义标识符的函数或子程序.Python用lambda语法定义匿名函数,只需用表达式而无需申明.lambda语法的定义如下: lambda [arg1 [,arg2, ... argN ...
- 《Linux命令行与shell脚本编程大全》 第二十二章 学习笔记
第二十二章:使用其他shell 什么是dash shell Debian的dash shell是ash shell的直系后代,ash shell是Unix系统上原来地Bourne shell的简化版本 ...
- 第二十二章 Django会话与表单验证
第二十二章 Django会话与表单验证 第一课 模板回顾 1.基本操作 def func(req): return render(req,'index.html',{'val':[1,2,3...]} ...
- Gradle 1.12用户指南翻译——第二十二章. 标准的 Gradle 插件
其他章节的翻译请参见: http://blog.csdn.net/column/details/gradle-translation.html 翻译项目请关注Github上的地址: https://g ...
- “全栈2019”Java多线程第二十二章:饥饿线程(Starvation)详解
难度 初级 学习时间 10分钟 适合人群 零基础 开发语言 Java 开发环境 JDK v11 IntelliJ IDEA v2018.3 文章原文链接 "全栈2019"Java多 ...
- “全栈2019”Java异常第二十二章:try-with-resources语句详解
难度 初级 学习时间 10分钟 适合人群 零基础 开发语言 Java 开发环境 JDK v11 IntelliJ IDEA v2018.3 文章原文链接 "全栈2019"Java异 ...
- “全栈2019”Java第二十二章:控制流程语句中的决策语句if-else
难度 初级 学习时间 10分钟 适合人群 零基础 开发语言 Java 开发环境 JDK v11 IntelliJ IDEA v2018.3 文章原文链接 "全栈2019"Java第 ...
- python 教程 第二十二章、 其它应用
第二十二章. 其它应用 1) Web服务 ##代码 s 000063.SZ ##开盘 o 26.60 ##最高 h 27.05 ##最低 g 26.52 ##最新 l1 26.66 ##涨跌 c ...
- 第二十二章 跳出循环-shift参数左移-函数的使用 随堂笔记
第二十二章 跳出循环-shift参数左移-函数的使用 本节所讲内容: 22.1 跳出循环 22.2 Shift参数左移指令 22.3 函数的使用 22.4 实战-自动备份mysql数据库和nginx服 ...
随机推荐
- vue2.0 微信oauth认证的正确调用位置
运行在微信端的项目,很重要的环节是oauth认证:那在vue项目中,在何时何地调用oauth认证最合适呢? 经过观察,在项目启动过程中,会执行main.js文件:所以我将认证放在main.js中操作: ...
- Geohash-》通过经纬度计算两地距离的函数
/** * 根据起点坐标和终点坐标测距离 * @param [array] $from [起点坐标(经纬度),例如:array(118.012951,36.810024)] ...
- Spark 学习笔记大纲
Spark 内核 第28课:Spark天堂之门解密 (点击进入博客)从 SparkContext 创建3大核心对象开始到注册给 Master 这个过程中的源码鉴赏 第29课:Master HA彻底解密 ...
- Javascript中遍历数组方法的性能对比
Javascript中常见的遍历数组的方法 1.for循环 for(var i = 0; i < arr.length; i++) { // do something. } 2.for循环的改进 ...
- 使用ajax调用webservice加载table
写了个ajax调用webservice动态加载表格的案例 不废话直接上代码 webservice代码: /// <summary> /// 首页显示会员信息 /// </summar ...
- Oracle之 11gR2 RAC 修改监听器端口号的步骤
Oracle 11gR2 RAC 修改监听器端口号的步骤 说明:192.168.188.181 为public ip1192.168.188.182 为public ip2192.168.188.18 ...
- CSS选择器:伪类(图文详解)
本文最初发表于博客园,并在GitHub上持续更新前端的系列文章.欢迎在GitHub上关注我,一起入门和进阶前端. 以下是正文. 伪类(伪类选择器) 伪类:同一个标签,根据其不同的种状态,有不同的样式. ...
- 富文本编辑器Quill的使用
我们经常需要使用富文本编辑器从后台管理系统上传文字,图片等用于前台页面的显示,Quill在后台传值的时候需要传两个参数,一个用于后台管理系统编辑器的显示,一个用前台页面的显示,具体代码如下截图: 另Q ...
- Kubernetes 架构(上)- 每天5分钟玩转 Docker 容器技术(120)
Kubernetes Cluster 由 Master 和 Node 组成,节点上运行着若干 Kubernetes 服务. Master 节点 Master 是 Kubernetes Cluster ...
- eclipse安装java web插件
1 查看eclipse版本 找到eclipse的安装目录,找到readme文件,打开其中的html文件,我的是4.6版本的,代号是oxygen 2 安装 打开eclipse,点击help-Instal ...