Python 装饰器妙用

1,226 阅读2分钟

Python 的装饰器是一种非常强大的工具,允许程序员在不修改原有函数定义的情况下,增加额外的功能。装饰器的应用场景非常广泛,从日志记录、性能测试、事务处理到缓存、权限校验等都有涉及。本文将通过几个实例详细介绍如何巧妙地使用 Python 中的装饰器来解决实际问题。

日志记录

日志记录是开发中常见的需求,通过装饰器,可以轻松地为函数添加日志记录功能,而不必在每个函数中手动添加日志代码。

import logging

def log_decorator(func):
    def wrapper(*args, **kwargs):
        logging.info(f"Running '{func.__name__}' with arguments {args} and {kwargs}")
        return func(*args, **kwargs)
    return wrapper

@log_decorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")

性能测试

在性能调优时,常常需要测量代码的执行时间。装饰器能够让这一过程自动化和标准化。

import time

def timing_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"{func.__name__} took {end_time - start_time:.4f} seconds to run.")
        return result
    return wrapper

@timing_decorator
def slow_function(delay_time):
    time.sleep(delay_time)

slow_function(2)

缓存结果

对于耗时的计算,特别是那些输入和输出固定的函数,使用装饰器缓存结果可以显著提高性能。

from functools import lru_cache

@lru_cache(maxsize=32)
def fib(n):
    if n < 2:
        return n
    return fib(n-1) + fib(n-2)

print(fib(10))

权限校验

在 Web 开发中,经常需要对用户进行权限校验。装饰器可以帮助我们优雅地实现这一功能。

from functools import wraps

def permission_required(permission):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            user_permission = kwargs.get('user_permission')
            if user_permission != permission:
                raise Exception("Permission denied")
            return func(*args, **kwargs)
        return wrapper
    return decorator

@permission_required('admin')
def delete_user(user_id, user_permission):
    print(f"User {user_id} has been deleted.")

# delete_user(1, user_permission='admin') # Success
# delete_user(1, user_permission='guest') # Exception: Permission denied

参数校验

装饰器同样可以用于对函数参数进行校验,确保它们符合特定条件。

from functools import wraps

def type_check(correct_type):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            if not all([isinstance(arg, correct_type) for arg in args]):
                raise ValueError("Incorrect argument type")
            return func(*args, **kwargs)
        return wrapper
    return decorator

@type_check(str)
def string_repeat(string, times):
    return string * times

print(string_repeat("hello", 3))  # Works
# string_repeat("hello", "3")  # Raises ValueError

结尾

装饰器提供了一种高效、优雅的方法来增强函数的功能,它们能够帮助我们以最小的代码改动实现功能的扩展。通过本文所举示例,可以看到装饰器在实际开发中的强大威力和灵活应用。正确地使用装饰器,可以使代码更加简洁、易于维护,并且增强代码的可读性和可用性。