Python装饰器之类装饰器详解

2025-04-27 17:50
文章标签 python 详解 装饰

本文主要是介绍Python装饰器之类装饰器详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《Python装饰器之类装饰器详解》本文将详细介绍Python中类装饰器的概念、使用方法以及应用场景,并通过一个综合详细的例子展示如何使用类装饰器,希望对大家有所帮助,如有错误或未考虑完全的地方,望不...

1. 引言

python中,装饰器是一种允许我们在不改变原有代码的情况下,动态地增加或修改函数和类功能的工具。

类装饰器相较于函数装饰器,功能更为强大和灵活,因为它们不仅可以修饰类的方法,还可以修饰类本身。

2. 装饰器的基本概念

装饰器是一个接受函数或类并返回一个新函数或新类的高阶函数。它们通常通过 @ 符号来使用。

在使用装饰器时,我们将装饰器放在被装饰对象的上方,这样装饰器就会在对象创建时自动应用。

2.1. 函数装饰器复习

在介绍类装饰器之前,我们先简单回顾一下函数装饰器的基本用法。

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
    return wrapper

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

say_hello("Alice")

运行上述代码,输出结果为:

Something is happening before the function is called.
Hello, Alice!
Something is happening after the function is called.

2.2 类装饰器的定义和使用

类装饰器与函数装饰器类似,只不过它们接受一个类作为参数,并返回一个新类。

最简单的类装饰器可以这样定义:

def class_decorator(cls):
    class WrappedClass(cls):
        def new_method(self):
            print("This is a new method added by the decorator.")
        def existing_method(self)ktXkmwjaC:
            print("This method is overridden by the decorator.")
    return WrappedClass

@class_decorator
class MyClass:
    def existing_method(self):
        print("This method exists in the original class.")

obj = MyClass()
obj.new_method()          # 调用新增的方法
obj.existing_method()     # 调用被重写的方法

运行上述代码,输出结果为:

This is a new method added by the decorator.
This method is overridden by the decorator.

在这个例子中,class_decorator 是一个类装饰器,它接受一个类 MyClass 作为参数,并返回一个新的类 WrappedClassWrappedClass 继承自 MyClass,并新增和重写了一些方法。

3. 类装饰器的应用场景

类装饰器在实际开发中有很多应用场景,下面是几个常见的例子:

3.1. 自动添加属性

类装饰器可以用来自动为类添加一些属性。

例如,我们可以创建一个装饰器,自动为类添加一个 created_at 属性,记录对象的创建时间。

import datetime

def add_timestamp(cls):
    class WrappedClass(cls):
        def __init__(self, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.created_at = datetime.datetime.now()
    return WrappedClass

@add_timestamp
class MyClass:
    def __init__(self, name):
        self.name = name

obj = MyClass("Alice")
print(obj.name)        # 输出: Alice
print(obj.created_at)  # 输出: 对象的创建时间

3.2 访问控制

类装饰器可以用来控制类的方法访问权限。

例如,我们可以创建一个装饰器,要求调用某些方法时必须有管理员权限javascript

def require_admin(cls):
    class WrappedClass(cls):
        def admin_method(self, *args, **kwargs):
            if not self.is_admin:
                raise PermissionError("Admin privileges required")
            return super().admin_method(*args, **kwargs)
    return WrappedClass

@require_admin
class MyClass:
 android   def __init__(self, is_admin):
        self.is_admin = is_admin

    def admin_method(self):
        print("This is an admin method.")

admin_obj = MyClass(is_admin=True)
admin_obj.admin_method()  # 正常调用

user_obj = MyClass(is_admin=False)
user_obj.admin_method()   # 抛出 PermissionError

3.3 数据验证

类装饰器可以用来在类方法调用前进行数据验证。

例如,我们可以创建一个装饰器,验证方法参数的类型。

def validate_params(cls):
    class WrappedClass(cls):
        def method_with_validation(self, x):
            if not isinstance(x, int):
                raise ValueError("Parameter x must be an integer")
            return super().method_with_validation(x)
    return WrappedClass

@validate_params
class MyClass:
    def method_with_validation(self, x):
        print(f"Received {x}")

obj = MyClass()
obj.method_with_validation(10)  # 正常调用
obj.method_with_validation("a") # 抛出 ValueError

4. 综合示例

接下来,我们将通过一个综合示例来展示如何使用类装饰器。

这个示例将包含一个日志记录装饰器、一个权限检查装饰器和一个数据验证装饰器。

import datetime

def log_activity(cls):
    class WrappedClass(cls):
        def __getattribute__(self, name):
            attr = super().__getattribute__(name)
            if callable(attr):
                def logged(*args, **kwargs):
                    print(f"Calling {name} with arguments {args} and {kwargs} at {datetime.datetime.now()}")
                    result = attr(*args, **kwargs)
                    print(f"{name} returned {result}")
                    return result
                return logged
            return attr
    return WrappedClass

def require_permission(permission):
    def decorator(cls):
        class WrappedClass(cls):
            def __getattribute__(self, name):
                attr = super().__getattribute__(name)
                if callable(attr):
                    def secured(*args, **kwargs):
                        if not self.has_permission(permission):
                            raise PermissionError(f"Permission {permission} required")
                        return attr(*args, **kwargs)
                    return secured
                return attr
        return WrappedClass
    return decorator

def validate_params(cls):
    class WrappedClass(cls):
        def method_with_validation(sChina编程elf, x):
            if not isinstance(x, int):
                raise ValueError("Parameter x must be an integer")
            return super().method_with_validation(x)
    return WrappedClass

@log_activity
@require_permission("admin")
@validate_params
class MyClass:
    def __init__(self, is_admin):
     android   self.is_admin = is_admin

    def has_permission(self, permission):
        return self.is_admin

    def method_with_validation(self, x):
        return f"Received {x}"

# 测试综合示例
admin_obj = MyClass(is_admin=True)
print(admin_obj.method_with_validation(10))  # 正常调用

try:
    admin_obj.method_with_validation("a")  # 抛出 ValueError
except ValueError as e:
    print(e)

user_obj = MyClass(is_admin=False)
try:
    user_obj.method_with_validation(10)  # 抛出 PermissionError
except PermissionError as e:
    print(e)

4.1 输出结果

Calling __init__ with arguments (True,) and {} at 2024-07-11 14:23:45.123456
__init__ returned None
Calling method_with_validation with arguments (10,) and {} at 2024-07-11 14:23:45.123456
method_with_validation returned Received 10
Received 10
Calling method_with_validation with arguments ('a',) and {} at 2024-07-11 14:23:45.123456
Parameter x must be an integer
Calling __init__ with arguments (False,) and {} at 2024-07-11 14:23:45.123456
__init__ returned None
Calling method_with_validation with arguments (10,) and {} at 2024-07-11 14:23:45.123456
Permission admin required

4.2 解释

  1. 日志记录装饰器:记录类的方法调用,包括输入参数和返回值。
  2. 权限检查装饰器:检查用户是否具有调用方法的权限。
  3. 数据验证装饰器:验证方法参数的类型。

通过这种方式,我们可以在不修改类本身的情况下,为类添加额外的功能。

总结

类装饰器是 Python 中一个非常强大的工具,可以用来扩展和修改类的行为。通过类装饰器,我们可以在不修改原始代码的情况下为类添加额外的功能。

在实际开发中,类装饰器有很多应用场景,包括日志记录、访问控制、数据验证等。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持China编程(www.chinasem.cn)。

这篇关于Python装饰器之类装饰器详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154398

相关文章

基于Python编写一个git自动上传的脚本(打包成exe)

《基于Python编写一个git自动上传的脚本(打包成exe)》这篇文章主要为大家详细介绍了如何基于Python编写一个git自动上传的脚本并打包成exe,文中的示例代码讲解详细,感兴趣的小伙伴可以跟... 目录前言效果如下源码实现利用pyinstaller打包成exe利用ResourceHacker修改e

Python在二进制文件中进行数据搜索的实战指南

《Python在二进制文件中进行数据搜索的实战指南》在二进制文件中搜索特定数据是编程中常见的任务,尤其在日志分析、程序调试和二进制数据处理中尤为重要,下面我们就来看看如何使用Python实现这一功能吧... 目录简介1. 二进制文件搜索概述2. python二进制模式文件读取(rb)2.1 二进制模式与文本

Python中Tkinter GUI编程详细教程

《Python中TkinterGUI编程详细教程》Tkinter作为Python编程语言中构建GUI的一个重要组件,其教程对于任何希望将Python应用到实际编程中的开发者来说都是宝贵的资源,这篇文... 目录前言1. Tkinter 简介2. 第一个 Tkinter 程序3. 窗口和基础组件3.1 创建窗

基于C++的UDP网络通信系统设计与实现详解

《基于C++的UDP网络通信系统设计与实现详解》在网络编程领域,UDP作为一种无连接的传输层协议,以其高效、低延迟的特性在实时性要求高的应用场景中占据重要地位,下面我们就来看看如何从零开始构建一个完整... 目录前言一、UDP服务器UdpServer.hpp1.1 基本框架设计1.2 初始化函数Init详解

Django调用外部Python程序的完整项目实战

《Django调用外部Python程序的完整项目实战》Django是一个强大的PythonWeb框架,它的设计理念简洁优雅,:本文主要介绍Django调用外部Python程序的完整项目实战,文中通... 目录一、为什么 Django 需要调用外部 python 程序二、三种常见的调用方式方式 1:直接 im

Python字符串处理方法超全攻略

《Python字符串处理方法超全攻略》字符串可以看作多个字符的按照先后顺序组合,相当于就是序列结构,意味着可以对它进行遍历、切片,:本文主要介绍Python字符串处理方法的相关资料,文中通过代码介... 目录一、基础知识:字符串的“不可变”特性与创建方式二、常用操作:80%场景的“万能工具箱”三、格式化方法

springboot+redis实现订单过期(超时取消)功能的方法详解

《springboot+redis实现订单过期(超时取消)功能的方法详解》在SpringBoot中使用Redis实现订单过期(超时取消)功能,有多种成熟方案,本文为大家整理了几个详细方法,文中的示例代... 目录一、Redis键过期回调方案(推荐)1. 配置Redis监听器2. 监听键过期事件3. Redi

Springboot配置文件相关语法及读取方式详解

《Springboot配置文件相关语法及读取方式详解》本文主要介绍了SpringBoot中的两种配置文件形式,即.properties文件和.yml/.yaml文件,详细讲解了这两种文件的语法和读取方... 目录配置文件的形式语法1、key-value形式2、数组形式读取方式1、通过@value注解2、通过

浅析python如何去掉字符串中最后一个字符

《浅析python如何去掉字符串中最后一个字符》在Python中,字符串是不可变对象,因此无法直接修改原字符串,但可以通过生成新字符串的方式去掉最后一个字符,本文整理了三种高效方法,希望对大家有所帮助... 目录方法1:切片操作(最推荐)方法2:长度计算索引方法3:拼接剩余字符(不推荐,仅作演示)关键注意事

自定义注解SpringBoot防重复提交AOP方法详解

《自定义注解SpringBoot防重复提交AOP方法详解》该文章描述了一个防止重复提交的流程,通过HttpServletRequest对象获取请求信息,生成唯一标识,使用Redis分布式锁判断请求是否... 目录防重复提交流程引入依赖properties配置自定义注解切面Redis工具类controller