Python单元测试(doctest和unittest)

最新推荐文章于 2025-10-07 12:28:44 发布

转载最新推荐文章于 2025-10-07 12:28:44 发布 · 622 阅读

python 专栏收录该内容

78 篇文章

订阅专栏

本文介绍了Python中的两种单元测试方法：doctest和unittest。通过示例详细展示了如何使用这两种方法来编写有效的测试用例，确保代码质量。

docstring

def collect_vowels(s):
    """ (str) -> str

    Return the vowels (a, e, i, o, and u) from s.

    >>> collect_vowels('Happy Anniversary!')
    'aAiea'
    >>> collect_vowels('xyz')
    ''
    """

    vowels = ''
    for char in s:
        if char in 'aeiouAEIOU':
            vowels = vowels + char
    return vowels
  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

通常我们可以在Python函数的docstring总编写一些测试用例其格式如下:

>>>func(param1)
return_value1
>>>func(param2)
return_value2
  1
2
3
4

doctest

使用Python的doctest库，可以一次性运行函数中所有的测试用例。
直接在交互式会话中

>>> import doctest
>>> doctest.testmod()
TestResults(failed=0, attempted=2)
  1
2
3

或在模块末尾中加入:

if __name__=='__main__':
    import doctest
    doctest.testmod()
  1
2
3

这样，每次在调用模块时都会先进行单元测试。

unittest

Python的unittest模块提供了类似doctest的测试框架。但是和doctest不同，unittest可以和待测试的函数分开编写。
如下的doctest可以被翻译成对应unittest

def get_divisors(num, possible_divisors):
    ''' (int, list of int) -> list of int

    Return a list of the values from possible_divisors
    that are divisors of num.

    >>> get_divisors(8, [1, 2, 3])
    [1, 2]
    >>> get_divisors(4, [-2, 0, 2])
    [-2, 2]
    '''

    divisors = []
    for item in possible_divisors:
        if item != 0 and num % item == 0:
            if num % item == 0:
                divisors.append(item)
    return divisors
  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

对应的unittest如下

import unittest
import divisors

class TestDivisors(unittest.TestCase):
    """Example unittest test methods for get_divisors."""

    def test_divisors_example_1(self):
        """Test get_divisors with 8 and [1, 2, 3]."""

        actual = divisors.get_divisors(8, [1, 2, 3])
        expected = [1, 2]
        self.assertEqual(expected, actual)  

    def test_divisors_example_2(self):  
        """Test get_divisors with 4 and [-2, 0, 2]."""

        actual = divisors.get_divisors(4, [-2, 0, 2])
        expected = [-2, 2]
        self.assertEqual(expected, actual)
  1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

调用unittest.main()，会检查当前模块内所有TestCase的子类，然后带用以”test”开头的方法，报告不符合预期的结果。
当在IDLE中调用unittest时，形参exit应当被赋值为False:unittest.main(exit=False)
一般地，每一个待测试的函数有一个TestCase子类，每一次函数调用对应一个test方法。