Python unittest框架下测试用例如何获取自身标识用于日志记录

unittest 框架原生内置了可直接调用的测试用例唯一标识属性，不需要硬编码，也不需要额外开发复杂功能。

方案1：直接调用内置属性获取标识 #

每个测试方法运行时，当前 TestCase 实例的 id() 方法返回的字符串就是全局唯一的测试用例标识，格式为 模块名.测试类名.测试方法名，完全满足日志溯源需求。
如果只需要测试方法名维度的标识，也可以直接调用 self._testMethodName 属性。

示例代码：

import unittest
import logging

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

class TestOrderFlow(unittest.TestCase):
    def test_create_normal_order(self):
        # 获取当前测试用例全局唯一标识
        case_unique_id = self.id()
        logger.info(f"[{case_unique_id}] 开始构造下单参数")
        # 测试逻辑省略
        self.assertEqual(1+1, 2)
        logger.info(f"[{case_unique_id}] 下单成功，用例执行完成")

    def test_create_presale_order(self):
        case_unique_id = self.id()
        logger.info(f"[{case_unique_id}] 开始构造预售单参数")
        # 测试逻辑省略
        self.assertEqual(2*3, 6)

日志输出示例：

INFO:__main__:[__main__.TestOrderFlow.test_create_normal_order] 开始构造下单参数
INFO:__main__:[__main__.TestOrderFlow.test_create_normal_order] 下单成功，用例执行完成
INFO:__main__:[__main__.TestOrderFlow.test_create_presale_order] 开始构造预售单参数

方案2：封装基类实现全局自动打标 #

如果不想每个测试方法都手动获取标识，可以统一封装到测试基类，所有测试类继承基类后直接调用封装好的日志方法即可，完全不需要对业务用例做额外改造：

import unittest
import logging

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

# 统一测试基类，所有业务测试类继承该类
class BaseTestCase(unittest.TestCase):
    def log_info(self, msg: str):
        # 自动拼接测试用例唯一标识
        logger.info(f"[{self.id()}] {msg}")
    
    def log_error(self, msg: str):
        logger.error(f"[{self.id()}] {msg}")

# 业务测试类
class TestPaymentFlow(BaseTestCase):
    def test_wechat_pay(self):
        self.log_info("开始构造微信支付参数")
        # 测试逻辑省略
        self.log_info("支付回调验证成功")

    def test_alipay(self):
        self.log_info("开始构造支付宝支付参数")
        # 测试逻辑省略
        self.log_info("支付回调验证成功")

补充说明 #

• id() 方法返回的标识包含完整模块路径，就算不同模块、不同测试类存在同名测试方法，也不会出现标识重复的问题
• 如果你使用了参数化测试（比如ddt、unittest自带的subTest），id() 方法会自动拼接参数后缀，同样可以唯一区分同方法不同参数的测试用例

内容的提问来源于stack exchange，提问作者rkochar