我们掌握了try-except来处理程序运行中可能遇到的异常,以及使用logging来记录程序运行日志,该篇文章就结合二者来讲讲如何记录程序运行过程中的各种事件、状态信息以及遇到的异常情况,以便于追踪、诊断和解决程序运行时的问题。
目录
一、配置日志记录器 (logging.Logger)
二、 使用日志记录器记录信息
三、异常处理与日志记录
一、配置日志记录器 (logging.Logger
)
首先,创建一个日志记录器实例,并根据需要配置其级别、输出格式、过滤规则等属性。常用的日志级别包括(由低到高):DEBUG
, INFO
, WARNING
, ERROR
, CRITICAL
。日志格式可以自定义,通常包含时间戳、日志级别、源模块名、进程/线程ID、以及具体的消息内容。
import logging
import time
#创建一个日志记录器
logger=logging.getLogger(__name__)
logger.setLevel(logging.DEBUG) #设置日志记录器的最低输出级别为DEBUG#设置日志格式
formatter=logging.Formatter("%(asctime)s - %(name)s - %(levelname)s -%(modulename)s - %(message)s")
datefmt="%Y-%m-%d %H:%M:%S"#添加日志处理器,控制台、文件
#控制台日志
stream_handler=logging.StreamHandler() #输出到控制台
stream_handler.setFormatter(formatter) #设置日志格式
stream_handler.setLevel(logging.INFO) #单独设置控制台的输出级别为INFO#文件日志
file_handler = logging.FileHandler(filename=f"{time.strftime('%Y-%m-%d')}_app.log", encoding='utf-8') #输出到文件、文件名格式为:年-月-日_LOG.log
file_handler.setFormatter(formatter)#设置日志格式
file_handler.setLevel(logging.DEBUG)#单独设置文件日志的输出级别为DEBUG#添加日志处理器
logger.addHandler(stream_handler)
logger.addHandler(file_handler)
二、 使用日志记录器记录信息
在代码中,根据需要在适当的位置调用日志记录器的方法来记录不同级别的信息。这有助于跟踪程序执行流程、记录关键决策点、参数值、中间结果等。
def complex_computation(item):# 一个可能出现错误的复杂计算过程if item=='error':raise ValueError("Divide by zero error!")return item/2
def process_data(data):logger.debug(f"Function called with param: {data}")try:# 执行可能会出错的操作if not isinstance(data,list):raise ValueError("data must be a list")for item in data:#假设某个计算过程可能出错result=complex_computation(item)print(result)except ValueError as ve:#记录异常信息logger.error(f"ValueError: {ve}")except Exception as e:#记录未知异常信息logger.exception(f"Exception: {e}")
三、异常处理与日志记录
在可能出现异常的地方使用 try-except
结构捕获异常,并在 except
块中使用日志记录异常信息。这样,即使程序因异常而中断,也能确保异常的相关细节被记录下来,便于后续分析。
try:process_data([1,2,3,'error',4,5])
except Exception as e:logging.critical(f'Critical failure during processing: {e}',exc_info=True)#处理全局异常,或者直接让程序退出except ValueError as ve:logger.warning(f"ValueError caught: {ve}")# 处理或恢复操作
except SomeCustomException as sce:logger.error(f"Custom exception encountered: {sce}", extra={'context': additional_info})# 特定异常处理
except Exception as e:logger.critical("Unexpected error occurred:", exc_info=True)# 发送报警通知、保存现场数据等