Python 自制简易实用的日志装饰器

在 Python 编程中，日志是调试和监控程序运行状态的重要手段。通过自制一个简易实用的日志装饰器，我们可以更方便地在函数执行前后记录相关信息，提高代码的可维护性和可读性。

让我们来了解一下什么是装饰器。装饰器是 Python 中一种特殊的函数，它可以在不修改被装饰函数源代码的情况下，为函数添加额外的功能。

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

import functools
import logging

logging.basicConfig(level=logging.INFO)

def log_decorator(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        logging.info(f"调用函数 {func.__name__} 开始")
        result = func(*args, **kwargs)
        logging.info(f"调用函数 {func.__name__} 结束，返回结果: {result}")
        return result
    return wrapper

在上述代码中，我们定义了一个名为 log_decorator 的装饰器函数。它使用 functools.wraps 保留被装饰函数的元信息，如函数名、文档字符串等。

在 wrapper 函数内部，我们首先记录函数调用开始的日志，然后执行被装饰的函数，并获取其返回结果。最后，记录函数调用结束的日志以及返回的结果。

要使用这个装饰器，只需将需要记录日志的函数用 @log_decorator 进行装饰即可。

@log_decorator
def add_numbers(a, b):
    return a + b

add_numbers(3, 5)

当运行上述代码时，将会在控制台输出函数调用的开始和结束日志，以及返回的结果。

通过这种方式自制的日志装饰器，我们可以轻松地为多个函数添加统一的日志记录功能，无需在每个函数内部重复编写日志代码，提高了开发效率。清晰的日志信息有助于我们更好地理解程序的执行流程和状态，方便在出现问题时进行排查和调试。

自制日志装饰器是 Python 编程中的一项实用技巧，能够为我们的代码带来更好的可维护性和可观察性，提升开发质量。