python语言中的装饰器详解

    装饰器是一个用于封装函数或类的代码的工具。它显式地将封装器应用到函数或类上，从而使它们选择加入到装饰器的功能中。对于在函数运行前处理常见前置条件(例如确认授权)，或在函数运行后确保清理(例如输出清除或异常处理)装饰器都非常有用。对于处理已经被装饰的函数或类本身，装饰器也很有用。例如，装饰器可以将函数注册到信号系统，或者注册到Web应用程序的URI注册表中。

    本文将概要介绍什么是装饰器，以及装饰器如何与 Python的函数和类交互。

1.1理解装饰器

    究其核心而言，装饰器就是一个可以接受调用也可以返回调用的调用。装饰器无非就是一个函数(或调用，如有_call_method_方法的对象)，该函数接受被装饰的函数作为其位置参数。装饰器通过使用该参数来执行某些操作，然后返回原始参数或一些其他的调用(大概以这种方式与装饰器交互)由于函数在 Python中是一级对象，因此它们能够像其他对象一样被传递到另一个函数。装饰器就是接受另一个函数作为参数，并用其完成一些操作的函数。实际上这很容易理解。考虑下面一个非常简单的装饰器。它仅仅为被装饰的调用点字符串附加了一个字符串。

 def decorated_by(func):

 

   func. __doc__ +="\ Decorated by decorated_by"

   return func

现在，考虑下面这个普通的函数:

def add(x, y ):

  "'Return the sum of x and y'"

  return x +y

 

函数的 docstring是在第一行指定的字符串。假如在 Python的 Shell中对该函数运行Help命令，就能看到该字符串。下面是将装饰器应用到add函数的示例

def add(x, y): 

   "'return the sum of x and y "'

   return x +y

add=decorated_by(add)

 

以下是执行help命令得到的结果

Help on function add in module__main__:

add(x, y)

  Return the sum of x and y.

  Decorated by decorated_by

(END)

 这里发生了什么?其实就是装饰器修改了add函数的__doc__属性，然后返回原来的函数对象。

1.2装饰器语法

    大多数时候开发人员使用装饰器来装饰函数，他们只对装饰过的最终函数感兴趣，而对于未装饰函数的引用最终就变得多余,正因为如此(也是为了更整洁)，所以定义函数，给它赋一个特定的名称，然后立刻将装饰过的函数赋给相同的名称就不可取.因此， Python为装饰器引入了特殊的语法。装饰器的应用是通过在装饰器的名称前放置一个@字符，并在被装饰函数声明之上添加一行(不包含隐式装饰器的方法签名)来实现的。

下面来看一下如何优先将 decorated_by装饰器应用到add方法:

@decorated_by

def add(x,y):

 "'Return the sum of x +y"'

   return x+y

     再次注意，这里没有给@ decorated_by提供方法签名。假设该装饰器有一个单独的位置参数,而这个参数是装饰过的方法(在某些情况下，会看到一个带有其他参数的方法签名)

该语法允许在声明函数的位置应用装饰器，从而代码更容易阅读并且可以立即意识到应用了装饰器。可读性很重要。

 

装饰器应用的顺序：

    何时应用装饰器?使用@语法时，在创建被装饰的可调用函数后，会立刻应用装饰器。因此以上两个示例中所展示的将 decorated_by应用到ad的方式几乎是一样的。首先创建add函数，然后立即使用 decorated_by将其封装起来。

    需要注意的重要一点是，对某个可调用函数，可以使用多个装饰器(就像可以多次封装函数调用一样)。

    但请注意，如果通过@语法使用多个装饰器，就需要按照自底向上的顺序来应用它们。起初觉得这违反直觉，但是恰恰说明了 Python 解释器实际所做的工作。

    考虑下面这个应用了两个装饰器的函数:

@also_decorated_by

@decorated_by

def add(x,y):

   "'Return the sum of x and y. ""

   return x+y

 

    首先发生的是由解释器创建add函数，然后应用 decorated_by装饰器。该装饰器返回了一个可调用函数(正如所有装饰器做的一样)，该函数被发送给also_ decorated_by装饰器，also_decorated_by也做了同样的事情，接下来结果被赋给add函数。

    切记，装饰器 decorated_by的应用程序与下面的代码在语法上是相同的:

 

add=decorated_by(add)

    前面两个装饰器示例与下面的代码在语法上相同

 

add =also_decorated_by(decorated_by(add))

 

    在这两种情况下，读取代码时首先读到装饰器also_decorated_by。但是，装饰器的应用是自底向上的，这与函数的解析(由内向外)是相同的。工作也采用同样的原则。

    在传统的函数调用情况下，解释器一定首先解析内部函数调用，以便有合适的对象或值发送给外部调用。

       add=also_decorated_by(decorated_by(add)) #First, get a return value for

                                          #decorated_by(add)

        add = also decorated_by(decorated_by(add))#Send that return value to

                                           #also decorated b

    

     有了装饰器后，通常首先创建add函数。

    @also_decorated_by

    @decorated_by

    def add(x, y):

       "'teturn the sum sf x and Y."'

       return x+y

 

    然后，调用装饰器@ decorated_by，并将其作为add函数的装饰方法。

    @also_decorated_by

    @decorated_by

    def add(x, y):

        "'Return the sum of x and y."'

        return x+y

 

    @decorated_by函数返回自己的可调用函数(在本例中，是add的修改版本)。该返回值在最后步骤发送给@also_decorated_by。

    @also_decorated_by

    @decorated_by

    def add(x, y):

        "'Return the sum of x and y."'

        return x+y

    应用装饰器时需要记住一件重要的事情，即装饰器的应用是自底向上的。很多时候，顺序非常重要。

1.3在何处使用装饰器

    Python标准库中包括很多包含装饰器的模块，并且很多常用工具和框架利用它们实现常用功能。

    例如，如果要使一个类上的方法不需要这个类的实例，可以使用@classmethod或@staticmethod装饰器，它们是标准库的一部分。mock模块(用于单元测试，在 Python3.3以后被添加到标准库中)允许使用@mock. patch或@mock. patch. object作为装饰器。

    一些常见工具也使用装饰器。 Django(用于 Python的常见Web框架)使用@login_required作为装饰器，允许开发人员指定用户必须登录オ能査看一个特定页面，并且使用@ permission_ required应用更具体的权限限制。Fask(另一个常见的Web框架)使用@app. route充当指定的URI与浏览器访问这些URI时所运行的函数之间的注册表。

    Celery(常见的 Python任务运行工具)使用复杂的@task装饰器来标识函数是否为异步任务。该装饰器实际上返回Task类的实例，用来阐明如何使用装饰器制作一个方便的APl;