本文深入探讨了如何使用装饰器在 Python 中记录方法调用，旨在提供一种简洁而高效的日志记录方案。通过自定义装饰器，我们可以轻松地在方法执行前后添加日志信息，无需修改原始方法代码。虽然 Python 标准库的 logging 模块本身没有内置的装饰器来实现此功能，但我们可以构建自己的装饰器来满足需求。本文将提供一个实用的装饰器示例，并讨论其使用方法和注意事项。
在软件开发中，日志记录是至关重要的组成部分，它可以帮助我们追踪代码执行流程、诊断问题和监控系统状态。对于面向对象的编程，记录方法调用尤其有用。虽然 Python 的 logging 模块功能强大，但并没有直接提供一个内置的装饰器来记录方法调用。因此，我们需要自定义装饰器来实现这个功能。
自定义日志记录装饰器
以下是一个用于记录方法调用的装饰器示例：
import logging
import 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}...")
try:
result = func(*args, **kwargs)
logger.info(f"{func.__name__} finished.")
return result
except Exception as e:
logger.error(f"{func.__name__} raised an exception: {e}")
raise # Re-raise the exception to avoid masking errors
return logged代码解释：
立即学习“Python免费学习笔记（深入）”；
- log(func) 函数: 这是一个装饰器工厂函数，它接受一个函数 func 作为参数，并返回一个新的函数 logged。
- logged(*args, **kwargs) 函数:* 这是被装饰的函数实际执行的包装器函数。它接受任意数量的位置参数 `args和关键字参数kwargs`。
- logger.info(...): 在方法调用前后，我们使用 logger.info() 记录方法名、参数和执行状态。
- try...except 块: 我们使用 try...except 块来捕获方法执行过程中可能发生的异常，并使用 logger.error() 记录异常信息。重要的是，我们使用 raise 重新抛出异常，以确保错误不会被屏蔽。
使用装饰器
要使用这个装饰器，只需在要记录的方法上方添加 @log 即可：
class A:
@log
def foo(self, x, y):
print(f"foo called with x={x}, y={y}")
return x + y
@log
def bar(self, x, y):
print(f"bar called with x={x}, y={y}")
return 1 / 0 # Intentionally raise an exception现在，当我们调用 foo 和 bar 方法时，将会生成相应的日志信息：
a = A()
result = a.foo(2, y=3)
print(f"foo result: {result}")
try:
a.bar(2, y=3)
except Exception as e:
print(f"Caught exception: {e}")输出示例：
INFO:root:foo starting with args=(<__main__.A object at 0x...>, 2) kwargs={'y': 3}...
foo called with x=2, y=3
INFO:root:foo finished.
foo result: 5
INFO:root:bar starting with args=(<__main__.A object at 0x...>, 2) kwargs={'y': 3}...
bar called with x=2, y=3
ERROR:root:bar raised an exception: division by zero
Caught exception: division by zero注意事项
- 日志级别: 根据实际需求调整日志级别（例如，DEBUG、INFO、WARNING、ERROR）。
- 性能影响: 频繁的日志记录可能会对性能产生一定影响。在生产环境中，应谨慎选择需要记录的方法，并避免记录过多的细节。
- 参数格式化: 在记录参数时，可以使用更复杂的格式化方式，例如使用 pprint 模块来美化输出。
- 异常处理: 确保在装饰器中正确处理异常，避免屏蔽原始异常。
- 继承: 如果需要在继承的类中使用装饰器，需要注意装饰器的行为是否符合预期。
总结
通过自定义装饰器，我们可以方便地记录 Python 方法的调用信息，从而提高代码的可调试性和可维护性。虽然 Python 标准库没有内置的装饰器来实现此功能，但自定义装饰器非常简单且灵活。在实际应用中，应根据具体需求调整装饰器的行为，并注意性能影响和异常处理。 记住，良好的日志记录习惯是编写高质量代码的关键。
