Python 装饰器实现DRY(不重复代码)原则


Posted in Python onMarch 05, 2018

Python装饰器是一个消除冗余的强大工具。随着将功能模块化为大小合适的方法,即使是最复杂的工作流,装饰器也能使它变成简洁的功能。

例如让我们看看Django web框架,该框架处理请求的方法接收一个方法对象,返回一个响应对象:

def handle_request(request):
  return HttpResponse("Hello, World")

我最近遇到一个案例,需要编写几个满足下述条件的api方法:

  • 返回json响应
  • 如果是GET请求,那么返回错误码

做为一个注册api端点例子,我将会像这样编写:

def register(request):
  result = None
  # check for post only
  if request.method != 'POST':
    result = {"error": "this method only accepts posts!"}
  else:
    try:
      user = User.objects.create_user(request.POST['username'],
                      request.POST['email'],
                      request.POST['password'])
      # optional fields
      for field in ['first_name', 'last_name']:
        if field in request.POST:
          setattr(user, field, request.POST[field])
      user.save()
      result = {"success": True}
    except KeyError as e:
      result = {"error": str(e) }
  response = HttpResponse(json.dumps(result))
  if "error" in result:
    response.status_code = 500
  return response

然而这样我将会在每个api方法中编写json响应和错误返回的代码。这将会导致大量的逻辑重复。所以让我们尝试用装饰器实现DRY原则吧。

装饰器简介

如果你不熟悉装饰器,我可以简单解释一下,实际上装饰器就是有效的函数包装器,python解释器加载函数的时候就会执行包装器,包装器可以修改函数的接收参数和返回值。举例来说,如果我想要总是返回比实际返回值大一的整数结果,我可以这样写装饰器:

# a decorator receives the method it's wrapping as a variable 'f'
def increment(f):
  # we use arbitrary args and keywords to
  # ensure we grab all the input arguments.
  def wrapped_f(*args, **kw):
    # note we call f against the variables passed into the wrapper,
    # and cast the result to an int and increment .
    return int(f(*args, **kw)) + 1
  return wrapped_f # the wrapped function gets returned.

现在我们就可以用@符号和这个装饰器去装饰另外一个函数了:

@increment
def plus(a, b):
  return a + b
 result = plus(4, 6)
assert(result == 11, "We wrote our decorator wrong!")

装饰器修改了存在的函数,将装饰器返回的结果赋值给了变量。在这个例子中,'plus'的结果实际指向increment(plus)的结果。

对于非post请求返回错误

现在让我们在一些更有用的场景下应用装饰器。如果在django中接收的不是POST请求,我们用装饰器返回一个错误响应。

def post_only(f):
  """ Ensures a method is post only """
  def wrapped_f(request):
    if request.method != "POST":
      response = HttpResponse(json.dumps(
        {"error": "this method only accepts posts!"}))
      response.status_code = 500
      return response
    return f(request)
  return wrapped_f

现在我们可以在上述注册api中应用这个装饰器:

@post_only
def register(request):
  result = None
  try:
    user = User.objects.create_user(request.POST['username'],
                    request.POST['email'],
                    request.POST['password'])
    # optional fields
    for field in ['first_name', 'last_name']:
      if field in request.POST:
        setattr(user, field, request.POST[field])
    user.save()
    result = {"success": True}
  except KeyError as e:
    result = {"error": str(e) }
  response = HttpResponse(json.dumps(result))
  if "error" in result:
    response.status_code = 500
  return response

现在我们就有了一个可以在每个api方法中重用的装饰器。

发送json响应

为了发送json响应(同时处理500状态码),我们可以新建另外一个装饰器:

def json_response(f):
  """ Return the response as json, and return a 500 error code if an error exists """
  def wrapped(*args, **kwargs):
    result = f(*args, **kwargs)
    response = HttpResponse(json.dumps(result))
    if type(result) == dict and 'error' in result:
      response.status_code = 500
    return response

现在我们就可以在原方法中去除json相关的代码,添加一个装饰器做为代替:

@post_only
@json_response
def register(request):
  try:
    user = User.objects.create_user(request.POST['username'],
                    request.POST['email'],
                    request.POST['password'])
    # optional fields
    for field in ['first_name', 'last_name']:
      if field in request.POST:
        setattr(user, field, request.POST[field])
    user.save()
    return {"success": True}
  except KeyError as e:
    return {"error": str(e) }

现在,如果我需要编写新的方法,那么我就可以使用装饰器做冗余的工作。如果我要写登录方法,我只需要写真正相关的代码:

@post_only
@json_response
def login(request):
  if request.user is not None:
    return {"error": "User is already authenticated!"}
  user = auth.authenticate(request.POST['username'], request.POST['password'])
  if user is not None:
    if not user.is_active:
      return {"error": "User is inactive"}
    auth.login(request, user)
    return {"success": True, "id": user.pk}
  else:
    return {"error": "User does not exist with those credentials"}

BONUS: 参数化你的请求方法

我曾经使用过Tubogears框架,其中请求参数直接解释转递给方法这一点我很喜欢。所以要怎样在Django中模仿这一特性呢?嗯,装饰器就是一种解决方案!

例如:

def parameterize_request(types=("POST",)):
  """
  Parameterize the request instead of parsing the request directly.
  Only the types specified will be added to the query parameters.
  e.g. convert a=test

注意这是一个参数化装饰器的例子。在这个例子中,函数的结果是实际的装饰器。

现在我就可以用参数化装饰器编写方法了!我甚至可以选择是否允许GET和POST,或者仅仅一种请求参数类型。

@post_only
@json_response
@parameterize_request(["POST"])
def register(request, username, email, password,
       first_name=None, last_name=None):
  user = User.objects.create_user(username, email, password)
  user.first_name=first_name
  user.last_name=last_name
  user.save()
  return {"success": True}

现在我们有了一个简洁的、易于理解的api。

BONUS #2: 使用functools.wraps保存docstrings和函数名

很不幸,使用装饰器的一个副作用是没有保存方法名(name)和docstring(doc)值:

def increment(f):
  """ Increment a function result """
  wrapped_f(a, b):
    return f(a, b) + 1
  return wrapped_f
@increment
def plus(a, b)
  """ Add two things together """
  return a + b
plus.__name__ # this is now 'wrapped_f' instead of 'plus'
plus.__doc__  # this now returns 'Increment a function result' instead of 'Add two things together'

这将对使用反射的应用造成麻烦,比如Sphinx,一个 自动生成文档的应用。

为了解决这个问题,我们可以使用'wraps'装饰器附加上名字和docstring:

from functools import wraps
def increment(f):
  """ Increment a function result """
  @wraps(f)
  wrapped_f(a, b):
    return f(a, b) + 1
  return wrapped_f
@increment
def plus(a, b)
  """ Add two things together """
  return a + b
 
plus.__name__ # this returns 'plus'
plus.__doc__  # this returns 'Add two things together'

BONUS #3: 使用'decorator'装饰器

如果仔细看看上述使用装饰器的方式,在包装器声明和返回的地方也有不少重复。

你可以安装python egg ‘decorator',其中包含一个提供装饰器模板的'decorator'装饰器!

使用easy_install:

$ sudo easy_install decorator

或者Pip:

$ pip install decorator

然后你可以简单的编写:

from decorator import decorator
@decorator
def post_only(f, request):
  """ Ensures a method is post only """
  if request.method != "POST":
    response = HttpResponse(json.dumps(
      {"error": "this method only accepts posts!"}))
    response.status_code = 500
    return response
  return f(request)

这个装饰器更牛逼的一点是保存了name和doc的返回值,也就是它封装了

functools.wraps的功能!

Python 相关文章推荐
python三元运算符实现方法
Dec 17 Python
python杀死一个线程的方法
Sep 06 Python
Python实现将罗马数字转换成普通阿拉伯数字的方法
Apr 19 Python
在python3环境下的Django中使用MySQL数据库的实例
Aug 29 Python
PyQt5实现让QScrollArea支持鼠标拖动的操作方法
Jun 19 Python
网易有道2017内推编程题 洗牌(python)
Jun 19 Python
Anaconda之conda常用命令介绍(安装、更新、删除)
Oct 06 Python
jupyter 实现notebook中显示完整的行和列
Apr 09 Python
python能自学吗
Jun 18 Python
python与pycharm有何区别
Jul 01 Python
利用Selenium添加cookie实现自动登录的示例代码(fofa)
May 08 Python
进行数据处理的6个 Python 代码块分享
Apr 06 Python
Tensorflow实现卷积神经网络用于人脸关键点识别
Mar 05 #Python
python入门教程 python入门神图一张
Mar 05 #Python
详解TensorFlow在windows上安装与简单示例
Mar 05 #Python
python 中if else 语句的作用及示例代码
Mar 05 #Python
运用TensorFlow进行简单实现线性回归、梯度下降示例
Mar 05 #Python
tf.truncated_normal与tf.random_normal的详细用法
Mar 05 #Python
用tensorflow搭建CNN的方法
Mar 05 #Python
You might like
关于php mvc开发模式的感想
2011/06/28 PHP
PHP函数之error_reporting(E_ALL ^ E_NOTICE)详细说明
2011/07/01 PHP
spl_autoload_register与autoload的区别详解
2013/06/03 PHP
tp5框架使用composer实现日志记录功能示例
2019/01/10 PHP
javascript 写类方式之九
2009/07/05 Javascript
jQuery的实现原理的模拟代码 -3 事件处理
2010/08/03 Javascript
父子窗体间传递JSON格式的数据的代码
2010/12/25 Javascript
ko knockoutjs动态属性绑定技巧应用
2012/11/14 Javascript
html的DOM中document对象anchors集合用法实例
2015/01/21 Javascript
jQuery实现在下拉列表选择时获取json数据的方法
2015/04/16 Javascript
jquery使用ul模拟select实现表单美化的方法
2015/08/18 Javascript
js焦点文字滚动效果代码分享
2015/08/25 Javascript
浅谈React Native 中组件的生命周期
2017/09/08 Javascript
Node 自动化部署的方法
2017/10/17 Javascript
基于$.ajax()方法从服务器获取json数据的几种方式总结
2018/01/31 Javascript
react实现换肤功能的示例代码
2018/08/14 Javascript
详解如何在vue项目中使用eslint+prettier格式化代码
2018/11/10 Javascript
详解vue2.6插槽更新v-slot用法总结
2019/03/09 Javascript
vscode 插件开发 + vue的操作方法
2020/06/05 Javascript
uin-app+mockjs实现本地数据模拟
2020/08/26 Javascript
Python读取MRI并显示为灰度图像实例代码
2018/01/03 Python
python调用动态链接库的基本过程详解
2019/06/19 Python
python里运用私有属性和方法总结
2019/07/08 Python
pytorch实现focal loss的两种方式小结
2020/01/02 Python
Python如何定义接口和抽象类
2020/07/28 Python
python中的时区问题
2021/01/14 Python
瑞士灯具购物网站:Lampenwelt.ch
2018/07/08 全球购物
全球性的在线婚纱礼服工厂:27dress.com
2019/03/21 全球购物
New Balance法国官方网站:购买鞋子和服装
2019/09/01 全球购物
什么是smarty? Smarty的优点是什么?
2013/08/11 面试题
New delete 与malloc free 的联系与区别
2013/02/04 面试题
linux面试题参考答案(10)
2013/11/04 面试题
教学大赛获奖感言
2014/01/15 职场文书
感恩节活动方案
2014/01/27 职场文书
MySQL开启事务的方式
2021/06/26 MySQL
react中useState使用:如何实现在当前表格直接更改数据
2022/08/05 Javascript