一文读懂 Python 装饰器

三酷猫 • • Python

装饰器：本质上也是一种函数，它可以让其它函数在不经过修改的情况下增加一些功能。

像我们常见的@classmethod、@static装饰器。被装饰器修饰的函数，都增加了他们相应的能力

装饰器的基本使用形式：

@dec
def func():
  pass

理解装饰器的最好方式是了解装饰器解决什么问题，本文将从具体问题出发一步步引出装饰器，并展示它的优雅与强大。

设置问题

为了解装饰器的目的，接下来我们来看一个简单的示例。假如你有一个简单的加法函数 dec.py，第二个参数的默认值为 10：

# dec.py

def add(x, y=10):
  return x + y

我们来更认真地看一下这个加法函数：

>>> add(10, 20)
30
>>> add
<function add at 0x7fce0da2fe18>
>>> add.__name__
'add'
>>> add.__module__
'__main__'
>>> add.__defaults__ # default value of the `add` function
(10,)
>>> add.__code__.co_varnames # the variable names of the `add` function
('x', 'y')

我们无需理解这些都是什么，只需要记住 Python 中的每个函数都是对象，它们有各种属性和方法。你还可以通过 inspect 模块查看 add() 函数的源代码：

>>> from inspect import getsource
>>> print(getsource(add))

def add(x, y=10):
  return x + y

现在你以某种方式使用该加法函数，比如你使用一些操作来测试该函数：

# dec.py
from time import time

def add(x, y=10):
  return x + y

print('add(10)',         add(10))
print('add(20, 30)',     add(20, 30))
print('add("a", "b")',   add("a", "b"))
Output: i

add(10) 20
add(20, 30) 50
add("a", "b") ab

假如你想了解每个操作的时间，可以调用 time 模块：

# dec.py
from time import time

def add(x, y=10):
  return x + y

before = time()
print('add(10)', add(10))
after = time()
print('time taken: ', after - before)
before = time()
print('add(20, 30)', add(20, 30))
after = time()
print('time taken: ', after - before)
before = time()
print('add("a", "b")', add("a", "b"))
after = time()
print('time taken: ', after - before)
Output:

add(10) 20
time taken:  6.699562072753906e-05
add(20, 30) 50
time taken:  6.9141387939453125e-06
add("a", "b") ab
time taken:  6.9141387939453125e-06

现在，你作为一个编程人员是不是有些手痒，毕竟我们不喜欢总是复制粘贴相同的代码。现在的代码可读性不强，如果你想改变什么，你就得修改所有出现的地方，Python 肯定有更好的方式。

我们可以按照如下做法，直接在 add 函数中捕捉运行时间：

# dec.py
from time import time

def add(x, y=10):
  before = time()
  rv = x + y
  after = time()
  print('time taken: ', after - before)
  return rv

print('add(10)',         add(10))
print('add(20, 30)',     add(20, 30))
print('add("a", "b")',   add("a", "b"))

这种方法肯定比前一种要好。但是如果你还有另一个函数，那么这似乎就不方便了。当我们有多个函数时：

# dec.py
from time import time

def add(x, y=10):
  before = time()
  rv = x + y
  after = time()
  print('time taken: ', after - before)
  return rv

def sub(x, y=10):
  return x - y

print('add(10)', add(10))
print('add(20, 30)', add(20, 30))
print('add("a", "b")', add("a", "b"))
print('sub(10)', sub(10))
print('sub(20, 30)', sub(20, 30))

因为 add 和 sub 都是函数，我们可以利用这一点写一个 timer 函数。我们希望 timer 能计算一个函数的运算时间：

def timer(func, x, y=10):
  before = time()
  rv = func(x, y)
  after = time()
  print('time taken: ', after - before)
  return rv

这很不错，不过我们必须使用 timer 函数包装不同的函数，如下所示：

print('add(10)', timer(add,10)))

现在默认值还是 10 吗？未必。那么如何做得更好呢？

这里有一个主意：创建一个新的 timer 函数，并包装其他函数，然后返回包装后的函数：

def timer(func):
  def f(x, y=10):
    before = time()
    rv = func(x, y)
    after = time()
    print('time taken: ', after - before)
    return rv
  return f

现在，你只需用 timer 包装一下 add 和 sub 函数 ：

add = timer(add)

这样就可以了！以下是完整代码：

# dec.py
from time import time
def timer(func):
  def f(x, y=10):
    before = time()
    rv = func(x, y)
    after = time()
    print('time taken: ', after - before)
    return rv
  return f

def add(x, y=10):
  return x + y
add = timer(add)


def sub(x, y=10):
  return x - y
sub = timer(sub)

print('add(10)',         add(10))
print('add(20, 30)',     add(20, 30))
print('add("a", "b")',   add("a", "b"))
print('sub(10)',         sub(10))
print('sub(20, 30)',     sub(20, 30))
Output:

time taken:  0.0
add(10) 20
time taken:  9.5367431640625e-07
add(20, 30) 50
time taken:  0.0
add("a", "b") ab
time taken:  9.5367431640625e-07
sub(10) 0
time taken:  9.5367431640625e-07
sub(20, 30) -10

我们来总结一下这个过程：我们有一个函数（比如 add 函数），然后用一个动作（比如计时）包装该函数。包装的结果是一个新函数，能实现某些新功能。

当然了，默认值还有点问题，稍后我们会解决它。

装饰器

现在，上面的解决方案以及非常接近装饰器的思想了，使用常见行为包装某个具体的函数，这种模式就是装饰器在做的事。使用装饰器后的代码是：

def add(x, y=10):
  return x + y
add = timer(add)
You write:

@timer
def add(x, y=10):
  return x + y

它们的作用是一样的，这就是 Python 装饰器的作用。它实现的作用类似于 add = timer(add)，只不过装饰器把句法放在函数上面，且句法更加简单：@timer。

# dec.py
from time import time
def timer(func):
  def f(x, y=10):
    before = time()
    rv = func(x, y)
    after = time()
    print('time taken: ', after - before)
    return rv
  return f

@timer
def add(x, y=10):
  return x + y

@timer
def sub(x, y=10):
  return x - y

print('add(10)',         add(10))
print('add(20, 30)',     add(20, 30))
print('add("a", "b")',   add("a", "b"))
print('sub(10)',         sub(10))
print('sub(20, 30)',     sub(20, 30))

参数和关键字参数

现在，还有一个小问题没有解决。在 timer 函数中，我们将参数 x 和 y 写死了，即指定 y 的默认值为 10。有一种方法可以传输该函数的参数和关键字参数，即 *args 和 **kwargs。参数是函数的标准参数（在本例中 x 为参数），关键字参数是已具备默认值的参数（本例中是 y=10）。代码如下：

# dec.py
from time import time
def timer(func):
  def f(*args, **kwargs):
    before = time()
    rv = func(*args, **kwargs)
    after = time()
    print('time taken: ', after - before)
    return rv
  return f

@timer
def add(x, y=10):
  return x + y

@timer
def sub(x, y=10):
  return x - y

print('add(10)',         add(10))
print('add(20, 30)',     add(20, 30))
print('add("a", "b")',   add("a", "b"))
print('sub(10)',         sub(10))
print('sub(20, 30)',     sub(20, 30))

现在，该 timer 函数可以处理任意函数、任意参数和任意默认值设置了，因为它仅仅将这些参数传输到函数中。

高阶装饰器

你们可能会疑惑：如果我们可以用一个函数包装另一个函数来添加有用的行为，那么我们可以再进一步吗？我们用一个函数包装另一个函数，再被另一个函数包装吗？

可以！事实上，函数的深度可以随你的意。例如，你想写一个装饰器来执行某个函数 n 次。如下所示：

def ntimes(n):
  def inner(f):
    def wrapper(*args, **kwargs):
      for _ in range(n):
        rv = f(*args, **kwargs)
      return rv
    return wrapper
  return inner

然后你可以使用上述函数包装另一个函数，例如前文中的 add 函数：

@ntimes(3)
def add(x, y):
  print(x + y)
  return x + y

输出的语句表明该代码确实执行了 3 次。

原创文章，作者：三酷猫，如若转载，请注明出处：https://www.sankumao.com/3383.html

赞 (0)
三酷猫三酷猫
0
上一篇 2022年9月23日 下午2:50
下一篇 2022年9月25日 下午2:53

相关推荐

  • selenium-python-Helium库介绍，更轻量的自动化测试框架！ Python

    selenium-python-Helium库介绍，更轻量的自动化测试框架！

    对于Python的自动化测试或者是爬虫开发者来说，对于selenium库想必都听说过，selenium本身是作为Web应用测试工具，但是作为爬虫工具也有很广泛的用途。Seleniu…

    2022年11月12日
  • 基于scrapy的redis安装和配置方法 Python

    基于scrapy的redis安装和配置方法

    在定向爬虫的制作过程中，使用分布式爬取技术可以显著提高爬取效率。而 Redis 配合 Scrapy 是实现分布式爬取的基础。 Redis 是一个高性能的 Key-Value 数据库…

    2022年11月13日
  • 4a83fd6dd70a3407a7033e4b7f21c867 Python

    python 类属性、类方法、及静态方法等

    类方法、类属性 类方法需要用 装饰器 @classmethod 来标识• 类方法的 第一个参数 应该是 cls• 由 哪一个类 调用的方法，方法内的 cls 就是 哪一个类的引 用…

    2022年7月13日
  • 两种办法，快速一键生成Python爬虫请求头！ Python

    两种办法，快速一键生成Python爬虫请求头！

    我们在写爬虫，构建网络请求的时候，不可避免地要添加请求头( headers )，这里介绍工具一键生成请求头，省去编写请求头信息的麻烦！ 方法一：网站在线转换 工具网址：https:…

    2022年11月3日
  • Python虚拟环境之Virtualenv详解 Python

    Python虚拟环境之Virtualenv详解

    一、virtualenv简介 virtualenv用来创建独立的Python虚拟环境，可以将每个项目与其他项目独立开来，互不影响，解决了依赖包版本冲突的问题。 二、安装virtua…

    2022年10月27日
  • 2022092002501152 Python

    python配置pip镜像源 及 国内常用镜像源

    安装后用的是国外镜像源，推荐换成国内镜像源，pip安装包功能会快很多 一、下载时临时指定镜像源 二、持久化配置镜像源 ① Linux下:    &nb…

    2022年9月20日
  • python导包时，使用.来导包 Python

    python导包时，使用.来导包

    今天在学习scrapy，看别人代码时，发现这种写法..导包的方式 。 场景一、使用..来导上一级目录下的包： 场景二、使用.来导同一级目录下的包： 像我之前就是使用from fan…

    2022年11月13日
  • Python爬虫教程八：Scrapy框架（下） Python

    Python爬虫教程八：Scrapy框架（下）

    一、数据清洗方式 spider代码 Scrapy自动发送请求，返回response response.body 将输出response的包体  response.head…

    2022年10月15日
  • python中继承详解super().__init__() Python

    python中继承详解super().__init__()

    super().__init__()，就是继承父类的init方法，同样可以使用super()点 其他方法名，去继承其他方法。 我们这里通过实例来了解如何在子类中使用父类方法的方式。…

    2022年10月24日
  • Python爬虫教程七：Scrapy框架（上） Python

    Python爬虫教程七：Scrapy框架（上）

    一、Scrapy框架简介 Scrapy是用Python实现一个为了爬取网站数据、提取结构性数据而编写的应用框架，用途非常广泛。 框架的优势在于，用户只需要定制开发几个模块就可以轻松…

    2022年10月14日