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

Decorator——Python初级函数装饰器

程序员文章站 2022-04-08 23:13:01
(1)if __name__ == '__main__' (2)列表解析式 (3)装饰器 ......

最近想整一整数据分析,在看一本关于数据分析的书中提到了(1)if __name__ == '__main__' (2)列表解析式 (3)装饰器。

先简单描述一下前两点,再详细解说python初级的函数装饰器。

进入正题:

 

 

一、if __name__ == '__main__' 

  1. 首先,__name__是一个程序名变量,而这个变量的值是根据程序的运行方式决定的。如果程序是被当作主程序运行的,那__name__将会被赋值为__main__;当程序是作为模块被其他文件调用的,那它会自动被赋值为模块所在(程序)的文件名。
  2. 一般这句代码以这种形式出现:
    1 def printhello():
    2     print("hello world!")
    3     print(__name__)
    4 if __name__ == '__main__':
    5     printhello()

    其输出如下:

    hello world!
    __main__

    因为此时这个文件是以主程序的方式运行的,故它的__name__为__main__。

  3. 这个 if 判断语句存在的意义在于当程序被作为模块引入其他文件时,一句import会使得这个模块自动运行一次。
  4. 故当 printhello 函数被作为模块调入其他程序文件时,即:
    1 from name_main import printhello
    2 printhello()

    我们只会得到 printhello 运行一次的结果。这一次结果是 import 语句的效果,真正的 printhello 函数被 if 语句拦住了(因为它的__name__变成了自己的文件名而非__main__)。

 

 

二、列表解析式

  • 列表解析式其实就是一种根据已有列表,高效创建新列表的方式。
  • 通常形式如:a = [ i for i in list1 if i%2==0 ]
  • 学会使用,可以简洁化代码。

 

 

三、装饰器

  • 装饰器器如其名,起到了“装饰”的作用。体现在代码中就是给原程序添加“装饰”,添加新的东西。装饰器的本质是函数。
  • 装饰器一般用于装饰函数和类。
  • 有人问既然装饰器起到的是装饰的作用,那为什么不在函数中就添加这些“装饰”?当然可以,这确实可行。但设想我们需要每个函数打印自己的运行时间,那我们就需要在每一个函数里记录开始与结束时间,再相减得到时间差(即运行时间)。这会使得函数非常的“臃肿”,而且如果有成百上千个函数都需要这个功能,那一个一个函数加代码的措施就显得十分“无意义”。
  • 但通过装饰器:我们简单地定义一个“装饰”函数去实现需要的功能,然后在执行函数的前面加上一句“@装饰函数”,就实现了对函数们的装饰和升级。
  • 举一个例子,我们现在有两个函数分别实现打印 hello 和 goodbye,我们需要每次打印时同时把这个函数名打印出来。我们就可以用装饰器来完成,上代码。
    #直接装饰@
    def printname(func):        #装饰器:实质是一个函数,参数是需要装饰的函数名(非函数调用)
        def wrapper(*args, **kwargs):    #可变参数*args和关键字参数**kwargs
            print(f"[debug]: enter {func.__name__}()")
            return func(*args, **kwargs)
        return wrapper          #装饰器函数返回的是装饰完的函数
    
    
    @printname
    def say_hello():
        print("hello!")
        
    
    @printname
    def say_goodbye():
        print("goodbye!")
        
    
    if __name__ == '__main__':
        say_hello()
        say_goodbye()

    程序运行结果为:

    [debug]: enter say_hello()
    hello!
    [debug]: enter say_goodbye()
    goodbye!

    成功实现每次打印hello时打印出函数名称say_hello()。

  • 接下来是对装饰器的深层探讨。装饰器的本质是函数,那我们如果不用@的装饰方式,看看怎么样实现同样的功能。
    #间接装饰
    def printname(func):        #装饰器:实质是一个函数,参数是需要装饰的函数名(非函数调用)
        def wrapper(*args, **kwargs):    #可变参数*args和关键字参数**kwargs
            print(f"[debug]: enter {func.__name__}()")
            return func(*args, **kwargs)
        return wrapper          #装饰器函数返回的是装饰完的函数
    
    
    def say_hello():
        print("hello!")
        #return 0           测试line:23
    
    def say_goodbye():
        print("goodbye!")
    
    if __name__ == '__main__':
        decorator = printname(say_hello)
    
        '''
        不能使用decoratot = printname(say_hello());
        可能是因为调用函数的名称是用func.__name__,而非func().__name__
        用了func().name会报错'nonetype'对象没有'__name__'属性。
    
        因为say_hello()函数没有return,故执行结果为nonetype无。
        '''
    
        decorator()
    
        '''
    
        接上绿色注释:
        >>> type(say_hello())
        hello!
        <class 'nonetype'>
        >>> type(say_hello)
        <class 'function'>
    
        
        '''
    #func,函数不带括号时,调用的是这个函数本身。是一整个函数体,不须等函数执行完成。
    
    #func(),函数带括号时,调用的是函数的执行结果,需要等待函数执行完成的结果。

    和@方法的区别主要在于如何使用装饰器函数。我们需要在调用时把执行函数传入给装饰函数,return 的结果返回给新函数;再运行新函数,就实行了这一效果。

  • 最后对装饰函数的代码做一个解读。(应该在前面解读的)
  1. printname(func)是装饰函数,它的参数是func(一个函数,即执行函数),它的return是wrapper函数。
  2. 在printname里定义一个wrapper函数(参数、关键字可变),把装饰器的内容包装在wrapper里。wrapper返回的是func(执行函数)。
  3. 相当于是这一段代码执行了wrapper函数
    1 def printname(func):
    2     def wrapper(*args, **kwargs):
    3         print(f"[debug]: enter {func.__name__}()")
    4         return func(*args, **kwargs)
    5     return wrapper

    实现了:print(装饰)+  func(执行函数),即成功装饰。

  • 还有一个很有趣的例子,在https://www.cnblogs.com/cicaday/p/python-decorator.html#4027718046,感谢作者的点拨。

 

  • 装饰器总结:

    实质: 是一个函数

    参数:是你要装饰的函数名(并非函数调用)

    返回:是装饰完的函数名(也非函数调用)

    作用:为已经存在的对象添加额外的功能

    特点:不需要对对象做任何的代码上的变动