欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

python装饰器入门

程序员文章站 2022-06-19 13:07:30
[TOC] python装饰器初级 认识装饰器 概念: 简单地说: 原则 : 不修改被装饰函数的源代码 不修改被装饰函数的调用方式 优点: 有助于让我们的代码更简短,也更Pythonic(Python范儿 应用场景: 在项目迭代过程中,需要不停的为某一个功能(函数)新增或删除某些小功能, 如果可复用 ......

目录

python装饰器初级

认识装饰器

  • 概念:
    • 简单地说:他们是为其他函数的新增功能的函数
  • 原则 :
    • 不修改被装饰函数的源代码
    • 不修改被装饰函数的调用方式
  • 优点:
    • 有助于让我们的代码更简短,也更pythonic(python范儿
  • 应用场景:
    • 在项目迭代过程中,需要不停的为某一个功能(函数)新增或删除某些小功能, 如果可复用的函数本来比较多, 在如果不停的对原始函数进行修改, 这将会是一件烦躁和重复的工作. 而使用装饰器就可以很完美的解决这种问题, 如web用户的的授权管理,日志输出等!

知识储备

  • 函数即变量

    • 函数本质在计算机的内存中的一个单独内存空间, 函数名如同其他类型(int, str, list...)变量名一样,可以进行赋值,传递
  • 嵌套函数 :

    • 定义: 在一个函数中定义另一个函数:

      def hi(name="faily"):
          print("now you are inside the hi() function")
      
          def greet():
              return "now you are in the greet() function"
      
          def welcome():
              return "now you are in the welcome() function"
      
          print(greet())
          print(welcome())
          print("now you are back in the hi() function")
      
      if __name__ == "__main__":
          hi()
  • 从函数中返回函数

    • 其实并不需要在一个函数里去执行另一个函数,也可以将其作为输出返回出来

      def hi(name="faily"):
          def greet():
              return "now you are in the greet() function"
      
          def welcome():
              return "now you are in the welcome() function"
      
          if name == "faily":
              return greet
          else:
              return welcome
      
      if __name__ == "__main__"
          a = hi()        # 此时返回的a实际是greet函数名
          print(a)        # 执行greet函数

      if/else语句中我们返回greetwelcome,而不是greet()welcome()。为什么那样?这是因为当你把一对小括号放在后面,这个函数就会执行;然而如果你不放括号在它后面,那它可以被到处传递,并且可以赋值给别的变量而不去执行它。

      当我们写下a = hi()hi()会被执行,而由于name参数默认是yasoob,所以函数greet被返回了。如果我们把语句改为a = hi(name = "momo"),那么welcome函数将被返回。我们还可以打印出hi()(),这会输出now you are in the greet() function

  • 高阶函数

    • 定义: 把一个函数名当作实参传递给另外一个函数

      # 计算函数的bar运行时间
      import time
      
      def bar():
          time.sleep(3)
          print("in the bar")
      
      def run_time(func):
          t1 = time.time()
          func()
          t2 = time.time()
          print("the func:{0} run time is {1}".format(func.__name__,t2-t1))
      
      if __name__ == "__main__":
          run_time(bar)
    • 缺点: 虽然实现了此功能,但是改变了 bar函数名

装饰器演变

  • 实际就是: 高阶函数 +嵌套函数的结合体

    认证 装饰器演变

    • v1 将函数作为参数传递进 嵌套函数中, 返回函数本身

      def cert_decorator(func):
      
          def wrapthefunction():
              user = input("pls input password:").strip()
              if user == "faily":
                  print("---welcome login----")
                  func()
              else:
                  print("----wrong password")
          return wrapper
      
      def task():
          print("do somthing ")
      
      if __name__ == "__main__":
          task = cert_decorator(task)   # 执行装饰器函数,将task作为参数传递,赋值给task变量,返回的是wrapper函数名,内部函数func并没有执行
          task()                        # 执行task,实际就是执行了wrapper(),然后执行了内部的func()函数

      实现了不改变函数名的和内部结构的前提下, 实现了认证,但是, 但是... 用户需要多些一行重命名函数变量的方式

    • v2 python内部可以通过@符号进行直接调用

      def cert_decorator(func):
      
          def wrapthefunction():
              user = input("pls input password:").strip()
              if user == "faily":
                  print("---welcome login----")
                  func()
              else:
                  print("----wrong password")
          return wrapthefunction
      
      @cert_decorator
      def task():
          print("do somthing ")
      
      if __name__ == "__main__":
          task()

      ※ 好像我们大功告成了... 别高兴得太早 ,如果我们运行一下这行代码 会存在一个问题

      print(task.__name__)
      #output
      wrapthefunction  

      ♥ . 这并不是我们想要的!ouput输出应该是task。这里的函数被warpthefunction替代了。它重写了我们函数的名字和注释文档(docstring), 如果我们想在被装饰的函数在执行之前去访问函数的某些属性(文档, 变量名...),显然是没办法做到的, 怎么办???

      幸运的是python提供给我们一个简单的函数来解决这个问题,那就是functools.wraps。我们修改上一个例子来使用functools.wraps

    • v3 使用functools.wraps

      from functools import wraps
      
      def cert_decorator(func):
          @wraps(func)
          def wrapthefunction():
              user = input("pls input password:").strip()
              if user == "faily":
                  print("---welcome login----")
                  func()
              else:
                  print("----wrong password----")
          return wrapthefunction
      
      @cert_decorator
      def task():
          print("do somthing ")
      
      if __name__ == "__main__":
          task()
          print(task.__name__)
      
      
      # output
      pls input password:mm
      ----wrong password----
      task

      注意:@wraps接受一个函数来进行装饰,并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性。