unittest | 使用unittest模块来测试logging日志模块功能

我们在这篇文章实现了在项目工程中编写一个logging模块，但是我们如何确定我们编写的模块功能的是否正常?

你可能想到将全部代码写完后运行测试，但这是一个非常不好的习惯。❌

最好的方式，是每写出来一个功能或者方法就对它进行测试，这样可以确保，当你完成代码后并运行，可以很少出现Bug,能直接运行成功。可以使用Python自带的unittest模块来做✔

unittest

unittest 是 Python 标准库中的一个模块，它提供了一套编写和运行自动化测试的框架。unittest 支持自动化测试，设置和关闭代码以供测试，聚合测试到集合中以及独立的测试脚本运行。

以下是 unittest 的一些核心概念和用法：

• 测试用例（Test Cases）：
  测试用例是测试的基本单元。在 unittest 中，你通过创建一个继承自 unittest.TestCase 的类来编写测试用例。
• 测试方法（Test Methods）：
  测试方法以 test 开头。它们包含了实际的测试逻辑，unittest 会自动运行所有以 test 开头的方法。
• 断言方法（Assert Methods）：
  unittest 提供了一系列的断言方法，如assertEqual、assertTrue、assertFalse 等，用于检查测试结果是否符合预期。
• 测试套件（Test Suites）：
  测试套件是一组测试用例的集合。你可以使用 unittest.TestSuite 或 unittest.TestLoader 来创建和管理测试套件。
• 测试运行器（Test Runners）：
  测试运行器负责运行测试套件，并收集结果。unittest 提供了 unittest.TextTestRunner 来在命令行中运行测试。
• 测试夹具（Test Fixtures）：
  测试夹具是测试之前和之后运行的代码，用于设置和关闭测试环境。setUp 方法在每个测试方法之前运行，tearDown 方法在每个测试方法之后运行。

setUp : 可以理解为测试前需要提前执行的代码 例如连接数据库
tearDown : 可以理解为收尾工作 例如关闭数据库

logging单元测试

在test文件夹中创建测试文件：test_logging_util.py

from unittest import TestCase
from util.logging_util import init_logger
from logging import RootLogger

class MyTest(TestCase):
    def setUp(self) -> None: # 测试前需要提前执行的代码  例如连接数据库
        pass

    def test_myfunc(self):
        logger = init_logger() 
        result = isinstance(logger,RootLogger) #判断是不是  某个类的实例
        self.assertEqual(result,True)
        self.assertIsInstance(logger,RootLogger)

    def tearDown(self)-> None: # 收尾工作
        pass

• 结果
  

python是动态类型的语言 只有执行到这里才知道这个变量是什么类型的

logger = init_logger()

class Logging():
    def __init__(self,level=20):
        self.logger = logging.getLogger()
        self.logger.setLevel(level)


def init_logger():
    logger = Logging(level).logger

    # 缓存机制 避免日志重复输出
    if logger.handlers:
        return logger

    path = log_root_path+log_filename
    # 创建并打开文件
    with open(path, 'w') as file:
        # 文件被创建，但这里不写入任何内容，所以它是空的
        pass
    # 构造handler
    # 优化日志存储文件 StreamHandler
    stream_handler = logging.StreamHandler()
    file_handler = logging.FileHandler(
        filename=path,
        mode='a',
        encoding='utf-8'
    )

    fmt = logging.Formatter('%(asctime)s - [%(levelname)s] - %(filename)s[%(lineno)d]：%(message)s')

    stream_handler.setFormatter(fmt)
    file_handler.setFormatter(fmt)

    # 组合
    logger.addHandler(stream_handler)
    logger.addHandler(file_handler)

    return logger

logging.getLogger() 源码

def getLogger(name=None):
    """
    Return a logger with the specified name, creating it if necessary.

    If no name is specified, return the root logger.
    """
    if name:
        return Logger.manager.getLogger(name)
    else:
        return root

没有指定日志记录器的名称则就是默认是根日志记录器

• 解答：-> None 方便我们写出更健壮的语言

# -> xxx  :方便我们写出更健壮的语言
def setUp(self) -> None: # 返回是None
	pass
	
def add(a,b)->str:
	return str(a+b)

def add(a:float,b:float)->float:
	return str(a+b)

RootLogger

在Python的logging模块中，RootLogger是日志系统的最高级别的记录器。每个日志记录器都有一个层次结构，而RootLogger是这个层次结构的根。当你创建一个日志记录器（logger）时，如果没有明确指定它的父记录器，它默认会继承RootLogger的配置。

from logging import RootLogger

class RootLogger(Logger):
    """
    A root logger is not that different to any other logger, except that
    it must have a logging level and there is only one instance of it in
    the hierarchy.
    """
    def __init__(self, level):
        """
        Initialize the logger with the name "root".
        """
        Logger.__init__(self, "root", level)

因此这三行代码才可以执行：

 result = isinstance(logger,RootLogger) #判断是不是  某个类的实例
 self.assertEqual(result,True)
 self.assertIsInstance(logger,RootLogger)

小结

RootLogger的默认级别是WARNING，这意味着默认情况下，只有WARNING级别及以上（ERROR和CRITICAL）的日志消息会被处理。如果你想要记录所有级别的日志，你需要将RootLogger的级别设置得更低，比如DEBUG。

import logging

# 获取RootLogger
root_logger = logging.getLogger()

# 设置日志级别为DEBUG
root_logger.setLevel(logging.DEBUG)

# 创建一个handler，例如控制台处理器
console_handler = logging.StreamHandler()

# 为handler设置级别
console_handler.setLevel(logging.DEBUG) # ⭐ 设置成级别更低的日志记录器

# 创建一个日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 设置handler的格式
console_handler.setFormatter(formatter)

# 将handler添加到RootLogger
root_logger.addHandler(console_handler)

# 测试日志输出
root_logger.debug('这是一个DEBUG级别的消息')
root_logger.info('这是一个INFO级别的消息')
root_logger.warning('这是一个WARNING级别的消息')
root_logger.error('这是一个ERROR级别的消息')
root_logger.critical('这是一个CRITICAL级别的消息')