一份来自 StackOverflow 的最佳 Python 装饰器教程

注意: 这是一篇 StackOverflow 上的问题回答,因为这个回答很棒,所以我把它存档了


问: 怎样在 Python 中连续使用多个函数装饰器?


如果你不想看详细的解释,你可以看 Paolo Bergantino 的回答

装饰器基础

Python 的装饰器都是对象

为了理解装饰器,你首先必须知道 Python 中的函数都是 object 对象。 这非常重要。让我们通过一个例子来看看原因。

记住上面的内容,一会我们还会用得到。

Python 函数另一个有趣的性质在于它们可以。。。在另一个函数内部定义!

函数引用

现在是比较有趣的部分。。。

你已经知道了函数是 object 对象。此外,函数还:

  • 可以像变量一样赋值
  • 可以在另一个函数内部定义

这表示 函数可以 return 另一个函数。看下面吧!☺

但等等…还有一些内容!

如果你可以 return 一个函数,那么你也可以把函数当作参数传递:

好,你已经掌握了装饰器所需的全部知识。正如你所见,装饰器是“包装器”,也就是说 它们允许你在它们装饰的函数的前面和后面运行其他代码 ,而不必修改函数本身。

动手制作装饰器

你应该怎样动手制作:

现在,你希望每次你调用 a_stand_alone_function 的时候,实际上 a_stand_alone_function_decorated 会被调用。也就是说,这只是用 my_shiny_new_decorator 返回的函数重写了 a_stand_alone_function 函数:

装饰器解密

和前面相同的例子,但是使用了装饰器语法:

就是这样,装饰器就是这么简单。 @decorator 只是下面形式的简写:

装饰器只是一个 pythonic 的装饰器设计模式的变种。Python 中内置了许多种传统的设计模式来简化开发过程(例如迭代器)。

当然,你可以叠加多个装饰器:

使用 Python 的装饰器语法:

你设置装饰器的顺序很重要:


现在:是时候回答问题了。。。

现在你很容易就知道怎样回答这个问题了:

现在你该放下轻松的心态,好好看看装饰器的高级使用方法了。


把装饰器传到下一层去

把参数传递给被装饰的函数

装饰器方法

关于 Python 的一个优点就是方法和函数本质本质上是一样的。二者唯一的区别就是方法的第一个参数是对当前对象的引用 (self)。

这意味着你可以按照同样的方式为方法创建装饰器!只要记得考虑 self 就可以了:

如果你在创建通用的装饰器 — 一个适用于任何函数或者方法的装饰器,无论参数是什么 — 那么只要使用 *args, **kwargs就可以了:

把参数传递给装饰器

太棒了,现在你对于把参数传递给装饰器本身有什么看法呢?

这可能有点奇怪,因为装饰器必须接收一个函数作为参数。因此,你可能无法直接把装饰器函数作为参数传递给另一个装饰器。

在得到答案之前,让我们写一个小的例子:

结果是一模一样的:my_decorator 被调用了。因此当你使用 @my_decorator 时,Python 会调用 my_decorator” 变量所代表的函数

这很重要!你提供的这个变量可以指向装饰器,也可以不指向

让我们增加点难度。 ☺

没什么意料之外的事情发生。

我们再做一次上面的事情,只不过这一次取消掉所有的中间变量:

让它更短一下

你注意到了吗?我们调用了一个 @ 语法的函数! :-)

所以,回到装饰器的参数上面来。如果我们可以使用函数生成一个临时的装饰器,我们也可以把参数传递给那个函数,对吗?

最后得到的就是:带参数的装饰器。参数可以设置为变量:

如你所见,你可以使用这个技巧向装饰器传递参数,就像是向普通函数传递一样。如果你愿意的话,你甚至可以使用 *args, **kwargs。但记住,装饰器只会被调用一次。只在 Python 导入脚本的时候运行。在这之后你就无法动态设置参数了。当你执行 import x 之后,函数已经被装饰了,因此之后你无法改变任何东西。


练习: 装饰一个装饰器

好的,作为奖励,我会提供你一段代码允许装饰器接收任何参数。毕竟,为了接收参数,我们会用另一个函数创建装饰器。

我们包装一下装饰器。

我们最近看到的有包装函数的还有什么呢?

对了,就是装饰器!

让我们做点有趣的事,写一个装饰器的装饰器:

可以像下面这样使用:

我知道,上次你有这种感觉,是在听一个人说:“在理解递归之前,你必须首先理解递归” 时。但现在,掌握了这个之后你不觉得很棒吗?


最佳实践: 装饰器

  • 装饰器在 Python 2.4 引进,因此确保你的代码运行的 Python 版本 >=2.4
  • 装饰器会拖慢函数调用速度。请牢记
  • 你无法解除装饰一个函数。 (确实 一些技巧可以创建允许解除装饰的装饰器,但是没人会使用它们。)因此一旦函数被装饰了,所有这个函数的代码就都装饰了。
  • 装饰器包装函数,会使得函数更难调试。 (从 Python >=2.5 有所好转;看下文。)

functools 模块在 Python 2.5 引进。模块中包含了函数 functools.wraps() ,这个函数会把被装饰函数的名字,模块名,docstring 都复制到它的包装器中。

(有趣的事情是: functools.wraps() 是个装饰器!☺)


怎样使装饰器变得有用?

现在最大的问题是: 我可以用装饰器来干嘛?

装饰器看起来很酷,很强大,但有一个实用的例子就更好了。大概有 1000 种可能的例子。常见的使用方法是扩展一个外部库函数(你无法修改)的行为,或者用来调试外部库函数(你不想修改它,因为它是临时函数)。

你可以使用装饰器以 DRY(Don’t Repeat Yourself,不重复自己) 的方式扩展函数,就像这样:

当然,装饰器的优点就在于你可以在不重写函数的前提下,使用在几乎任何函数上。DRY(Don’t Repeat Yourself,不要重复你自己),正如我说的:

Python 本身提供了几种装饰器: propertystaticmethod,等

  • Django 使用装饰器来管理缓存,查看权限。
  • Twisted 用它来伪造内联异步函数调用。

装饰器的用途确实很广。

1 3 收藏 2 评论

关于作者:可乐

本科在读,对python,linux,安全很感兴趣,希望能够阅读国外最新的技术新闻,也希望能够翻译一些文章帮助到别人 个人主页 · 我的文章 · 14 ·    

相关文章

可能感兴趣的话题



直接登录
跳到底部
返回顶部