Python装饰器基础详解-Python教學-PHP中文網

首頁

後端開發

Python教學

Python装饰器基础详解

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Jun 10, 2016 pm 03:05 PM

装饰器(decorator)是一种高级Python语法。装饰器可以对一个函数、方法或者类进行加工。在Python中，我们有多种方法对函数和类进行加工，比如在Python闭包中，我们见到函数对象作为某一个函数的返回结果。相对于其它方式，装饰器语法简单，代码可读性高。因此，装饰器在Python项目中有广泛的应用。

前面快速介绍了装饰器的语法，在这里，我们将深入装饰器内部工作机制，更详细更系统地介绍装饰器的内容，并学习自己编写新的装饰器的更多高级语法。

什么是装饰器

装饰是为函数和类指定管理代码的一种方式。Python装饰器以两种形式呈现：

【1】函数装饰器在函数定义的时候进行名称重绑定，提供一个逻辑层来管理函数和方法或随后对它们的调用。

【2】类装饰器在类定义的时候进行名称重绑定，提供一个逻辑层来管理类，或管理随后调用它们所创建的实例。

简而言之，装饰器提供了一种方法，在函数和类定义语句的末尾插入自动运行的代码——对于函数装饰器，在def的末尾；对于类装饰器，在class的末尾。这样的代码可以扮演不同的角色。
装饰器提供了一些和代码维护性和审美相关的有点。此外，作为结构化工具，装饰器自然地促进了代码封装，这减少了冗余性并使得未来变得更容易。

函数装饰器

通过在一个函数的def语句的末尾运行另一个函数，把最初的函数名重新绑定到结果。

用法

装饰器在紧挨着定义一个函数或方法的def语句之前的一行编写，并且它由@符号以及紧随其后的对于元函数的一个引用组成——这是管理另一个函数的一个函数（或其他可调用对象）。
在编码上，函数装饰器自动将如下语法：

@decorator 
def F(arg): 
... 
F(99)

登入後複製

映射为这个对等形式：

def F(arg): 
... 
F = decorator(F) 
F(99)

登入後複製

这里的装饰器是一个单参数的可调用对象，它返回与F具有相同数目的参数的一个可调用对象。
当随后调用F函数的时候，它自动调用装饰器所返回的对象。

换句话说，装饰实际把如下的第一行映射为第二行（尽管装饰器只在装饰的时候运行一次）

fun(6,7) 
decorator(func)(6,7)

登入後複製

这一自动名称重绑定也解释了之前介绍的静态方法和property装饰器语法的原因：

class C: 
@staticmethod 
def meth(...):... 
@property 
def name(self):...

登入後複製

实现

装饰器自身是返回可调用对象的可调用对象。实际上，它可以是任意类型的可调用对象，并且返回任意类型的可调用对象：函数和类的任何组合都可以使用，尽管一些组合更适合于特定的背景。

有一种常用的编码模式——装饰器返回了一个包装器，包装器把最初的函数保持到一个封闭的作用域中：

def decorator(F): 
def wrapper(*args): 
# 使用 F 和 *args 
# 调用原来的F(*args) 
return wrapper 
@decorator 
def func(x,y): 
... 
func(6,7)

登入後複製

当随后调用名称func的时候，它确实调用装饰器所返回的包装器函数；随后包装器函数可能运行最初的func，因为它在一个封闭的作用域中仍然可以使用。

为了对类做同样的事情，我们可以重载调用操作：

class decorator: 
def __init__(self,func): 
self.func = func 
def __call__(self,*args): 
# 使用self.func和args 
# self.func(*args)调用最初的func 
@decorator 
def func(x,y): 
... 
func(6,7)

登入後複製

但是，要注意的是，基于类的代码中，它对于拦截简单函数有效，但当它应用于类方法函数时，并不很有效：
如下反例:

class decorator: 
def __init__(self,func): 
self.func = func 
def __call__(self,*args): 
# 调用self.func(*args)失败，因为C实例参数无法传递 
class C: 
@decorator 
def method(self,x,y): 
...

登入後複製

这时候装饰的方法重绑定到一个类的方法上，而不是一个简单的函数，这一点带来的问题是，当装饰器的方法__call__随后运行的时候，其中的self接受装饰器类实例，并且类C的实例不会包含到一个*args中。

这时候，嵌套函数的替代方法工作得更好：

def decorator: 
def warpper(*args): 
# ... 
return wrapper 
@decorator 
def func(x,y): 
... 
func(6,7) 
class C: 
@decorator 
def method(self,x,y): 
... 
x = C() 
x.method(6,7)

登入後複製

类装饰器

类装饰器与函数装饰器使用相同的语法和非常相似的编码方式。类装饰器是管理类的一种方式，或者用管理或扩展类所创建的实例的额外逻辑，来包装实例构建调用。

用法

假设类装饰器返回一个可调用对象的一个单参数的函数，类装饰器的语法为：

@decorator 
class C: 
... 
x = C(99)

登入後複製

等同于下面的语法：

class C: 
... 
C = decorator(C) 
x = C(99)

登入後複製

直接效果是随后调用类名会创建一个实例，该实例会触发装饰器所返回的可调用对象，而不是调用最初的类自身。

实现

类装饰器返回的可调用对象，通常创建并返回最初的类的一个新的实例，以某种方式来扩展对其接口的管理。例如，下面的实例插入一个对象来拦截一个类实例的未定义的属性：

def decorator(cls): 
class Wrapper: 
def __init__(self,*args): 
self.wrapped = cls(*args) 
def __getattr__(self,name): 
return getattr(self.wrapped,name) 
return Wrapper 
@decorator 
class C: # C = decorator(C) 
def __init__(self,x,y): # Run by Wrapper.__init__ 
self.attr = 'spam' 
x = C(6,7) # 等价于Wrapper(6,7) 
print(x.attr)

登入後複製

在这个例子中，装饰器把类的名称重新绑定到另一个类，这个类在一个封闭的作用域中保持了最初的类。

就像函数装饰器一样，类装饰器通常可以编写为一个创建并返回可调用对象的“工厂”函数。

装饰器嵌套

有时候，一个装饰器不够，装饰器语法允许我们向一个装饰器的函数或方法添加包装器逻辑的多个层。这种形式的装饰器的语法为：

@A 
@B 
@C 
def f(...): 
...

登入後複製

如下这样转换：

def f(...): 
... 
f = A(B(C(f)))

登入後複製

这里，最初的函数通过3个不同的装饰器传递，每个装饰器处理前一个结果。

装饰器参数

函数装饰器和类装饰器都能接受参数，如下：

@decorator(A,B) 
def F(arg): 
... 
F(99)

登入後複製

自动映射到其对等形式：

def F(arg): 
... 
F = decorator(A,B)(F) 
F(99)

登入後複製

装饰器参数在装饰之前就解析了，并且它们通常用来保持状态信息供随后的调用使用。例如，这个例子中的装饰器函数，可能采用如下形式：

def decorator(A,B): 
# 保存或使用A和B 
def actualDecorator(F): 
# 保存或使用函数 F 
# 返回一个可调用对象 
return callable 
return actualDecorator

登入後複製

以上，这是装饰器的基础知识，接下来将学习编写自己的装饰器。

本網站聲明

本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn

熱AI工具

熱工具

熱門話題

Java教學

1665

CakePHP 教程

1424

Laravel 教程

1322

PHP教程

1270

C# 教程

1249

Related knowledge

Python vs.C：申請和用例 Apr 12, 2025 am 12:01 AM

Python适合数据科学、Web开发和自动化任务，而C 适用于系统编程、游戏开发和嵌入式系统。Python以简洁和强大的生态系统著称，C 则以高性能和底层控制能力闻名。

Python：遊戲，Guis等 Apr 13, 2025 am 12:14 AM

Python在遊戲和GUI開發中表現出色。 1)遊戲開發使用Pygame，提供繪圖、音頻等功能，適合創建2D遊戲。 2)GUI開發可選擇Tkinter或PyQt，Tkinter簡單易用，PyQt功能豐富，適合專業開發。

Python與C：學習曲線和易用性 Apr 19, 2025 am 12:20 AM

Python更易學且易用，C 則更強大但複雜。 1.Python語法簡潔，適合初學者，動態類型和自動內存管理使其易用，但可能導致運行時錯誤。 2.C 提供低級控制和高級特性，適合高性能應用，但學習門檻高，需手動管理內存和類型安全。

Python和時間：充分利用您的學習時間 Apr 14, 2025 am 12:02 AM

要在有限的時間內最大化學習Python的效率，可以使用Python的datetime、time和schedule模塊。 1.datetime模塊用於記錄和規劃學習時間。 2.time模塊幫助設置學習和休息時間。 3.schedule模塊自動化安排每週學習任務。

Python vs.C：探索性能和效率 Apr 18, 2025 am 12:20 AM

Python在開發效率上優於C ，但C 在執行性能上更高。 1.Python的簡潔語法和豐富庫提高開發效率。 2.C 的編譯型特性和硬件控制提升執行性能。選擇時需根據項目需求權衡開發速度與執行效率。

Python：自動化，腳本和任務管理 Apr 16, 2025 am 12:14 AM

Python在自動化、腳本編寫和任務管理中表現出色。 1)自動化：通過標準庫如os、shutil實現文件備份。 2)腳本編寫：使用psutil庫監控系統資源。 3)任務管理：利用schedule庫調度任務。 Python的易用性和豐富庫支持使其在這些領域中成為首選工具。

Python標準庫的哪一部分是：列表或數組？ Apr 27, 2025 am 12:03 AM

pythonlistsarepartofthestAndArdLibrary，herilearRaysarenot.listsarebuilt-In，多功能，和Rused ForStoringCollections，而EasaraySaraySaraySaraysaraySaraySaraysaraySaraysarrayModuleandleandleandlesscommonlyusedDduetolimitedFunctionalityFunctionalityFunctionality。