说说 Python 装饰器「参数」的那些事儿。

待我称王封你为后i 2024-04-19 14:48 5阅读 0赞

在之前的文章　[面试系列 | 带你彻底搞懂 Python 装饰器][_ _ Python]　中，我介绍了学习 Python 装饰器的必备知识以及其最最基本的概念。既然是基本的知识点，那就是还有不基本，因为当时的考虑是篇幅已经够长以及里面涉及的知识点已经很多，写的再多了势必会影响大家的理解。所以剩下的那些留到今天来写，如果你没有看过之前的那篇文章，建议看过了再回来呦。

#### 00.获取函数参数 ####

在上一篇的最后，我写了一个装饰器的例子。为了方便，我把它拿过来给你看：

def check_admin(func):
        def wrapper(*args, **kwargs):
            if kwargs.get('username') != 'admin':
                raise Exception('This user do not have permission')
            return func(*args, **kwargs)
        return wrapper
    
    class Stack:
        def __init__(self):
            self.item = []
    
        @check_admin
        def push(self,username,item):
            self.item.append(item)
    
        @check_admin
        def pop(self,username):
            if not self.item:
                raise Exception('NO elem in stack')
            return self.item.pop()

接下来我们来使用一下上述定义的 Stack 类，在用的过程中我发现了一件很奇怪的事，当我向下面这样调用的时候程序是正常的：

s = Stack()
    s.push(username='admin', item=1)

而当我像下面这样调用的时候，程序就会报错：

s = Stack()
    s.push('admin', item=1)

你可能会生成“这怎么会出错”的疑问，因为按照我们理解的，「关键字参数」会根据名字进行匹配，而「位置参数」会根据参数所在的顺序进行匹配，既然这样的话，admin 明明是穿进了 username 变量，那为啥会出错呢？

其实上面我们怀疑的原因都没有问题，有问题的是我们的装饰器写的有问题。问题就是出现在装饰器的参数传递上。

在 check\_admin 这个装饰器中，我直接从 kwargs.get 中获得了 username 这个值。第一个正确是因为我用的是关键字参数传递的 username，那么 username 的变量以及值理应在 kwargs 中，第二个错误是因为我们用位置参数传递的 username，那么 username 的值出现在 args 中。

那么新的问题来了，作为用户来讲，无论使用位置参数或者是关键字参数都是对的，这个我们是无法去控制的，那这个问题应该怎么解决呢？Python 说：“用 inspect 模块”。其中的 getcallargs 可以解决这个问题，它返回的是一个字典，这个字典里保存了函数的所有参数。加下来我们看该怎么改：

import inspect
    
    def check_admin(func):
        def wrapper(*args, **kwargs):
            func_args = inspect.getcallargs(func, *args, **kwargs)
            if func_args.get('username') != 'admin':
                raise Exception('This user do not have permission')
            return func(*args, **kwargs)
        return wrapper

#### 01.带参数的装饰器 ####

在我们之前熟知的装饰器语法中，外层函数的参数是被装饰的函数，内层函数的参数是被装饰的函数的参数。但是有些时候我们想针对不同的函数装饰器有些变化怎么办，即给装饰器后面带上相应的参数。

比如有个针对加和减的装饰器如下所示：

s = Stack()
    s.push('admin', item=1)
    
    def tips(func):
        def wrapper(*args):
            print('start')
            func(*args)
            print('end')
        return wrapper
    
    @tips
    def add(a,b):
        print(a+b)
        
    @tips
    def sub(a,b):
        print(a-b)

但这个时候我想做点改变，想把函数的名字也给打出来，这个时候我们装饰器肯定就是要带上参数了，参数传的就是函数的名字，这个时候我们该怎么办？其实也简单的很，那就再嵌套一层函数呗。具体如下所示：

def new_tips(argv):
        def tips(func):
            def wrapper(*args):
                print('start %s' %(argv))
                func(*args)
                print('end')
    
            return wrapper
        return tips
    
    @new_tips('add')
    def add(a, b):
        print(a + b)
    
    @new_tips('sub')
    def sub(a, b):
        print(a - b)

其实这么来看，装饰器写起来还是套路满满呢。

今天就到这里就结束啦，不知道你学会了没呢？

#### 写在之后 ####

**更多内容，欢迎关注公众号「Python空间」，期待和你的交流**。  
![在这里插入图片描述][20181102073608273.jpg]

[_ _ Python]: https://mp.weixin.qq.com/s?__biz=MzUxMTc3NTI4Ng==&mid=2247484210&idx=1&sn=e50978f154d91ac2ec2fd9a1c4d2944b&chksm=f96fc46bce184d7d71bbc196eb4f7087245db7a16c2005c25f0f8a3f06c43f42983d05328648&token=1949647646&lang=zh_CN#rd
[20181102073608273.jpg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/a64db2b2742b49a39d42dbf631fd4335.jpg