Python Learning-测试你写的代码

为了测试,我们需要准备一个已经写好的代码;下面的函数从食品清单里返回一个食品名称

# 食物清单 
foods = ['apple', 'pear', 'milk', 'noodles', 'tomato']

def get_food(food):
    '''从食品清单中返回存在的食物名称'''
    
    if food in foods:
        # 返回开头是大写的食物名称
        return food.title()
    else:
        return 'None'
    
# 调用函数
food_name = get_food('apple')
# 打印结果
print(food_name)

输出:

Apple

就像上面的写法,如果想知道一个函数是否运行正常,通常情况下是调用这个函数,并提供相应的参数,查看结果是否可靠;但是如果要对函数进行修改,那每次修改后都需要重新运行程序,从而调用函数得出结果,不得不说,这样很麻烦

单元测试

Python的标准库里的unittest模块提供了代码测试功能

单元测试是指通过一个断言,而判断代码是否正常

而将多个单元测试组合起来,则构成一个测试用例

想要写出好的测试用例,需要考虑到各种情况下的输入;在大型项目中,往往需要建立一整套单元测试达到全覆盖式测试

创建测试用例

# 导入单元测试模块
import unittest

# >>>下面是被测试的代码
class FoodName():
    '''将之前的代码封装到一个类中'''
    
    def __init__(self):
        '''初始化食品清单'''
        self.foods = ['apple', 'pear', 'milk', 'noodles', 'tomato']

    def get_food(self, food):
        '''从食品清单中返回存在的食物名称'''
        
        if food in self.foods:
            # 返回开头是大写的食物名称
            return food.title()
        else:
            return 'None'
    
# >>>下面是测试用例代码 
class FoodNameTestCase(unittest.TestCase):
    '''测试用例代码'''
    
    def test_get_food_name(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_name = FoodName().get_food('apple')
        #断言food_name与'Apple'是否一样
        self.assertEqual(food_name, 'Apple')
        
# 开始测试        
unittest.main()

输出:

.

Ran 1 test in 0.069s

OK

为了方便,我们将所有代码都放在了一个模块中,即都写在了一个文件下

  • 首先,导入了unittest模块
  • 将被测试的代码都封装到一个类中,方便调用,也可以将其置于另一个模块中
  • 创建一个测试类,这里这个测试类名字叫FoodNameTestCase,这个类的名字可以自定义,但建议要有指出是测试什么,并且其中包含'Test'字样,方便理解;重点是,该类一定要继承unittest.TestCase类!
  • 测试类中的测试方法必须以test开头来命名,这里是test_get_food_name,因为在运行unittest.main()的时候,测试类中所有以test开头的方法都会自动被运行
  • food_name = FoodName().get_food('apple')调用被测试的函数,得到了一个返回值
  • assertEqual方法是一个断言方法,即判断第一个参数与第二个参数是否一致,上例的输出是测试通过后的结果,会显示测试消费时长与ok字样

再来看如果测试不通过的例子,这里将return food.title()改为return food

# 导入单元测试模块
import unittest

# >>>下面是被测试的代码
class FoodName():
    '''将之前的代码封装到一个类中'''
    
    def __init__(self):
        '''初始化食品清单'''
        self.foods = ['apple', 'pear', 'milk', 'noodles', 'tomato']

    def get_food(self, food):
        '''从食品清单中返回存在的食物名称'''
        
        if food in self.foods:
            # 返回开头是大写的食物名称
            return food
        else:
            return 'None'
    
# >>>下面是测试用例代码 
class FoodNameTestCase(unittest.TestCase):
    '''测试用例代码'''
    
    def test_get_food_name(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_name = FoodName().get_food('apple')
        #断言food_name与'Apple'是否一样
        self.assertEqual(food_name, 'Apple')
        
# 开始测试        
unittest.main()

输出:

F
======================================================================
FAIL: test_get_food_name (main.FoodNameTestCase)
本方法测试被调用的函数
----------------------------------------------------------------------
Traceback (most recent call last):
File "C:/Users/Administrator/AppData/Local/Programs/Python/Python37-32/s.py", line 31, in test_get_food_name
self.assertEqual(food_name, 'Apple')
AssertionError: 'apple' != 'Apple'

  • apple
    ? ^
  • Apple
    ? ^

----------------------------------------------------------------------
Ran 1 test in 0.018s

FAILED (failures=1)

第一行输出了F,是指失败FAIL的意思,如果被测试的代码抛出了错误,第一行则会输出E

接下来的内容是指出失败的原因,并给出了测试结果与预定义结果的区别等内容

当测试失败,则能令我们明确之前编写的代码哪里有问题,通过重构,优化代码,减少Bug

其它的断言方法

unittest.TestCase类中提供了多种断言方法,如下:

断言方法 用途
assertEqual(a, b) 核实 a == b
assertNotEqual(a, b) 核实 a != b
assertTure(x) 核实x为True
assertFalse(x) 核实x为False
assertIn(item, list) 核实item在list中
assertNotIn(item, list) 核实item不在list中

扩展

这里将上面的被测试代码做了修改,增加了一个返回食品列表的方法,并在测试代码中增加了对该方法的测试用例

# 导入单元测试模块
import unittest

# >>>下面是被测试的代码
class FoodName():
    '''将之前的代码封装到一个类中'''
    
    def __init__(self):
        '''初始化食品清单'''
        self.foods = ['apple', 'pear', 'milk', 'noodles', 'tomato']

    def get_food(self, food):
        '''从食品清单中返回存在的食物名称'''
        
        if food in self.foods:
            # 返回开头是大写的食物名称
            return food.title()
        else:
            return 'None'
        
    def get_food_list(self):
        '''返回食品列表'''
        return self.foods
    
# >>>下面是测试用例代码 
class FoodNameTestCase(unittest.TestCase):
    '''测试用例代码'''
    
    def test_get_food_name(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_name = FoodName().get_food('apple')
        #断言food_name与'Apple'是否一样
        self.assertEqual(food_name, 'Apple')
        
    def test_get_food_list(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_list = FoodName().get_food_list()
        self.assertIn('apple', food_list)
        
# 开始测试        
unittest.main()

输出:

..

Ran 2 tests in 0.011s

OK

如果被测试的类中有很多个方法需要测试,则每个测试的方法中都要实例化一个被测试的类的对象FoodName(),为了节省开销与简化代码,可使用方法setUp,如下

class FoodNameTestCase(unittest.TestCase):
    '''测试用例代码'''
    
    def setUp(self):
        '''在这里实例化要被测试的对象类'''
        self.f = FoodName()
        
    def test_get_food_name(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_name = self.f.get_food('apple')
        #断言food_name与'Apple'是否一样
        self.assertEqual(food_name, 'Apple')
        
    def test_get_food_list(self):
        '''本方法测试被调用的函数'''
        
        # 调用被测试的函数
        food_list = self.f.get_food_list()
        self.assertIn('apple', food_list)

setUp中实例化一个类后,在其它的测试方法中都可以使用这个对象,相当于存储在当前测试类中的一个属性

目录
上一章 Python Learning-异常处理

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