Day5 python基础5 装饰器

 一、python装饰器基本概念 

　　定义：本质是函数，用来装饰其他函数，即为其他函数添加附加功能。

　　原则：1.不能修改被装饰函数的源代码；

　　　　   2.不能修改被装饰函数的调用方式。

　　实现装饰器的知识储备：

　　　　1.函数即“变量”。

　　　　2.高阶函数

　　　　　　a.把一个函数名当作实参传给另一个函数；

　　　　　　b.返回值中包含函数名。

　　　　3.嵌套函数

　　　　　　即在用def定义一个函数的函数体中再用def定义函数。

　　高阶函数 + 嵌套函数 => 装饰器

  二、函数即“变量” 

　　定义一个变量

x = 1

　　变量名x相当于一个门牌号，而1就是这个门牌号所指房间中的内容。

　　定义一个函数

def foo():
    print('in the foo')

　　函数名foo就相当于一个门牌号，而函数体 print('in the foo') 作为一串字符串存在这个门牌号所指的房间中。

　　故 函数即“变量”

 三、高阶函数 

　　a. 把一个函数名当作实参传递给另一个函数（在不修改被装饰函数源代码的情况下为其添加功能）；

　　b. 返回值中包含函数名（不改变函数的调用方式）。

　　代码示例：

#a:把一个 函数名 当作实参传给另一个函数 (在不修改被装饰函数源代码的情况下为其添加功能)
import time

def bar():
    time.sleep(3)
    print('in the bar')

def test1(func):
    print(func)
    start_time = time.time()
    func()     #运行bar()
    stop_time = time.time()
    print("the func run time is %s"%(stop_time-start_time))

test1(bar)  # bar即为函数的内存地址，加“（）”即为调用此函数
#bar()

<function bar at 0x0000021F3E956048>
in the bar
the func run time is 3.0008294582366943

 

#b:返回值中包含 函数名 (不改变函数的调用方式）
import time

def bar():
    time.sleep(3)
    print('in the bar')

def test2(func):
    print(func)
    return func

t = test2(bar)
print(t)
bar = test2(bar)   # 注意这一句
bar()
t()   #run bar

<function bar at 0x00000265D5486048>
<function bar at 0x00000265D5486048>
<function bar at 0x00000265D5486048>
in the bar
in the bar

 四、嵌套函数 

　　在用def定义一个函数的函数体中再用def定义函数。

　　代码示例：

def foo():
    print("in the foo")
    def bar():
        print("in the bar")
    bar()
#bar()       #错误写法 ，函数即变量，可把bar看作局部变量
foo()

in the foo
in the bar

 五、装饰器 

　　1. 引例，为test1()增加输出运行时间的功能。

import time

def timer(func):   #timmer(test1)    func=test1
    def deco():
        start_time = time.time()
        func()     #在def中，func（）只是一串字符串，func（）并没有调用执行
        stop_time = time.time()
        print("the func run time is %s" % (stop_time - start_time))
    return deco

def test1():
    time.sleep(3)
    print("in the test1")

test1 = timer(test1)  #注意这一句
test1()    #运行test()即为运行deco()

in the test1
the func run time is 3.0002777576446533

　　2.无参数装饰器

import time

def timer(func):   #timmer(test1)    func=test1
    def deco():
        start_time = time.time()
        func()     #在def中，func（）只是一串字符串，func（）并没有调用执行
        stop_time = time.time()
        print("the func run time is %s" % (stop_time - start_time))
    return deco

@timer   # test1=timer(test1)
def test1():
    time.sleep(3)
    print("in the test1")

test1()

in the test1
the func run time is 3.0149574279785156

　　引入 @timer ，即相当于 test1=timer(test1) 语句。

　　3.带不确定个数个参数的装饰器

import time

def timer(func):   #timmer(test1)    func=test1
    def deco(*args,**kwargs):
        start_time = time.time()
        func(*args,**kwargs)     #在def中，func（）只是一串字符串，func（）并没有调用执行
        stop_time = time.time()
        print("the func run time is %s" % (stop_time - start_time))
    return deco

@timer   # test1=timer(test1)
def test1():
    time.sleep(3)
    print("in the test1")

@timer
def test2(name):
    time.sleep(1)
    print("in the test2",name)

test1()
test2('ztian')

in the test1
the func run time is 3.000495195388794
in the test2 ztian
the func run time is 1.000511884689331

　　利用*args和**kwargs实现不定参数个数的装饰器。

 　　4.被装饰函数带返回值

import time

def timer(func):   #timmer(test1)    func=test1
    def deco(*args,**kwargs):
        start_time = time.time()
        res = func(*args,**kwargs)     #在def中，func（）只是一串字符串，func（）并没有调用执行
        stop_time = time.time()
        print("the func run time is %s" % (stop_time - start_time))
        return res
    return deco

@timer   # test1=timer(test1)
def test1():
    time.sleep(3)
    print("in the test1")
    return "the return of test1"

print(test1())

in the test1
the func run time is 3.0094504356384277
the return of test1

 　　5.装饰器终极版

　　三层嵌套函数，使装饰器可以对应于不同的类型。

　　代码示例（模拟网站登录验证，可采用本地或ldap的验证方式）：

user,passwd = 'ztian','abc123'

def auth(auth_type):                # auth_type <- "local"
    print("auth func->",auth_type)
    def outer_wrapper(func):        # func <- home
        print("outer_wrapper func->",func)

        def wrapper(*args,**kwargs):
            print("wrapper func->", *args,**kwargs)
            if auth_type == "local":
                username = input("Username:").strip()
                password = input("Password:").strip()
                if user==username and passwd==password:
                    print("\033[32;1mUser has passed authentication\033[0m")
                    res = func(*args,**kwargs)
                    print("after authentication".center(50,'-'))
                    return res
                else:
                    exit("\033[31;1mInvaild username or password\033[0m")
            elif auth_type == "ldap":
                print("no ldap")

        return wrapper
    return outer_wrapper

def index():
    print("welcome to index page")

@auth(auth_type = "local")    # 先将auth_type传过去，然后home = out_wrapper(home)将home传给func
def home():
    print("welcome to home page")
    return "from home"

@auth(auth_type = "ldap")
def bbs():
    print("welcome to bbs page")

index()
print(home())   #wrapper()
bbs()

outer_wrapper func-> <function home at 0x000001F00D2AD6A8>
auth func-> ldap
outer_wrapper func-> <function bbs at 0x000001F00D2AD620>
welcome to index page
wrapper func->
Username:ztian
Password:abc123
User has passed authentication
welcome to home page
---------------after authentication---------------
from home
wrapper func->
no ldap