pytest -- ⽇志与测试报告

logging 是 Python 标准库中的⼀个模块，它提供了灵活的⽇志记录功能。通过 logging ，开发者可以⽅便地将⽇志信息输出到控制台、⽂件、⽹络等多种⽬标，同时⽀持不同级别的⽇志记录，以满⾜不同场景下的需求。

⽰例1：全局logging

python 复制代码

import logging
logging.basicConfig(level=logging.INFO)
logging.debug('This is a debug message')
logging.info('This is an info message')
logging.warning('This is a warning message')
logging.error('This is an error message')
logging.critical('This is a critical message')

⽰例2：⾃定义logger并输出到控制台

python 复制代码

# 导⼊ logging 模块
import logging
logging.basicConfig(level=logging.INFO)
# 获取⼀个⽇志记录器对象，名称为当前模块的名称
logger = logging.getLogger(__name__)
# 设置⽇志记录器的级别为 DEBUG
# 这意味着所有级别为 DEBUG 及以上的⽇志都会被记录
logger.setLevel(logging.DEBUG)
if __name__ == "__main__":
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

⽰例3：⾃定义logger并输出到⽇志⽂件

python 复制代码

# 导⼊ logging 模块
import logging
# 获取⼀个⽇志记录器对象，名称为当前模块的名称
logger = logging.getLogger(__name__)
# 设置⽇志记录器的级别为 DEBUG
# 这意味着所有级别为 DEBUG 及以上的⽇志都会被记录
logger.setLevel(logging.DEBUG)
# 创建⼀个 FileHandler 对象，指定⽇志⽂件的名称为 "test.log"
# 这个处理器会将⽇志信息写⼊到指定的⽂件中
handler = logging.FileHandler(filename="test.log")
# 将这个处理器添加到⽇志记录器中
# 这样，⽇志记录器就会使⽤这个处理器来处理⽇志信息
logger.addHandler(handler)
if __name__ == "__main__":
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

• 获取⽇志记录器： logging.getLogger(name) 获取⼀个⽇志记录器对象， name 是当前模块的名称。使⽤模块名称作为⽇志记录器的名称有助于在⼤型项⽬中区分不同模块的⽇志.

• 设置⽇志级别： logger.setLevel(logging.DEBUG) 将⽇志记录器的级别设置为DEBUG ，这意味着所有 DEBUG 及以上级别的⽇志都会被记录.

⽇志级别⾦字塔：DEBUG < INFO < WARNING < ERROR < CRITICAL⾼于设定级别的⽇志才会被处理

• 创建⽂件处理器： logging.FileHandler(filename="test.log") 创建⼀个⽂件处理器，将⽇志信息写⼊到名为 test.log 的⽂件中.

• 添加处理器： logger.addHandler(handler) 将⽂件处理器添加到⽇志记录器中，这样⽇志记录器就会使⽤这个处理器来处理⽇志信息

⽰例4：设置⽇志格式

python 复制代码

# 导⼊ logging 模块
import logging
# 获取⼀个⽇志记录器对象，名称为当前模块的名称
logger = logging.getLogger(__name__)
# 设置⽇志记录器的级别为 DEBUG
# 这意味着所有级别为 DEBUG 及以上的⽇志都会被记录
logger.setLevel(logging.DEBUG)
# 创建⼀个 FileHandler 对象，指定⽇志⽂件的名称为 "test.log"
# 这个处理器会将⽇志信息写⼊到指定的⽂件中
handler = logging.FileHandler(filename="test.log")
# 创建⼀个⽇志格式器对象
formatter = logging.Formatter(
"%(asctime)s %(levelname)s [%(name)s] [%(filename)s (%(funcName)s:%
(lineno)d)] - %(message)s"
)
# 将格式器设置到处理器上
handler.setFormatter(formatter)
# 将这个处理器添加到⽇志记录器中
# 这样，⽇志记录器就会使⽤这个处理器来处理⽇志信息
logger.addHandler(handler)
if __name__ == "__main__":
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

logging.Formatter 是⽤于定义⽇志输出格式的类。在构造函数中，传递了⼀个格式字符串，⽤于指定⽇志信息的格式。格式字符串中使⽤了⼀些特殊的占位符（以 % 开头），这些占位符会被替换为相应的⽇志信息内容

handler.setFormatter(formatter) 将创建的格式器对象设置到处理器上。这意味着处理器在处理⽇志信息时，会使⽤这个格式器来格式化⽇志信息.

通过这种⽅式，你可以控制⽇志信息的输出格式，使其包含你感兴趣的信息，如时间戳、⽇志级别、⽂件名、函数名、⾏号等。