当前位置: 首页 > 科技观察

为什么装饰器在Python代码中很重要

时间:2023-03-13 14:39:55 科技观察

01什么是装饰器?要了解装饰器是什么,首先需要熟悉Python处理函数的方式。从它的角度来看,函数与对象没有什么不同。它们具有属性并且可以重新分配:deffunc():print('hellofromfunc')func()>hellofromfuncnew_func=funcnew_func()>hellofromfuncprint(new_func.__name__)>func此外,您可以将它们作为参数传递给其他函数:deffunc():print('hellofromfunc')defcall_func_twice(callback):callback()callback()call_func_twice(func)>hellofromfunc>hellofromfunc现在,我们介??绍装饰器。装饰器用于修改函数或类的行为。实现这一点的方法是定义一个返回另一个函数的函数(装饰器)。这听起来很复杂,但通过这个例子你会明白一切:print(f'After{func.__name__}')returnlogging_wrapper@logging_decoratordefsum(x,y):print(x+y)sum(2,5)>Beforesum>7>Aftersum让我们一步一步来:首先,我们定义第一行的logging_decorator函数,它只接受一个参数,就是我们要装饰的函数。在内部,我们定义了另一个函数:logging_wrapper。然后返回logging_wrapper,用它代替原来的装饰函数。在第7行,您可以看到装饰器是如何应用于sum函数的。在第11行,当我们调用sum时,它不只是调用sum。它将调用logging_wrapper,它将在调用sum之前和之后记录。02为什么需要装饰器很简单:可读性。Python以语法清晰简洁着称,装饰器也不例外。如果有任何行为是多个函数共有的,那么你可能需要做一个装饰器。以下是一些可能会派上用场的示例:在运行时检查参数类型函数调用的基准测试结果计数缓存函数调用检查元数据(权限、角色等)元编程等等...现在我们将列出一些代码示例。03ExampleDecoratorwithreturnvalue假设我们想知道每个函数调用需要多长时间。此外,函数大部分时间都会返回一些东西,所以装饰器也必须处理它:**kwargs)after=datetime.datetime.now()print"ElapsedTime={0}".format(after-before)returnresult@timer_decoratordefsum(x,y):print(x+y)returnx+ysum(2,5)>7>ElapsedTime=sometime如您所见,我们将返回值存储在第5行的结果中。但是在返回之前,我们必须完成对函数的计时。这是一个没有装饰器就不可能实现的行为示例。带参数的装饰器有时,我们想要一个接受值的装饰器(如Flask中的@app.route('/login'):defpermission_decorator(permission):def_permission_decorator(func):defpermission_wrapper(*args,**kwargs):ifsomeUserApi。hasPermission(permission):result=func(*args,**kwargs)returnresultreturnNonereturnpermissionwrapperreturn_permission_decorator@permission_decorator('admin')defdelete_user(user):someUserApi.deleteUser(user)带有一个参数并返回装饰器的额外函数。带类的装饰器可以用类而不是函数来装饰。唯一的区别是语法,所以请使用你更熟悉的。写日志装饰器:classLogging:def__init__(self,function):self.function=functiondef__call__(self,*args,**kwargs):print(f'Before{self.function.__name__}')self.function(*args,**kwargs)print(f'After{self.function.__name__}')@Loggingdefsum(x,y):print(x+y)sum(5,2)>Beforesum>7>这样做的好处是的,你不需要必须处理嵌套函数。您需要做的就是定义一个类并覆盖__call__方法。装饰类有时,您可能想要装饰类中的每个方法。你可以这样写classMyClass:@decoratordeffunc1(self):pass@decoratordeffunc2(self):pass但如果你有很多方法,这可能会失控。值得庆幸的是,有一种方法可以一次性装饰整个类:deflogging_decorator(func):deflogging_wrapper(*args,**kwargs):print(f'Before{func.__name__}')result=func(*args,**kwargs)print(f'After{func.__name__}')返回结果returnlogging_wrapperdeflog_all_class_methods(cls):classNewCls(object):def__init__(self,*args,**kwargs):self.original=cls(*args,**kwargs)def__getattribute__(self,s):try:x=super(NewCls,self).__getattribute__(s)exceptAttributeError:passelse:returnxx=self.original.__getattribute__(s)iftype(x)==type(self.__init__):returnlogging_decorator(x)else:returnxreturnNewCls@log_all_class_methodsclassSomeMethods:deffunc1(self):print('func1')deffunc2(self):print('func2')methods=SomeMethods()方法.func1()>Beforefunc1>func1>Afterfunc1现在,不要惊慌。这看起来很复杂,但逻辑是一样的:首先,我们保持logging_decorator不变。它将应用于该类的所有方法。然后我们定义一个新的装饰器:log_all_class_methods。它类似于普通的装饰器,但返回一个类。NewCls有一个自定义的__getattribute__。对于对原始类的所有调用,它将使用logging_decorator装饰函数。内置装饰器不仅可以定义自己的装饰器,标准库中也提供了一些。我将列出我使用最多的三个:@property-一个内置装饰器,允许您为类属性定义getter和setter。@lru_cache-functools模块的装饰器。它会记住函数参数和返回值,这对于诸如阶乘之类的纯函数来说非常方便。@abstractmethod-abc模块的装饰器。表示该方法是抽象的,缺少实现细节。