Python基础之装饰器

目录

• 1 装饰器
  • 1.1 定义
    • 1.1.1 基本语法
    • 1.1.2 装饰器执行流程
    • 1.1.3 带参数的装饰器
  • 1.2 使用类中装饰器
    • 1.2.1 使用类中实例装饰器
    • 1.2.2 类装饰器
    • 1.2.3 使用类方法装饰器
    • 1.2.4 使用类中静态装饰器
    • 1.2.5 使用类中普通装饰器
  • 1.3 获取装饰器中函数名字
  • 1.4 内部装饰器
    • 1.4.1 @property
• 2 常用装饰器
  • 2.1 @timer:测量执行时间
  • 2.2 @memoize:缓存结果
  • 2.3 @validate_input:数据验证
  • 2.4 @log_results:日志输出
  • 2.5 @suppress_errors:优雅的错误处理
  • 2.6 @validate_output:确保质量结果
  • 2.7 @retry:重试执行
  • 2.8 @visualize_results:漂亮的可视化
  • 2.9 @debug:调试变得更容易
  • 2.10 @deprecated:处理废弃的函数

1 装饰器

装饰器（Decorators）是Python中一种强大而灵活的功能，用于修改或增强函数或类的行为。

1.1 定义

装饰器本质上是一个函数，它接受另一个函数或类作为参数，并返回一个新的函数或类。它们通常用于在不修改原始代码的情况下添加额外的功能或功能
装饰器函数是一种Python语言中的特殊函数，它可以用来修改其他函数的行为。装饰器函数通常接受一个函数作为参数，并返回一个新的函数，这个新函数通常会在原函数的基础上添加一些额外的功能

作用：为函数增加新功能，减少重复性操作，使代码简洁

1.1.1 基本语法

def decorator_function(original_function):
    def wrapper(*args, **kwargs):
        # 这里是在调用原始函数前添加的新功能
        before_call_code()     
        result = original_function(*args, **kwargs)      
        # 这里是在调用原始函数后添加的新功能
        after_call_code()  
        return result
    return wrapper

# 使用装饰器
@decorator_function
def target_function(arg1, arg2):
    pass  # 原始函数的实现

解析：decorator 是一个装饰器函数，它接受一个函数 func 作为参数，并返回一个内部函数 wrapper，在 wrapper 函数内部，可以执行一些额外的操作，然后调用原始函数 func，并返回其结果。

• decorator_function：装饰器，它接收一个函数 original_function 作为参数。
• wrapper：内部函数，它是实际会被调用的新函数，它包裹了原始函数的调用，并在其前后增加了额外的行为。
• 当使用 @decorator_function 前缀在 target_function 定义前，Python 会自动将 target_function 作为参数传递给 decorator_function，然后将返回的 wrapper 函数替换掉原来的 target_function

装饰器通过 @ 符号应用在函数定义之前，例如：

@time_logger
def target_function():
    pass
等同于：

def target_function():
    pass
target_function = time_logger(target_function)

这会将 target_function 函数传递给 decorator 装饰器，并将返回的函数重新赋值给 target_function。从而，每次调用 target_function 时，实际上是调用了经过装饰器处理后的函数。

1.1.2 装饰器执行流程

装饰器执行流程：

• 当定义装饰器 decorator_function 时，它并没有立即执行。它只是被定义在内存中，等待被使用。
• 当在函数 target_function 前使用 @decorator_function 时，Python解释器会立即执行decorator_function(target_function)，并将返回值（即wrapper函数）重新绑定到 target_function 这个变量名上。此时，原函数target_function 并没有被调用或修改，只是它的引用被替换成了wrapper函数的引用。
• 当 调用target_function ()时，其实是在调用wrapper函数。wrapper函数会在调用原函数 target_function 前后添加额外的逻辑，并最终返回原函数的执行结果。

点击此处了解 Python函数中函数作为返回值

1.1.3 带参数的装饰器

装饰器函数也可以接受参数，例如：

def repeat(n):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(n):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(3)
def greet(name):
    print(f"Hello, {name}!")

greet("Alice")

以上代码中 repeat 函数是一个带参数的装饰器，它接受一个整数参数 n，然后返回一个装饰器函数。该装饰器函数内部定义了 wrapper 函数，在调用原始函数之前重复执行 n 次。因此，greet 函数在被 @repeat(3) 装饰后，会打印三次问候语。

1.2 使用类中装饰器

使用装饰器的步骤：

• 定义装饰器
• 通过@调用装饰器

1.2.1 使用类中实例装饰器

装饰器一般是放在全局命名空间或单独一个类里，但是把装饰器放到类里面，相当于把一个函数变成类的方法

class Decorators:
	def log_func(self,func):
		def wrapper(*args,**kwargs):
			print(f"function start")
			print(f"args:{args}")
			ret=func(*args,**kwargs)
			print(f"function end!")
			return ret
		return wrapper

d=Decorators()
@d.log_func
def fib(n):
	if n<=1:
		return 0
	return fib(n-1)+fib(n-2)

fib(3)

使用缺点：每次使用装饰器必须创建一个对象，且self参数没有用

1.2.2 类装饰器

Python 类装饰器是包含 __call__ 方法的类，它接受一个函数作为参数，并返回一个新的函数。

class DecoratorClass:
    def __init__(self, func):
        self.func = func
   
    def __call__(self, *args, **kwargs):
        # 在调用原始函数之前/之后执行的代码
        result = self.func(*args, **kwargs)
        # 在调用原始函数之后执行的代码
        return result

@DecoratorClass
def my_function():
    pass

1.2.3 使用类方法装饰器

不用实例中装饰器可以使用类中装饰器，添加@classmethod变成类方法

class Decorators:
	@classmethod
	def log_func(cls,func):
		def wrapper(*args,**kwargs):
			print(f"function start")
			print(f"args:{args}")
			ret=func(*args,**kwargs)
			print(f"function end!")
			return ret
		return wrapper

@Decorators.log_func
def fib(n):
	if n<=1:
		return 0
	return fib(n-1)+fib(n-2)

fib(3)

这种方式虽然不用创建对象了，直接类名调用，但是第一个参数cls依然没用到

1.2.4 使用类中静态装饰器

假如装饰器和对象无关，和类无关，可以使用静态装饰器@staticmethod

class Decorators:
	@staticmethod
	def log_func(func):
		def wrapper(*args,**kwargs):
			print(f"function start")
			print(f"args:{args}")
			ret=func(*args,**kwargs)
			print(f"function end!")
			return ret
		return wrapper

@Decorators.log_func
def fib(n):
	if n<=1:
		return 0
	return fib(n-1)+fib(n-2)

fib(3)

这种方式虽然不用创建对象，直接类名调用，也不会有第一个参数没用到的情况
当把一个装饰器封装到类里面时，这个方式就不错
注意：用@staticmethod修饰的装饰器不能装饰类里面的方法，会直接报错

1.2.5 使用类中普通装饰器

如果在含有装饰器的类中使用自己的装饰器时，可以把装饰器当成普通方法

class Decorators:	
	# 此处的log_func可以理解为辅助函数或辅助装饰器
	def log_func(func):
		def wrapper(*args,**kwargs):
			print(f"function start")
			print(f"args:{args}")
			ret=func(*args,**kwargs)
			print(f"function end!")
			return ret
		return wrapper

	@log_func
	def fib(n):
		if n<=1:
			return 0
		return fib(n-1)+fib(n-2)
	
	# 在类中或类外都可以使用装饰器添加如下方法
	# 这句话只能放到类末尾
	log_func=staticmethod(log_func)
d=Decorators()
d.fib(3)

如上代码，就可以在类中或者类外都使用装饰器

1.3 获取装饰器中函数名字

函数也是对象，它有 __name__ 等属性，但经过decorator装饰之后的函数，它们的__name__已经从原来的now变成了wrapper，如下

def log(func):
    def wrapper(*args, **kw):
        print 'call %s():' % func.__name__
        return func(*args, **kw)
    return wrapper

@log
def now():
    print '2023-12-25'
    
print(now.__name__)  结果：wrapper

因为返回的那个wrapper()函数名字就是wrapper，所以，需要把原始函数的__name__等属性复制到wrapper()函数中，否则，有些依赖函数签名的代码执行就会出错。
不需要编写wrapper.__name__ = func.__name__这样的代码，Python内置的functools.wraps就是干这个事的，所以，一个完整的decorator的写法如下：

import functools

def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print 'call %s():' % func.__name__
        return func(*args, **kw)
    return wrapper

@log
def now():
    print '2023-12-25'
    
print(now.__name__)  结果：now

1.4 内部装饰器

1.4.1 @property

@property 是Python中的一个内置装饰器，它可以将一个方法转换为属性。具体来说，@property 装饰器可以将一个方法转换为只读属性，这意味着我们可以像访问属性一样访问这个方法，而不需要调用它。例如：

class MyClass:
    def __init__(self, x):
        self._x = x
    @property
    def x(self):
        return self._x

在这个例子中，我们定义了一个名为 MyClass 的类，并在其中定义了一个名为 x 的方法。我们使用 @property 装饰器将该方法转换为只读属性，这样我们就可以像访问属性一样访问这个方法

obj = MyClass(42)
	print(obj.x)  # 输出 42

即：带有@property装饰器的函数被调用时，后面不能加小括号()

2 常用装饰器

2.1 @timer:测量执行时间

优化代码性能是非常重要的。@timer装饰器可以帮助我们跟踪特定函数的执行时间。通过用这个装饰器包装函数，我可以快速识别瓶颈并优化代码的关键部分。下面是它的工作原理:

import time

def timer(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:.2f} seconds to execute.")
		return result
	return wrapper
@timer
def my_data_processing_function():
# Your data processing code here

将@timer与其他装饰器结合使用，可以全面地分析代码的性能。

2.2 @memoize:缓存结果

在数据科学中，我们经常使用计算成本很高的函数。@memoize装饰器帮助我缓存函数结果，避免了相同输入的冗余计算，显著加快工作流程:

def memoize(func):
	cache = {}
	def wrapper(*args):
		if args in cache:
			return cache[args]
		result = func(*args)
		cache[args] = result
		return result
	return wrapper
@memoize
def fibonacci(n):
	if n <= 1:
		return n
	return fibonacci(n - 1) + fibonacci(n - 2)

在递归函数中也可以使用 @memoize来优化重复计算。

2.3 @validate_input:数据验证

数据完整性至关重要， @validate_input 装饰器可以验证函数参数，确保它们在继续计算之前符合特定的标准:

def validate_input(func):
	def wrapper(*args, **kwargs):
		# Your data validation logic here
		if valid_data:
			return func(*args, **kwargs)
		else:
			raise ValueError("Invalid data. Please check your inputs.")

	return wrapper
@validate_input
def analyze_data(data):
# Your data analysis code here

可以方便的使用@validate_input在数据科学项目中一致地实现数据验证。

2.4 @log_results:日志输出

在运行复杂的数据分析时，跟踪每个函数的输出变得至关重要。@log_results装饰器可以帮助我们记录函数的结果，以便于调试和监控:

def log_results(func):
	def wrapper(*args, **kwargs):
		result = func(*args, **kwargs)
		with open("results.log", "a") as log_file:
			log_file.write(f"{func.__name__} - Result: {result}\n")
			return result

		return wrapper
@log_results
def calculate_metrics(data):
# Your metric calculation code here

将@log_results与日志库结合使用，以获得更高级的日志功能。

2.5 @suppress_errors:优雅的错误处理

数据科学项目经常会遇到意想不到的错误，可能会破坏整个计算流程。@suppress_errors装饰器可以优雅地处理异常并继续执行:

def suppress_errors(func):
	def wrapper(*args, **kwargs):
		try:
			return func(*args, **kwargs)
		except Exception as e:
			print(f"Error in {func.__name__}: {e}")
			return None
		return wrapper
@suppress_errors
def preprocess_data(data):
# Your data preprocessing code here

@suppress_errors可以避免隐藏严重错误，还可以进行错误的详细输出，便于调试

2.6 @validate_output:确保质量结果

确保数据分析的质量至关重要。@validate_output装饰器可以帮助我们验证函数的输出，确保它在进一步处理之前符合特定的标准:

def validate_output(func):
	def wrapper(*args, **kwargs):
		result = func(*args, **kwargs)
		if valid_output(result):
			return result
		else:
			raise ValueError("Invalid output. Please check your function logic.")
	return wrapper

@validate_output
def clean_data(data):
# Your data cleaning code here

这样可以始终为验证函数输出定义明确的标准。

2.7 @retry:重试执行

@retry装饰器帮助我在遇到异常时重试函数执行，确保更大的弹性:

import time

def retry(max_attempts, delay):
	def decorator(func):
		def wrapper(*args, **kwargs):
			attempts = 0
			while attempts < max_attempts:
				try:
					return func(*args, **kwargs)
				except Exception as e:
					print(f"Attempt {attempts + 1} failed. Retrying in {delay} seconds.")
					attempts += 1
					time.sleep(delay)
			raise Exception("Max retry attempts exceeded.")
		return wrapper
	return decorator

@retry(max_attempts=3, delay=2)
def fetch_data_from_api(api_url):
# Your API data fetching code here

使用@retry时应避免过多的重试。

2.8 @visualize_results:漂亮的可视化

@visualize_results装饰器数据分析中自动生成漂亮的可视化结果

import matplotlib.pyplot as plt

def visualize_results(func):
	def wrapper(*args, **kwargs):
		result = func(*args, **kwargs)
		plt.figure()
		# Your visualization code here
		plt.show()
		return result
	return wrapper

@visualize_results
def analyze_and_visualize(data):
# Your combined analysis and visualization code here

2.9 @debug:调试变得更容易

调试复杂的代码可能非常耗时。@debug装饰器可以打印函数的输入参数和它们的值，以便于调试:

def debug(func):
	def wrapper(*args, **kwargs):
		print(f"Debugging {func.__name__} - args: {args}, kwargs: {kwargs}")
		return func(*args, **kwargs)
	return wrapper
@debug
def complex_data_processing(data, threshold=0.5):
# Your complex data processing code here

2.10 @deprecated:处理废弃的函数

随着我们的项目更新迭代，一些函数可能会过时。@deprecated装饰器可以在一个函数不再被推荐时通知用户:

import warnings

def deprecated(func):
	def wrapper(*args, **kwargs):
		warnings.warn(f"{func.__name__} is deprecated and will be removed in future versions.", DeprecationWarning)
		return func(*args, **kwargs)
	return wrapper
@deprecated
def old_data_processing(data):
# Your old data processing code here