Python中装饰器兼容加括号和不加括号的写法详解


Posted in Python onJuly 05, 2017

使用Django的时候,我发现一个很神奇的装饰器: @login_required, 这是控制一个view的权限的,比如一个视图必须登录才可以访问,可以这样用:

@login_required
def my_view(request):
 ...
 return render(...)

同时,如果要达到这样一种效果:如果用户没有登录,那么就把用户重定向到登录界面,可以这样用:

@login_required(login_url='/accounts/login/')
def my_view(request):
 ...
 return render(...)

所以这个装饰器可以带括号写,又可以不带括号写。很神奇有没有。正常的接收参数的装饰器,就算没参数也应该写成@login_required的

好奇去查了一下,在stackoverflow找到一种实现,挺有意思的。先晒出答案:

def doublewrap(f):
 '''
 a decorator decorator, allowing the decorator to be used as:
 @decorator(with, arguments, and=kwargs)
 or
 @decorator
 '''
 @wraps(f)
 def new_dec(*args, **kwargs):
  if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
   # actual decorated function
   return f(args[0])
  else:
   # decorator arguments
   return lambda realf: f(realf, *args, **kwargs)
 
 return new_dec

使用起来很简单,只要给装饰器用@doublewrap装饰一下,这个装饰器就支持写括号和不写括号两种写法了。

def test_doublewrap():
 from util import doublewrap
 from functools import wraps 
 
 @doublewrap
 def mult(f, factor=2):
  '''multiply a function's return value'''
  @wraps(f)
  def wrap(*args, **kwargs):
   return factor*f(*args,**kwargs)
  return wrap
 
 # try normal
 @mult
 def f(x, y):
  return x + y
 
 # try args
 @mult(3)
 def f2(x, y):
  return x*y
 
 # try kwargs
 @mult(factor=5)
 def f3(x, y):
  return x - y
 
 assert f(2,3) == 10
 assert f2(2,5) == 30
 assert f3(8,1) == 5*7

原理也不难,只有短短不到10行代码。

装饰器我们都知道,是用来处理一个函数,返回一个新的函数的(如果你不理解装饰器,可以看一下这个经典的解释)。

new_func = decorator(func)

我们使用的,就是被装饰器装饰的新函数了。装饰器只是一个语法糖,其实它也是一个函数,给它传入一个函数作为参数,就返回一个新的函数。那么既然装饰器也是一个函数,我们就可以用装饰器装饰这个函数。也就是,“装饰器的装饰器”。

装饰器第一个参数肯定是原函数,如果装饰器可以接收参数的话,要么第一个参数是原函数,后面跟别的参数;要么就只有原函数一个参数。所以,我们这个“装饰器的装饰器”做的事情就是,判断装饰器接收的参数,如果只有一个并且第一个参数是可调用的(callable),那么这就是一个无参数的装饰器(不需要加括号)。如果还有别的参数,就返回一个生成装饰器的函数(decorator_maker)。

装饰器是一个函数。装饰器被装饰过之后,这个装饰器运行之前就会先运行装饰器的装饰器的代码,也就是我们的doublewrapp。然后返回值可能是一个装饰器,也可能是一个装饰器的maker(有参数的装饰器),然后装饰器再执行,装饰原函数。

这里有点绕,因为本来装饰器里面一般就会有三四层函数了,(maker, decorator, wrapper, realfunc),再加上一个装饰器的装饰器,会有点理解困难。如果理解不了,最好不要对着网上的博文(包括本文)企图格物致知了,多去看看代码,多写一写。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

参考资料

How to create a Python decorator that can be used either with or without parameters?

Python 相关文章推荐
轻松掌握python设计模式之访问者模式
Nov 18 Python
Windows下PyCharm安装图文教程
Aug 27 Python
pygame游戏之旅 添加键盘按键的方法
Nov 20 Python
用Python逐行分析文件方法
Jan 28 Python
详解python数据结构和算法
Apr 18 Python
浅析pandas 数据结构中的DataFrame
Oct 12 Python
python socket通信编程实现文件上传代码实例
Dec 14 Python
python分布式计算dispy的使用详解
Dec 22 Python
浅谈pytorch、cuda、python的版本对齐问题
Jan 15 Python
python给图像加上mask,并提取mask区域实例
Jan 19 Python
如何快速一次性卸载所有python包(第三方库)呢
Oct 20 Python
python 基于Apscheduler实现定时任务
Dec 15 Python
利用python模拟sql语句对员工表格进行增删改查
Jul 05 #Python
利用python实现简单的循环购物车功能示例代码
Jul 05 #Python
用python做一个搜索引擎(Pylucene)的实例代码
Jul 05 #Python
Python对象类型及其运算方法(详解)
Jul 05 #Python
python数据预处理之将类别数据转换为数值的方法
Jul 05 #Python
利用Python3分析sitemap.xml并抓取导出全站链接详解
Jul 04 #Python
在django中使用自定义标签实现分页功能
Jul 04 #Python
You might like
smarty实例教程
2006/11/19 PHP
php设计模式 Bridge (桥接模式)
2011/06/26 PHP
腾讯QQ微博API接口获取微博内容
2013/10/30 PHP
Yii中Model(模型)的创建及使用方法
2015/12/28 PHP
PHP文件操作详解
2016/12/30 PHP
详解yii2使用多个数据库的案例
2017/06/16 PHP
javascript编程起步(第三课)
2007/02/27 Javascript
js修改table中Td的值(定义td的双击事件)
2013/01/10 Javascript
jQuery插件实现屏蔽单个元素使用户无法点击
2013/04/12 Javascript
JQuery调用WebServices的方法和4个实例
2014/05/06 Javascript
JS 弹出层 定位至屏幕居中示例
2014/05/21 Javascript
浅谈nodeName,nodeValue,nodeType,typeof 的区别
2015/01/13 Javascript
浅析JavaScript 调试方法和技巧
2015/10/22 Javascript
JavaScript实现的MD5算法完整实例
2016/02/02 Javascript
JS基于clipBoard.js插件实现剪切、复制、粘贴
2016/05/03 Javascript
浅析Javascript中bind()方法的使用与实现
2016/05/30 Javascript
BootStrap 智能表单实战系列(十)自动完成组件的支持
2016/06/13 Javascript
Jquery针对tr td的一些实用操作方法(必看篇)
2016/10/05 Javascript
使用vue框架 Ajax获取数据列表并用BootStrap显示出来
2017/04/24 Javascript
Angular.js中定时器循环的3种方法总结
2017/04/27 Javascript
jQuery UI实现动画效果代码分享
2018/08/19 jQuery
JavaScript实现tab栏切换效果
2020/03/16 Javascript
国内常用的js类库大全(CDN公共库)
2020/06/24 Javascript
JS数组转字符串实现方法解析
2020/09/04 Javascript
[01:34:42]NAVI vs EG 2019国际邀请赛小组赛 BO2 第二场 8.15
2019/08/17 DOTA
Python2.7简单连接与操作MySQL的方法
2016/04/27 Python
Python实现将通信达.day文件读取为DataFrame
2018/12/22 Python
python把ipynb文件转换成pdf文件过程详解
2019/07/09 Python
python word转pdf代码实例
2019/08/16 Python
使用opencv将视频帧转成图片输出
2019/12/10 Python
H5 meta小结(前端必看篇)
2016/08/24 HTML / CSS
Nili Lotan官网:Nili Lotan同名品牌
2018/01/07 全球购物
民主生活会剖析材料
2014/09/30 职场文书
2015年师德师风自我评价范文
2015/03/05 职场文书
陪护人员误工证明
2015/06/24 职场文书
nginx代理实现静态资源访问的示例代码
2022/07/07 Servers