Python - 装饰器

上一页
下一页

在 Python 中，装饰器是一个函数，它接收另一个函数作为参数。被装饰的函数就是作为参数传入的函数。装饰器可以扩展参数函数的行为，而无需实际修改它。

在本章中，我们将学习如何使用 Python 装饰器。

定义函数装饰器

Python 中的函数是一等公民。这意味着它可以像其他数据类型（如数字、字符串或列表等）一样作为参数传递给另一个函数。也可以在一个函数内部定义另一个函数。这样的函数称为嵌套函数。此外，函数也可以返回其他函数。

装饰器函数的典型定义如下：

def decorator(arg_function): #arg_function to be decorated
   def nested_function():
      #this wraps the arg_function and extends its behaviour
      #call arg_function
      arg_function()
   return nested_function

这是一个普通的 Python 函数：

def function():
   print ("hello")

现在可以通过将其传递给装饰器来装饰此函数以扩展其行为：

function=decorator(function)

如果现在执行此函数，则将显示由装饰器扩展的输出。

Python 装饰器的示例

练习以下示例以理解 Python 装饰器的概念：

示例 1

以下代码是装饰器的简单示例：

def my_function(x):
   print("The number is=",x)

def my_decorator(some_function,num):
   def wrapper(num):
      print("Inside wrapper to check odd/even")
      if num%2 == 0:
         ret= "Even"
      else:
         ret= "Odd!"
      some_function(num)
      return ret
   print ("wrapper function is called")
   return wrapper

no=10
my_function = my_decorator(my_function, no)
print ("It is ",my_function(no))

my_function() 只打印接收到的数字。但是，通过将其传递给 my_decorator，它的行为被修改了。内部函数接收数字并返回它是奇数还是偶数。上述代码的输出为：

wrapper function is called
Inside wrapper to check odd/even
The number is= 10
It is Even

示例 2

装饰函数的一种优雅方式是在其定义之前加上 @ 符号和装饰器的名称。上面的例子使用这种表示法重写：

def my_decorator(some_function):
   def wrapper(num):
      print("Inside wrapper to check odd/even")
      if num%2 == 0:
         ret= "Even"
      else:
         ret= "Odd!"
      some_function(num)
      return ret
   print ("wrapper function is called")
   return wrapper

@my_decorator
def my_function(x):
   print("The number is=",x)
no=10
print ("It is ",my_function(no))

Python 的标准库定义了以下内置装饰器：

@classmethod 装饰器

classmethod 是一个内置函数。它将方法转换为类方法。类方法与实例方法不同。在类中定义的实例方法由其对象调用。该方法接收由 self 引用的隐式对象。另一方面，类方法隐式地接收类本身作为第一个参数。

语法

为了声明类方法，使用以下装饰器表示法：

class Myclass:
   @classmethod
   def mymethod(cls):
   #....

@classmethod 形式是前面描述的函数装饰器形式。mymethod 接收对类的引用。它可以由类及其对象调用。这意味着 Myclass.mymethod 和 Myclass().mymethod 都是有效的调用。

@classmethod 装饰器的示例

让我们通过以下示例来了解类方法的行为：

class counter:
   count=0
   def __init__(self):
      print ("init called by ", self)
      counter.count=counter.count+1
      print ("count=",counter.count)
   @classmethod
   def showcount(cls):
      print ("called by ",cls)
      print ("count=",cls.count)

c1=counter()
c2=counter()
print ("class method called by object")
c1.showcount()
print ("class method called by class")
counter.showcount()

在类定义中，count 是一个类属性。__init__() 方法是构造函数，显然是一个实例方法，因为它接收 self 作为对象引用。声明的每个对象都会调用此方法并将 count 加 1。

@classmethod 装饰器将 showcount() 方法转换为类方法，即使它由其对象调用，它也接收对类的引用作为参数。即使 c1 对象调用 showcount，它也会显示计数器类的引用。

它将显示以下输出：

init called by <__main__.counter object at 0x000001D32DB4F0F0>
count= 1
init called by <__main__.counter object at 0x000001D32DAC8710>
count= 2
class method called by object
called by <class '__main__.counter'>
count= 2
class method called by class
called by <class '__main__.counter'>

@staticmethod 装饰器

staticmethod也是Python标准库中的内置函数。它将一个方法转换为静态方法。无论静态方法是由类的实例还是类本身调用，它都不会接收任何引用参数。在类中声明静态方法使用以下表示法：

语法

class Myclass:
@staticmethod
def mymethod():
#....

尽管Myclass.mymethod和Myclass().mymethod都是有效的调用，但静态方法都不会接收任何引用。

@staticmethod装饰器的示例

计数器类被修改如下：

class counter:
   count=0
   def __init__(self):
      print ("init called by ", self)
      counter.count=counter.count+1
      print ("count=",counter.count)
   @staticmethod
   def showcount():
      print ("count=",counter.count)

c1=counter()
c2=counter()
print ("class method called by object")
c1.showcount()
print ("class method called by class")
counter.showcount()

和以前一样，类属性count在__init__()方法中每个对象的声明时都会递增。但是，由于mymethod()是一个静态方法，它既不接收self参数也不接收cls参数。因此，类属性count的值需要显式引用counter才能显示。

以上代码的输出如下：

init called by <__main__.counter object at 0x000002512EDCF0B8>
count= 1
init called by <__main__.counter object at 0x000002512ED48668>
count= 2
class method called by object
count= 2
class method called by class
count= 2

@property装饰器

Python的property()内置函数是访问类实例变量的接口。@property装饰器将实例方法转换为具有相同名称的只读属性的“getter”，并将属性的文档字符串设置为“获取实例变量的当前值”。

可以使用以下三个装饰器来定义属性：

  • @property − 将方法声明为属性。

  • @.setter: − 指定为属性设置值的setter方法。

  • @.deleter − 指定作为删除属性的删除方法。

property()函数返回的属性对象具有getter、setter和deleter方法。

property(fget=None, fset=None, fdel=None, doc=None)

fget参数是getter方法，fset是setter方法。它可以选择具有fdel作为删除对象的方法，doc是文档字符串。

语法

property()对象的setter和getter也可以使用以下语法赋值：

speed = property()
speed=speed.getter(speed, get_speed)
speed=speed.setter(speed, set_speed)

其中get_speed()和set_speeds()是检索和设置Car类中实例变量speed值的实例方法。

以上语句可以用@property装饰器实现。使用该装饰器，car类被改写为：

@property装饰器的示例

class car:
   def __init__(self, speed=40):
      self._speed=speed
      return
   @property
   def speed(self):
      return self._speed
   @speed.setter
   def speed(self, speed):
      if speed<0 or speed>100:
         print ("speed limit 0 to 100")
         return
      self._speed=speed
      return

c1=car()
print (c1.speed) #calls getter
c1.speed=60 #calls setter

属性装饰器是一种非常方便且推荐的处理实例属性的方法。

打印页面
上一页
下一页
广告