本文旨在介绍如何利用装饰器实现方法调用的日志记录。
首先，我们来看一下如何自定义一个简单的@log装饰器来实现方法调用的日志记录：
import logging, sys
logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
logger = logging.getLogger()
def log(func):
def logged(*args, **kwargs):
logger.info(f"{func.__name__} starting with args={args} kwargs={kwargs}...")
result = func(*args, **kwargs)
logger.info(f"{func.__name__} finished.")
return result
return logged
class A:
@log
def foo(self, x, y):
pass
@log
def bar(self, x, y):
try:
1/0
except Exception as e:
logger.error(f"{func.__name__} encountered an error: {e}")
raise
a = A()
a.foo(2, y=3)
try:
a.bar(2, y=3)
except Exception as e:
pass # Handle the exception appropriately代码解析:
- 导入模块: 首先，我们导入了logging和sys模块。logging模块用于日志记录，sys模块用于配置日志输出流。
- 配置日志: logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)配置日志输出到标准输出，并将日志级别设置为DEBUG，这意味着DEBUG级别及以上的日志都会被输出。logger = logging.getLogger()获取一个logger实例。
-
定义log装饰器: log函数是一个装饰器，它接受一个函数func作为参数，并返回一个新的函数logged。
- logged函数接受任意数量的位置参数*args和关键字参数**kwargs。
- 在logged函数内部，首先使用logger.info记录方法调用的开始，包括方法名、参数和关键字参数。
- 然后，调用原始函数func并将结果保存到result变量中。
- 最后，使用logger.info记录方法调用结束，并返回结果。
- 应用装饰器: 在A类的foo和bar方法上使用@log装饰器，这样每次调用这些方法时，都会自动记录日志。
- 错误处理: 在bar方法中，添加了try-except块来捕获异常并记录错误日志。这有助于调试和追踪代码中的问题。
注意事项:
- 日志级别: 根据需要调整日志级别。DEBUG级别会输出最详细的日志，而INFO、WARNING、ERROR和CRITICAL级别则会输出不同严重程度的日志。
- 日志格式: 可以自定义日志格式，例如添加时间戳、线程ID等信息。
- 异常处理: 在装饰器中处理异常时，需要谨慎。如果只是简单地捕获异常而不重新抛出，可能会导致程序行为异常。
总结:
虽然Python标准库的logging模块没有内置的@log装饰器，但我们可以轻松地自定义一个。通过使用装饰器，我们可以简洁地记录方法调用，方便调试和追踪代码执行流程。在实际应用中，可以根据需要定制装饰器的行为，例如添加更详细的日志信息、处理异常等。
