Python装饰器探究——装饰器参数

macg0406 发布于2019-07-25 11:15 / 429人阅读

摘要：示例中我们编写的装饰器只接受一个隐式参数即被装饰的方法，在使用此装饰器时本身看上去是并没有参数的。实际上装饰器里的后接收一个函数，该函数以被装饰的函数例子中是为参数，并且返回一个函数。

探究装饰器参数 编写传参的装饰器

通常我们见到的简单装饰器这样的：

import json
import functools

def json_output(func):
    @functools.wraps(decorated)
    def inner(*args, **kwargs):
        result = func(*args, **kwargs)
        return json.dumps(result)
    return inner

@json_output
def f():
    return {"status": "done"}

当装饰器应用于函数 f 上时，它接受 f 作为其参数，返回一个函数 inner ，且将他绑定到变量f上。

示例中我们编写的装饰器 json_output 只接受一个隐式参数——即被装饰的方法，在使用此装饰器时本身看上去是并没有参数的。然而有时候需要让装饰器自身带有一些需要的信息，从而使装饰器可以使用恰当的方式装饰方法。比如上面的例子中，我们想通过向装饰器传入不同的参数来控制输出结果的缩进(indent)和排序(sort)。我们可以这么做:

import json
import functools

def json_output(indent=None, sort_keys=False):
    def actual_decorator(func):
        @functools.wraps(func)
        def inner(*args, **kwargs):
            result = func(*args, **kwargs)
            return json.dumps(result, indent=indent, sort_keys=sort_keys)
        return inner
    return actual_decorator

@json_output(indent=4)
def f():
    return {"status": "done"}

理解传参的装饰器

初次看起来会觉得比较绕人，因为函数里嵌套了两个函数定义，然而实际上和之前一个版本的区别在于为了接收json序列化的参数多包装了一层，所以

@json_output(indent=4)
def f():
    return {"status": "done"}

# 相当于
@actual_decorator
def f():
    return {"status": "done"}

这样看起来就会明晰很多。

实际上, 装饰器里的 @ 后接收一个函数，该函数以被装饰的函数(例子中是f)为参数，并且返回一个函数。当需要在装饰函数的同时传入参数的话，那么就需要多包装一层，先传入参数(例子中是 indent=4 )返回一个装饰的函数(例子中是 actual_decorator ), 这个返回的的函数就跟以前一样接受被装饰的函数(f)作为参数并且返回一个函数作为装饰最后的方法供调用。

传参和不传参的兼容

然而当我们像上面那样定义装饰器时，就不能这样调用:

import json
import functools

def json_output(indent=None, sort_keys=False):
    def actual_decorator(func):
        @functools.wraps(func)
        def inner(*args, **kwargs):
            result = func(*args, **kwargs)
            return json.dumps(result, indent=indent, sort_keys=sort_keys)
        return inner
    return actual_decorator

@json_output
def f():
    return {"status": "done"}

在实际的项目过程中，有时会出现这样的状况: 一开始写的装饰器时不需要使用时传参数的，后来发现有必要传参数，改好后原来不传参的装饰器不能正常使用了，这是修改原来使用的地方是项痛苦的事情。
这时候就需要对装饰器做一个兼容，使它在以下情况都可用:

@json_output
@json_output()
@json_output(indent=4)

具体做法如下:

import json
import functools

def json_output(decorated_=None, indent=None, sort_keys=False):
    if decorated_ and (indent or sort_keys):
        raise

    def actual_decorator(func):
        @functools.wraps(func)
        def inner(*args, **kwargs):
            result = func(*args, **kwargs)
            return json.dumps(result, indent=indent, sort_keys=sort_keys)
        return inner
    if decorated_:
        return actual_decorator(decorated_)
    else:
        return actual_decorator


@json_output(indent=4)
def f1():
    return {"status": "done"}

@json_output
def f2():
    return {"status": "done"}

@json_output()
def f3():
    return {"status": "done"}

print f1()
print f2()
print f3()

代码中关键的地方在于 json_output 在最后对参数 decorated 进行了判断，有的话证明是不传参调用，那么直接返回 actual_decorator 的调用；没有的话则代表是传参类型的调用（虽然参数可能不存在），那么返回 actual_decorator 。其中有点需要注意， josn_output 的传参需要使用关键字参数，如果像下面这样直接传一个位置参数，那么根据现在的实现会出现错误（因为它会被当成 decorated_ ）。

@json_output(4)  #错误的使用方法
def f4():
    return {"status": "done"}

参考资料

《Python高级编程》 by Luke Sneeriger

云服务器 GPU云服务器装饰器python python 装饰器装饰器装饰器模式

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/38291.html

Python 装饰器执行顺序迷思

摘要：探究多个装饰器执行顺序装饰器是用于封装函数或代码的工具，网上可以搜到很多文章可以学习，我在这里要讨论的是多个装饰器执行顺序的一个迷思。这时候你该知道为什么输出结果会是那样，以及对装饰器执行顺序实际发生了什么有一定了解了吧。探究多个装饰器执行顺序装饰器是Python用于封装函数或代码的工具，网上可以搜到很多文章可以学习，我在这里要讨论的是多个装饰器执行顺序的一个迷思。疑问大部...

frolc 2019-07-25 11:15 评论0 收藏0
Python装饰器-装饰流程,执行顺序

摘要：最近看到一个关于的题文章其中的一个是装饰器的顺序问题就想写篇博客回顾下装饰器首先强烈推荐很久之前看的一篇博文翻译理解中的装饰器关于什么是装饰器看这篇文章就好了这里主要想写关于多个装饰器的执行流程装饰顺序示例代码初始化初始化输出结果初始化初始最近看到一个关于Flask的CTF(RealWorld CTF 2018 web题bookhub)文章其中的一个trick是装饰器的顺序问题,就想...

cpupro 2019-07-30 17:35 评论0 收藏0
【Python】一文弄懂python装饰器（附源码例子）

摘要：装饰器的使用符合了面向对象编程的开放封闭原则。三简单的装饰器基于上面的函数执行时间的需求，我们就手写一个简单的装饰器进行实现。函数体就是要实现装饰器的内容。类装饰器的实现是调用了类里面的函数。类装饰器的写法比我们装饰器函数的写法更加简单。目录前言一、什么是装饰器二、为什么要用装饰器 ...

liuchengxu 2021-09-04 16:40 评论0 收藏0
Python: 会打扮的装饰器

摘要：一般情况下，我们使用装饰器提供的语法糖，来简化上面的写法像上面的情况，可以动态修改函数或类功能的函数就是装饰器。本文标题为会打扮的装饰器本文链接为参考资料修饰器的函数式编程中的装饰器介绍思诚之道装饰器入门与提高赖明星装饰器我们知道，在 Python 中，我们可以像使用变量一样使用函数：函数可以被赋值给其他变量函数可以被删除可以在函数里面再定义函数函数可以作为参数传递给另外...

blastz 2019-07-31 10:54 评论0 收藏0
Python学习之路26-函数装饰器和闭包

摘要：初步认识装饰器函数装饰器用于在源代码中标记函数，以某种方式增强函数的行为。函数装饰器在导入模块时立即执行，而被装饰的函数只在明确调用时运行。只有涉及嵌套函数时才有闭包问题。如果想保留函数原本的属性，可以使用标准库中的装饰器。《流畅的Python》笔记本篇将从最简单的装饰器开始，逐渐深入到闭包的概念，然后实现参数化装饰器，最后介绍标准库中常用的装饰器。 1. 初步认识装饰器函数装饰...

sunny5541 2019-07-30 16:45 评论0 收藏0