Python Learning-测试你写的代码

Python Learning-测试你写的代码_第1张图片

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

# 食物清单 
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-异常处理

你可能感兴趣的:(Python Learning-测试你写的代码)