Python Mock之初探

Mock是什么

Mock这个词在英语中是模拟的意思,因此我们可以猜测出这个库的主要功能是模拟一些东西。准确的说,Mock是Python中一个用于支持单元测试的库,它的主要功能是使用mock对象替代掉指定的Python对象,以达到模拟对象的行为。

试想如下应用场景:
假设你开发的项目叫a,里面包含了一个模块b,模块b中的一个函数c(也就是a.b.c)在工作的时候需要调用发送请求给特定的服务器来得到一个JSON返回值,然后根据这个返回值来做处理。如果要为a.b.c函数写一个单元测试,该如何做?

首先想到的简单的方法是搭建一个服务器用来跟用户交互,不过这可能存在各种各样的现实问题,比如搭建服务器的成本(如时间/金钱等)很高,又或者测试服务器无法返回所有可能的值或者需要大量的工作才能达到这个目的。那么此时就可以利用mock替换掉测试服务器与用户的交互过程,这样返回值也会由mock对象来决定,而不需要测试服务器的参与。

Mock的安装及导入

# python 3.3以前的版本中,需要额外安装mock模块
pip install mock
import mock
# 从python 3.3开始,mock被集成到unittest模块中,可以直接import
from unit test import mock

Mock对象

基本用法

Mock对象是mock模块中最重要的概念。Mock对象就是mock模块中的一个类的实例,这个类的实例可以用来替换其他的Python对象,来达到模拟的效果。Mock类的定义如下:

class Mock(spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, **kwargs)

mock一个对象的一般步骤如下:

  1. 确定替换对象,是一个函数/类/类的实例;
  2. 建立mock对象(Mock实例化),并且设置这个对象的行为;
  3. 用建立的mock对象代替步骤1确定要替换的对象;
  4. 编写UT;

举个栗子:有一个简单的客户端实现,用来访问一个url,当访问正常时,需要返回状态码200,否则返回状态码404,客户端实现代码如下:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# client.py

import request
def send_request(url):
    r = request.get(url)
    return r.status_code

def visit_google():
    return send_request('www.google.com')

外部模块访问谷歌,下面我们使用mock对象在UT中分别测试访问正常和不正常的情况。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import client, mock, unittest
class TestClient(unittest.TestCase):

    def test_success_request(self):
        success_send = mock.Mock(return_value='200')
        client.send_request = success_request
        self.assertEqual(client.visit_google(), '200')

 def test_fail_request(self):
        fail_send = mock.Mock(return_value='404')
        client.send_request = fail_request
        self.assertEqual(client.visit_google(), '404')

mock用法拓展

class Mock参数

下面仅列出几个常用重要的参数:

  • name: 这个是用来命名一个mock对象,只是起到标识作用,当你print一个mock对象的时候,可以看到它的name。
  • return_value: mock对象被调用返回的值,默认值是一个mock对象。
  • side_effect: 这个参数指向一个可调用对象,一般就是函数。当mock对象被调用时,如果该函数返回值不是DEFAULT时,那么以该函数的返回值作为mock对象调用的返回值。

其他的参数可参考官方文档: http://www.voidspace.org.uk/python/mock/mock.html

mock对象的自动创建

当访问一个mock对象中不存在的属性时,mock会自动建立一个子mock对象,并且把正在访问的属性指向它,这个功能对于实现多级属性的mock很方便。

对方法调用进行检查

mock对象有一些方法可以用来检查该对象是否被调用过、被调用时的参数如何、被调用了几次等。实现这些功能可以调用mock对象的方法,具体的可以查看mock官方文档

patch和patch.object

patch

语法

from mock import patch
patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

具体参数的讲解可参见patch官方文档

运用

一般地patch有三种用法:函数装饰器,类装饰器,上下文管理器,到这初学者可能会一脸懵逼,话不多说直接上代码。

先写一个公共代码文件common.py方便上面所说三种用法的调用。

class something(object):
    def do_something():
        return 'Done'

测试patch三种用法的代码test_patch.py如下:

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

import common
from mock import patch

def new_func():
    print('welcome')

# 函数装饰器
@patch('common.something.do_something')
def test_patch(do_sth):
    do_sth.return_value = 'Not Done'
    print(common.something.do_something())

if __name__ == '__main__':
    patcher = patch('common.something', first='one', second='two') #类装饰器
    mock_thing = patcher.start()
    print(mock_thing.first)
    print(mock_thing.second)
    patcher.stop()

    test_patch()

    # contextmanager
    with patch('common.something.do_something') as mock_func: 
        mock_func.side_effect = [1,2,3]
        print(common.something.do_something())
        print(common.something.do_something())
        print(common.something.do_something())

    patcher = patch('__main__.new_func') # 函数装饰器
    patcher.start()
    new_func()
    patcher.stop()
    new_func()

#输出
#one
#two
#Not Done
#1
#2
#3
#welcome

patch.object

语法定义

#patch the named member (attribute) on an object (target) with a mock object
patch.object(target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

运用

从上面的语法定义不难看出,patch.objec跟patch的用法基本上是一样的,只是使用格式略微不同,举个栗子,使用patch.object来替换上面的test_patch。

# -*- coding: utf-8 -*-

import common
from mock import patch

@patch.object(common.something, 'do_something')
def test_patch(do_sth):
    do_sth.return_value = 'Not Done'
    print(common.something.do_something())

总的来说,patch和patch.object通过重新定义函数或类的行为来掩藏原来函数或类的行为,在一些应用场景比如UT测试会有神奇的效果。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容

  • 概要 64学时 3.5学分 章节安排 电子商务网站概况 HTML5+CSS3 JavaScript Node 电子...
    阿啊阿吖丁阅读 9,168评论 0 3
  • 〇、前言 本文共108张图,流量党请慎重! 历时1个半月,我把自己学习Python基础知识的框架详细梳理了一遍。 ...
    Raxxie阅读 18,941评论 17 410
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • 朗读训练
    夏天0608阅读 254评论 0 0
  • 我们每天有二十四个小时, 每天工 作八个小时, 用来养活自己和家人。 每天睡眠和休息八个小时, 用来保障身体的健康...
    再凑热闹阅读 120评论 0 0