草庐IT

Python 装饰器原理

zikcheng 2023-03-28 原文

装饰器是 Python 编程中常用的一个功能,可以将通用的逻辑抽象成装饰器,通过装饰器语法应用到不同的目标上,达到增强或修改目标逻辑的目的。

先来看一个简单的例子

# 打印耗时的装饰器
def log(f):
    def inner(*args, **kw):
        start = time.perf_counter()
        result = f(*args, **kw)
        cost = time.perf_counter() - start
        print(f"cost {cost:.1} seconds")
        return result
    return inner

# 通过 @ 语法将装饰器应用到目标对象上
@log
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 输出如下
# cost 0.1 seconds

被装饰的目标是 download 函数,用于下载文件,通过 @ 语法被打印耗时的装饰器 log 修饰,download 在被调用的时候就会打印下载文件的耗时。那么打印耗时的逻辑是怎么嵌入到 download 函数中的呢,这里的关键就是需要知道 Python 解释器是怎么处理 @ 语法的。不妨用 Python 提供的 dis 模块反汇编一下 download 的定义

@log
def download(url):
    requests.get(url)

反汇编之后得到的字节码如下(不同 Python 版本反汇编的结果略有差异)

2           0 LOAD_NAME                0 (log)

3           2 LOAD_CONST               0 (<code object download at 0x7f7872e363a0, file "<dis>", line 2>)
            4 LOAD_CONST               1 ('download')
            6 MAKE_FUNCTION            0
            8 CALL_FUNCTION            1
           10 STORE_NAME               1 (download)
           12 LOAD_CONST               2 (None)
           14 RETURN_VALUE

# download 函数本来的函数体
Disassembly of <code object download at 0x7f7872e363a0, file "<dis>", line 2>:
4           0 LOAD_GLOBAL              0 (requests)
            2 LOAD_METHOD              1 (get)
            4 LOAD_FAST                0 (url)
            6 CALL_METHOD              1
            8 POP_TOP
           10 LOAD_CONST               0 (None)
           12 RETURN_VALUE

可以看到,一开始 MAKE_FUNCTION 指令通过编译好的 download 函数体对应的 code 对象构造出一个新的函数对象存在 download 变量中,然后通过 CALL_FUNCTION 指令调用 log 函数(参数是 download 变量),最后再通过 STORE_NAME 指令将 log 函数的返回结果存到 download 变量中。所以从语义上说,logdownload 进行装饰的效果等价于下面的伪代码

download = make_function(code) # 构造最初的 download 函数对象
download = log(download) # 调用 log 函数将返回值赋给 download 变量

log 函数的返回是 inner 函数,也就是说 download 在被修饰之后指向的是 inner 函数,而 inner 函数中的 f 变量又指向了 download 在被修饰之前所指向的函数对象,所以最后在调用 download 的时候除了有原来的下载功能之外,还打印了耗时。

装饰前后 download 变量的变化如下图所示

在上面的例子中我们称 log 为装饰器,因为 log@ 同一行且是 @ 后面的内容,这是 Python 语法规定的。log 是一个函数,且定义了一个参数。但是装饰器本身不一定非得是函数,只要是值为可以通过传递一个位置参数进行调用的可调用对象的表达式即可。也就是说

  • 装饰器就是一个表达式
  • 表达式的值是一个可调用对象
  • 这个可调用对象可以通过位置传参的方式传递一个参数进行调用

简单来说,装饰器的本质是可以通过形如 A(f) 的方式进行调用的可调用对象(A@ 后面整个表达式的值)

可调用对象可以认为是像函数一样可以在后面加括号和参数进行调用的对象,函数本身就是一种可调用对象,还有类对象以及定义了 __call__ 函数的类实例对象等都是可调用对象。

下面的函数 wrapper 就是一个满足条件的装饰器,hello 开始是个空函数,被 wrapper 装饰之后就变成了字符串 "zikcheng"。当然这个装饰器没什么用,只是为了说明定义一个满足语法的装饰器很简单,不一定非要定义内部函数。

def wrapper(a=1, b="hello"):
    return "zikcheng"

@wrapper
def hello():
    pass

print(hello, type(hello))
# 输出
# zikcheng <class 'str'>

再回到 logdownload 的例子,如果我们想在打印耗时的同时打印负载类型(比如这里是 IO,对于计算密集型的负载类型是 CPU),可以做如下修改

def log_outer(load_type):
    def log(f):
        def inner(*args, **kw):
            start = time.perf_counter()
            result = f(*args, **kw)
            cost = time.perf_counter() - start
            print(f"{load_type} cost {cost:.1} seconds")
            return result
        return inner
    return log

@log_outer("IO")
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 输出如下
# IO cost 0.1 seconds

这个例子中的装饰器表达式为 log_outer("IO"),因为 @ 符号后面的内容是 log_outer("IO") 整体,而不是 log_outerlog_outer("IO") 的返回值为 log 函数,因此修饰 download 的装饰器还是 log 函数,只不过这次 log 函数是一个闭包,引用了外部函数的 load_type 变量用于打印负载类型。本质上还是 download = log_outer("IO")(download)

如果要打印负载类型,除了上面这种方式,还可以通过定义一个类来实现

class LoadLog:
    def __init__(self, load_type):
        self.load_type = load_type

    def __call__(self, f):
        def inner(*args, **kw):
            start = time.perf_counter()
            result = f(*args, **kw)
            cost = time.perf_counter() - start
            print(f"{self.load_type} cost {cost:.1} seconds")
            return result
        return inner

@LoadLog("IO")
def download(url):
    requests.get(url)

download("https://www.baidu.com")
# 输出如下
# IO cost 0.1 seconds

同理,download = LoadLog("IO")(download),装饰器是 LoadLog("IO"),值为 LoadLog 类实例,是一个可调用对象,最终 download 指向 __call__ 的返回值也就是 inner 函数,效果跟之前一样。

只要我们明白装饰器的本质是值为可调用对象的表达式,那么无论怎么变形,是三层嵌套函数还是类就都很好理解了。

上面例子中被装饰的对象都是函数,实际上类也是可以被装饰的,这里就不展开了。

本文先通过一个简单的示例引入装饰器概念,然后分析其反汇编的字节码揭示了装饰器的本质,最后通过无嵌套函数、三层嵌套函数和类分别作为装饰器来加强对装饰器本质的理解,希望文章能对你有所帮助。

有关Python 装饰器原理的更多相关文章

  1. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  2. Python 相当于 Perl/Ruby ||= - 2

    这个问题在这里已经有了答案:关闭10年前。PossibleDuplicate:Pythonconditionalassignmentoperator对于这样一个简单的问题表示歉意,但是谷歌搜索||=并不是很有帮助;)Python中是否有与Ruby和Perl中的||=语句等效的语句?例如:foo="hey"foo||="what"#assignfooifit'sundefined#fooisstill"hey"bar||="yeah"#baris"yeah"另外,类似这样的东西的通用术语是什么?条件分配是我的第一个猜测,但Wikipediapage跟我想的不太一样。

  3. java - 什么相当于 ruby​​ 的 rack 或 python 的 Java wsgi? - 2

    什么是ruby​​的rack或python的Java的wsgi?还有一个路由库。 最佳答案 来自Python标准PEP333:Bycontrast,althoughJavahasjustasmanywebapplicationframeworksavailable,Java's"servlet"APImakesitpossibleforapplicationswrittenwithanyJavawebapplicationframeworktoruninanywebserverthatsupportstheservletAPI.ht

  4. 华为OD机试用Python实现 -【明明的随机数】 2023Q1A - 2

    华为OD机试题本篇题目:明明的随机数题目输入描述输出描述:示例1输入输出说明代码编写思路最近更新的博客华为od2023|什么是华为od,od薪资待遇,od机试题清单华为OD机试真题大全,用Python解华为机试题|机试宝典【华为OD机试】全流程解析+经验分享,题型分享,防作弊指南华为o

  5. python - 如何读取 MIDI 文件、更改其乐器并将其写回? - 2

    我想解析一个已经存在的.mid文件,改变它的乐器,例如从“acousticgrandpiano”到“violin”,然后将它保存回去或作为另一个.mid文件。根据我在文档中看到的内容,该乐器通过program_change或patch_change指令进行了更改,但我找不到任何在已经存在的MIDI文件中执行此操作的库.他们似乎都只支持从头开始创建的MIDI文件。 最佳答案 MIDIpackage会为您完成此操作,但具体方法取决于midi文件的原始内容。一个MIDI文件由一个或多个音轨组成,每个音轨是十六个channel中任何一个上的

  6. 「Python|Selenium|场景案例」如何定位iframe中的元素? - 2

    本文主要介绍在使用Selenium进行自动化测试或者任务时,对于使用了iframe的页面,如何定位iframe中的元素文章目录场景描述解决方案具体代码场景描述当我们在使用Selenium进行自动化测试的时候,可能会遇到一些界面或者窗体是使用HTML的iframe标签进行承载的。对于iframe中的标签,如果直接查找是无法找到的,会抛出没有找到元素的异常。比如近在咫尺的例子就是,CSDN的登录窗体就是使用的iframe,大家可以尝试通过F12开发者模式查看到的tag_name,class_name,id或者xpath来定位中的页面元素,会抛出NoSuchElementException异常。解决

  7. python ffmpeg 使用 pyav 转换 一组图像 到 视频 - 2

    2022/8/4更新支持加入水印水印必须包含透明图像,并且水印图像大小要等于原图像的大小pythonconvert_image_to_video.py-f30-mwatermark.pngim_dirout.mkv2022/6/21更新让命令行参数更加易用新的命令行使用方法pythonconvert_image_to_video.py-f30im_dirout.mkvFFMPEG命令行转换一组JPG图像到视频时,是将这组图像视为MJPG流。我需要转换一组PNG图像到视频,FFMPEG就不认了。pyav内置了ffmpeg库,不需要系统带有ffmpeg工具因此我使用ffmpeg的python包装p

  8. Python 刷Leetcode题库,顺带学英语单词(31) - 2

    ValidPalindromeGivenastring,determineifitisapalindrome,consideringonlyalphanumericcharactersandignoringcases. [#125]Example:"Aman,aplan,acanal:Panama"isapalindrome."raceacar"isnotapalindrome.Haveyouconsiderthatthestringmightbeempty?Thisisagoodquestiontoaskduringaninterview.Forthepurposeofthisproblem

  9. python - 是否可以使用 Ruby 或 Python 禁用 anchor /引用来发出有效的 YAML? - 2

    是否可以在PyYAML或Ruby的Psych引擎中禁用创建anchor和引用(并有效地显式列出冗余数据)?也许我在网上搜索时遗漏了一些东西,但在Psych中似乎没有太多可用的选项,而且我也无法确定PyYAML是否允许这样做.基本原理是我必须序列化一些数据并将其以可读的形式传递给一个不是真正的技术同事进行手动验证。有些数据是多余的,但我需要以最明确的方式列出它们以提高可读性(anchor和引用是提高效率的好概念,但不是人类可读性)。Ruby和Python是我选择的工具,但如果有其他一些相当简单的方法来“展开”YAML文档,它可能就可以了。 最佳答案

  10. .net - .NET 将如何影响 Python 和 Ruby 应用程序? - 2

    我很好奇.NET将如何影响Python和Ruby应用程序。用IronPython/IronRuby编写的应用程序是否会非常特定于.NET环境,以至于它们实际上将变得特定于平台?如果他们不使用任何.NET功能,那么IronPython/IronRuby相对于非.NET同类产品的优势是什么? 最佳答案 我不能说任何关于IronRuby的东西,但是大多数Python实现(如IronPython、Jython和PyPy)都试图尽可能忠实于CPython实现。不过,IronPython正在迅速成为这方面的佼佼者之一,并且在PlanetPyth

随机推荐