Python装饰器使用接口测试的步骤

写接口case时，有时需要对cae做一些共性的操作，最典型的场景如：获取case执行时间、打印log等。

有没有一种办法来集中处理共性操作从而避免在每个case中都写相同的代码（如：每个case都需要写相同的获取执行时间的代码）呢？

Python的装饰器可以做到这一点。

可以这样理解装饰器，装饰器运用闭包对目标函数进行装饰（目标函数作为闭包外部函数的引用），即在执行目标函数之前、之后执行一些指定的代码来完成想要的业务逻辑。

概念看起来总是晦涩，直接上语法吧。

第一步，先看一下闭包的语法：

def outer(a):
    b = 10
    # inner是内函数
    def inner():
        # 在内函数中 用到了外函数的临时变量
        print(a + b)
    # 外函数的返回值是内函数的引用
    return inner

第二步，再来看一下闭包的装饰器版本的语法：

和上面闭包的例子只有一个区别：闭包中外部函数的引用是一个整数a，而此时是一个函数的引用（函数的引用也就是函数名）。

# 装饰器用到闭包原理：外函数内部定义了一个内函数，内函数使用外函数的局部变量，并且外函数返回了内函数的引用
def outer(target):   # 装饰器函数 传入一个想对其装饰的目标函数的 引用，将在内函数中使用。
　　 b = 10
    c = 1
    d = 5
    # inner是内函数
    def inner():
        print(b + c)
        # 外部函数传入的参数target，就是希望装饰的目标函数的引用
        target()   # 这里实际上执行了目标函数，想对这个函数进行装饰，所以在该函数执行之前和之后进行一番操作，具体什么操作看业务逻辑
        print(c + d)
    # 外函数的返回值是内函数的引用
    return inner

注意：target只是函数的一个引用（引用指向函数在内存中的位置），不会执行。带（）时（ target() ）才会执行该函数。

最后一步，再看一下装饰器的语法：

@decorator
    def test_01():

所以可以总结出：装饰器decorator是闭包的外部函数，即 outer() （装饰器是一个函数，即闭包的外部函数），被装饰函数test_01是闭包传入的参数，即target。

举个例子：

以统计各接口请求耗时为例。

装饰器（decorat.py）：

import time
def time_consume(func):
    def inner():
        time_start = time.time()  # 目标函数开始之前取一下时间
        print("\n接口请求前的时间是", time_start)
        func()
        time_end = time.time()  # 目标函数结束之后取一下时间
        print("接口请求后的时间是", time_end)
        t = time_end - time_start  # 计算目标函数执行花了多长时间
        print("接口耗时:", t)
    return inner

接口（test_case.py）：

import requests
import decorat
@decorat.time_consume
def test_demo():
    res = requests.get("https://www.baidu.com")
    assert res.status_code == 200

效果：

再来总结下这个例子的整个过程：

'''
@decorat.time_consume实际上执行的是: test_demo = @decorat.time_consume(test_demo)
因为编程语言都是从右向左来解析执行的，那么这句代码会发生的事情是：

    1 、把目标函数test_demo(是一个变量名，里面存的是目标函数的引用) 传入time_consume函数，被参数func接收，这时func也是目标函数的引用 func和test_demo指向同一个函数对象    
    2 、time_consume函数定义了内部函数inner，在inner里调用func，
    这用到闭包的原理（闭包原理：外函数结束的时会把自身的引用绑定给内函数），外函数结束的时候会把func绑定给内函数，供内函数来使用
    3、 外函数结束的时候把自己创建的内函数的引用inner返回给test_demo接收，
     这时test_demo已经不是原来编写的目标函数了，test_demo可以理解成是一个inner函数的实例对象，再执行test_demo() 的时候实际上执行了inner()的一个对象
    4、 再执行test_demo() 的时候 实际上执行了inner() ：
     先执行取时间，打印
     之后执行func()，才是执行目标函数，即执行test_demo()本身
     最后再次取时间，打印结果

大白话版本：

其实就一句话：
被装饰函数作为装饰器外部函数的参数传入，在装饰器的内部函数中执行被装饰函数，并外加其他的代码片段A，
这样被装饰函数除了具备自身的逻辑外，也拥有了装饰器内部函数中代码片段A的逻辑。使得无需修改被装饰函数，
就增强了被装饰函数的功能。

再来看两种情景。

第一个：被装饰函数有参数

一般接口测试的test_case不会想上面例子中提到的是一个函数，而是作为一个类的方法出现的，比如：

运行报错了，报错日志的意思是inner()需要0个入参，但是被传入了1个。通过该报错证明了上面提到的这个结论

原因是test_demo()有参数self，而inner()没有定义入参。怎么解决呢，给inner()定义一个可变入参？先来看第二个问题，最后一起来证明我们的推测吧。

第二个：被装饰函数有返回值

问题出现了，返回值打印出来是None，因为inner()里没有变量去接收test_demo的返回值并返回吗？带着第一个问题的推测，一起来改下代码。

做2处改动：

1、inner()定义可变入参

2、inner()里定义变量去接收test_demo的返回值并return该变量

test_case作为一个类的方法出现的问题解决了。

返回值也能被正常打印了。

改动后的装饰器可以作为一个定义装饰器的通用模板，基本可以给各种各样的函数来装饰了。

def decorat_demo(func):
    def inner(*args, **kwargs):   # inner()接收可变参数
        # any code before # 定义目标函数前的操作
        # 调用目标函数
        res = func(*args, **kwargs)  # 定义变量接收目标函数返回值
        # any code after # 定义目标函数后的操作
        return res     # 返回目标函数返回值
    return inner

到此这篇关于Python装饰器使用接口测试的步骤的文章就介绍到这了,更多相关python装饰器接口测试内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论