python3_装饰器__装饰器原则 / 装饰函数和方法 / 装饰类 / 嵌套函数 / 高阶函数 / 可调用对象

以你之姓@ 2022-05-16 02:56 149阅读 0赞

# 1.装饰器说明 #

>        装饰器(decorator)是一种高级Python语法。**装饰器可以对一个函数、方法或者类进行加工**。在Python中，我们有多种方法对函数和类进行加工，比如在[Python闭包][Python]中，我们见到函数对象作为某一个函数的返回结果。相对于其它方式，装饰器语法简单，代码可读性高。因此，**装饰器在Python项目中有广泛的应用**。
> 
>        装饰器最早在Python 2.5中出现，它最初被用于加工函数和方法这样的**可调用对象(callable object，这样的对象定义有****\_\_call\_\_方法)**。在Python 2.6以及之后的Python版本中，装饰器被进一步用于加工类

# 2.装饰器原则 #

> 1. 接收一个可调用对象作为参数
> 
> 2. 不能修饰被装饰函数的源代码
> 
> 3. 不能修改被装饰函数的调用方式

# 3.装饰器所涉及的知识点 #

> 1. 函数名即引用
> 
> 2. 高阶函数（①函数接收另一个函数作为实参②返回值中包含函数名）
> 
> 3. 嵌套函数

# 4.装饰函数和方法 #

### （一）简单装饰器 ###

> 问题描述：
> 
>        定义两个函数home()和bbs()函数，两个函数实现的均为页面的展示功能。现在有这样一个需求：需要增加另外的功能，比如用户的登录验证功能。此时，若想修改原函数，对一个项目来说非常的不友好，此时装饰器则成为首选。
> 
> 说明：
> 
> 1. 装饰器standard\_input定义好后，**通过@standard\_input进行调用**。实际的是将home()和bbs()函数的内存地址传入装饰器，并将装饰器返回的新的可调用对象的内存地址赋值给原来的函数名（return wrapper）
> 
> 2. **@standard\_input --> 等价于 --> home = standard\_input(home)**
> 
> 3. 该操作的优点是：如果我们有其他的类似函数，我们可以继续调用decorator来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

# ----原始函数
    name = "test"
    passwd = "123456"
    
    
    def home(na, pw):
        print("welcome to home page!")
    
    
    def bbs(na, pw):
        print("welcome to bbs page!")
    
    
    if "__main__" == __name__:
    
        home()
        bbs()

# ----装饰器修饰函数
    name = "test"
    passwd = "123456"
    
    
    # ----装饰器
    def standard_input(func):
    
        # --嵌套函数
        def wrapper(*args, **kwargs):
            username = input("username: ").strip()
            password = input("password: ").strip()
    
            if name == username and passwd == password:
                print("\033[32;1mUser has passed authentication\033[0m")
                
                # --带装饰函数执行
                func(*args, **kwargs)
            else:
                exit("\033[31;1mInvalid username or password\033[0m")
    
        return wrapper
    
    
    
    
    @standard_input
    def home():
        print("welcome to home page!")
    
    
    @standard_input
    def bbs():
        print("welcome to bbs page!")
    
    
    if "__main__" == __name__:
    
        home()
        bbs()

### （二）处理返回值的装饰器 ###

>        上边简单的装饰器有一个问题，那就是当待装饰的函数出现返回值的时候无法进行处理。为了解决这个问题，只需要在嵌套函数wrapper中进行部分调整即可。

def standard_input(func):
        def wrapper(*args, **kwargs):
            username = input("username: ").strip()
            password = input("password: ").strip()
    
            if name == username and passwd == password:
                print("\033[32;1mUser has passed authentication\033[0m")
    
                # --处理待修饰函数的返回值
                res = func(*args, **kwargs)
                return res
    
            else:
                exit("\033[31;1mInvalid username or password\033[0m")
    
        return wrapper

### （三）含参装饰器 ###

> 需求：
> 
>         有时会有这样一种需求：在不同的页面需要采用不同的登录方式，例如：在主页采用本地登陆，在论坛页面采用远程服务器登录方式。针对这种问题，可以在主页面采用本地登录（@standard\_input(auth\_type="local")），其他页面采用远程服务器登录（@standard\_input(auth\_type="ldap")）。
> 
>         ** 装饰器的语法允许我们调用decorator时，提供其它参数，比如@decorator(a)。这样，就为装饰器的编写和使用提供了更大的灵活性。**
> 
>          该方式的实现，需要在原有装饰器的外层再添加一层嵌套函数（def decorator）接收装饰器参数，并对参数进行判断。

# 处理返回值
    name = "test"
    passwd = "123456"
    
    
    # --该外层函数用于接收装饰器参数
    def decorator(auth_type=""):
        def standard_input(func):
            def wrapper(*args, **kwargs):
                username = input("username: ").strip()
                password = input("password: ").strip()
    
                if "local" == auth_type:
                    print("--this is local--")
                    if name == username and passwd == password:
                        print("\033[32;1mUser has passed authentication\033[0m")
                        res = func(*args, **kwargs)
                        return res
                    else:
                        exit("\033[31;1mInvalid username or password\033[0m")
                elif "ldap" == auth_type:
                    print("--this is ldap--")
                    print("正在进行远程登录......")
    
            return wrapper
    
        # --此处需要返回内层嵌套函数的内存地址
        return standard_input
    
    
    @decorator(auth_type="local")
    def home():
        print("welcome to home page!")
        return "this is the home return"
    
    
    @decorator(auth_type="ldap")
    def bbs():
        print("welcome to bbs page!")
    
    
    if "__main__" == __name__:
    
        res = home()
        print(res)
        bbs()

# 5.装饰类 #

> 在Python 2.6以后，装饰器被拓展到类。**一个装饰器可以接收一个类，并返回一个类**，从而起到加工类的效果。

# 待装饰函数
    class People(object):
        # --初始化方法
        def __init__(self, age):
            self.age = age
    
        # --自我介绍
        def display(self):
            print("my age is: ", self.age)
    
    
    if "__main__" == __name__:
    
        p1 = People(23)
        p1.display()

>         如上代码所示，是一个简单的类，实例化后可通过调用display()方法进行自我介绍。**此时想添加新功能，即输出调用display方法的总次数**。故采用装饰器装饰类。注意：不能修改原始函数的调用方式和源代码。

def decorator(PeopleClass):
        class NewClass(object):
            def __init__(self, age):
    
                # --记录display()方法被调用的次数
                self.total_display = 0
                # --记录原来类生成的对象
                self.wrapped = PeopleClass(age)
    
            def display(self):
                self.total_display += 1
                print("total display: ", self.total_display)
                # --调用原来函数功能
                self.wrapped.display()
    
        # --返回修饰后的新类
        return NewClass
    
    
    @decorator
    class PeopleClass(object):
        # --初始化方法
        def __init__(self, age):
            self.age = age
    
        # --自我介绍
        def display(self):
            print("my age is: ", self.age)
    
    
    if "__main__" == __name__:
    
        # p1 = PeopleClass(23)
        # p1.display()
    
        p2 = PeopleClass(24)
        for i in range(5):
            p2.display()

[Python]: http://www.cnblogs.com/vamei/archive/2012/12/15/2772451.html