Python函数怎样用装饰器记录函数调用日志 Python函数日志装饰器的使用技巧​

import functools
import logging
import time

# 配置一个基本的日志器，方便演示
# 实际项目中，日志配置会更复杂，通常会写入文件，并设置滚动策略等
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

def log_function_call(func):
    @functools.wraps(func) # 这一行很重要，它保留了原始函数的元信息，比如函数名和文档字符串
    def wrapper(*args, **kwargs):
        func_name = func.__name__
        # 记录函数调用前的日志，包含参数
        arg_str = ', '.join([repr(arg) for arg in args])
        kwarg_str = ', '.join([f"{k}={repr(v)}" for k, v in kwargs.items()])
        full_args_str = f"({arg_str}{', ' if arg_str and kwarg_str else ''}{kwarg_str})"
        logger.info(f"进入函数: {func_name}{full_args_str}")

        start_time = time.time()
        try:
            result = func(*args, **kwargs) # 执行原始函数
            # 记录函数成功执行后的日志，包括返回值和执行时间
            logger.info(f"函数 {func_name} 成功返回, 返回值: {repr(result)}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            return result
        except Exception as e:
            # 捕获异常，记录错误日志，并重新抛出
            logger.error(f"函数 {func_name} 发生异常: {type(e).__name__}: {e}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            raise # 重新抛出异常，不改变原始函数的行为
    return wrapper

# 怎么用呢？很简单，在函数定义前加上@log_function_call
@log_function_call
def calculate_sum(a, b):
    """计算两个数的和"""
    time.sleep(0.1) # 模拟一些耗时操作
    return a + b

@log_function_call
def greet_user(name, greeting="Hello"):
    """向用户问好"""
    return f"{greeting}, {name}!"

@log_function_call
def divide(a, b):
    """尝试除法操作"""
    time.sleep(0.05)
    return a / b

# 调用试试看
calculate_sum(10, 20)
greet_user("Alice", greeting="Hi")
try:
    divide(10, 0) # 尝试触发异常
except ZeroDivisionError:
    logger.info("捕获到ZeroDivisionError，这是预期行为。")

log_function_call

func

*args

**kwargs

functools.wraps

try...except

@log_function_call

print

logger.info