python BeautifulReport的测试用例描述在哪里写 代码示例

在使用 BeautifulReport 生成测试报告时，可以在测试用例中添加 docstring 来描述该用例的目的、输入、输出等信息，这些信息会被自动添加到测试报告中。

以下是一个示例代码，其中在 test_example 方法的 docstring 中添加了测试用例的描述：

import unittest
from BeautifulReport import BeautifulReport


class TestExample(unittest.TestCase):

    def test_example(self):
        """
        测试用例描述：测试示例方法
        输入：无
        输出：返回值为 True
        """
        self.assertTrue(True)


if __name__ == '__main__':
    suite = unittest.TestSuite()
    suite.addTest(TestExample('test_example'))

    # 指定报告生成路径及文件名
    result = BeautifulReport(suite)
    result.report(filename='测试报告', description='测试示例方法', log_path='./report')

在生成的测试报告中，会自动将 docstring 中的描述信息添加到报告中，如下图所示：