使用装饰器优雅地记录方法调用：Python实践指南

Python标准库的logging模块虽然强大，但并没有直接提供类似于@log的内置装饰器来方便地记录方法调用。不过，我们可以利用Python的装饰器特性，自定义一个满足需求的日志记录装饰器。

自定义日志记录装饰器

下面是一个简单的日志记录装饰器的实现：

import logging import sys import functools  logging.basicConfig(stream=sys.stdout, level=logging.DEBUG) logger = logging.getLogger()  def log(func):     @functools.wraps(func)     def logged(*args, **kwargs):         logger.info(f"Calling {func.__name__} with args: {args}, kwargs: {kwargs}")         try:             result = func(*args, **kwargs)             logger.info(f"{func.__name__} returned: {result}")             return result         except Exception as e:             logger.error(f"{func.__name__} raised an exception: {e}")             raise  # Re-raise the exception     return logged  class A:     @log     def foo(self, x, y):         return x + y      @log     def bar(self, x, y):         return 1 / 0  a = A() a.foo(2, y=3) try:     a.bar(2, y=3) except Exception as e:     print(f"Caught exception: {e}")

代码解释：

1. 导入模块： 导入logging模块进行日志记录，sys用于配置日志输出流，functools用于保留被装饰函数的元信息。
2. 配置日志： 使用logging.basicConfig配置日志输出到标准输出，并将日志级别设置为DEBUG。
3. 定义log装饰器：
   • log(func)： 接受一个函数func作为参数，这个函数将会是被装饰的函数。
   • @functools.wraps(func): 使用functools.wraps装饰器，可以保留原始函数的__name__, __doc__ 等元信息，这对于调试和代码可读性非常重要。
   • logged(*args, **kwargs)： 这是实际执行的包装函数，它接受任意数量的位置参数*args和关键字参数**kwargs。
   • logger.info(f”Calling {func.__name__} with args: {args}, kwargs: {kwargs}”): 记录函数调用信息，包括函数名和参数。
   • try…except 块： 捕获函数执行过程中可能发生的异常，并使用logger.error记录异常信息。raise语句重新抛出异常，确保异常能够被调用者处理。
   • logger.info(f”{func.__name__} returned: {result}”): 记录函数返回值。
   • return result: 返回函数执行结果。
4. 应用装饰器： 使用@log装饰器修饰A类的foo和bar方法。

输出结果：

立即学习“Python免费学习笔记（深入）”；

INFO:root:Calling foo with args: (<__main__.A object at 0x0000022725D84D90>, 2), kwargs: {'y': 3} INFO:root:foo returned: 5 INFO:root:Calling bar with args: (<__main__.A object at 0x0000022725D84D90>, 2), kwargs: {'y': 3} ERROR:root:bar raised an exception: division by zero Caught exception: division by zero

注意事项和总结

• 异常处理： 在装饰器中捕获异常并重新抛出，可以确保异常不会被装饰器吞噬，同时也能记录异常信息。
• functools.wraps： 使用functools.wraps保留原始函数的元信息，提高代码可读性和调试效率。
• 日志级别： 根据实际需求调整日志级别，例如使用logging.DEBUG记录详细信息，使用logging.INFO记录一般信息，使用logging.ERROR记录错误信息。
• 自定义日志格式： 可以使用logging.Formatter自定义日志输出格式，例如添加时间戳、线程ID等信息。
• 性能影响： 日志记录会带来一定的性能开销，特别是在高并发场景下。可以考虑使用异步日志记录或采样日志等技术来降低性能影响。

通过自定义装饰器，我们可以灵活地实现方法调用日志记录，方便调试和监控。 结合functools.wraps和异常处理，可以编写出健壮且易于维护的日志记录装饰器。 记住根据实际需求调整日志级别和格式，并考虑性能影响。