好得很程序员自学网

<tfoot draggable='sEl'></tfoot>

一步步教你理解Python装饰器

或许你已经用过装饰器,它的使用方式非常简单但理解起来困难(其实真正理解的也很简单),想要理解装饰器,你需要懂点函数式编程的概念,python函数的定义以及函数调用的语法规则等,虽然我没法把装饰器变得简单,但是我希望可以通过下面的步骤让你由浅入深明白装饰器是什么。假定你拥有最基本的Python知识,本文阐述的东西可能对那些在工作中经常接触Python的人有很大的帮助。下面我们来一步步理解python的装饰器:

1、函数(Functions)

在Python里,函数是用def关键字后跟一个函数名称和一个可选的参数表列来创建的,可以用关键字return指定返回值。下面让我们创建和调用一个最简单的函数:

>>> def foo():
...     return 1
>>> foo()
1 

2、作用域(Scope)

在Python中,每个函数都会创建一个作用域。Pythonistas也可能称函数拥有它们自己的命名空间(namespace)。这意味着当在函数体里遇到变量名时,Python首先在该函数的命名空间中查找,Python包含了一些让我们查看命名空间的函数。让我们写一个简单的函数来探查一下local和global作用域的区别。

>>> a_string = "This is a global variable"
>>> def foo():
...     print locals()
>>> print globals() # doctest: +ELLIPSIS
{..., 'a_strin': 'This ia a global variable'}
>>> foo() # 2
{} 

3、变量解析规则(variable resolution rules)

当然,这并不意味着在函数内部我们不能访问全局变量。Python的作用域规则是,变量的创建总会创建一个新的local变量,但是变量的访问(包括修改)会先查找local作用域然后顺着最邻近的作用域去寻找匹配。因此,如果我们修改foo函数来让它打印global变量,结果就会像我们希望的那样:

>>> a_string = "This is global variable"
>>> def foo():
...     print a_string # 1
>>> foo()
This is a global variable 

另一方面,如果我们尝试在函数里给global变量赋值,结果将不如我们所愿:

>>> a_string = 'This is a global variable"
>>> def foo():
...     a_string = "test" # 1
...        print locals()
>>> foo()
{'a_string': 'test'}
>>> a_string # 2
'This is a global variable' 

4、变量的生命周期(Variable lifetime)

也要注意到,变量不仅“生活在”一个命名空间里,它们还有生命周期。考虑下面的代码:

>>> def foo():
...     x = 1
>>> foo()
>>> print x # 1
Traceback (most recent call last):
...
NameError: name 'x' is not defined 

5、函数的参数(Function parameters)

Python允许我们向函数传递参数。参数名成为了该函数的local变量。

>>> def foo(x):
...        print locals()
>>> foo(1)
{'x': 1} 

Python有许多不同的定义和传递函数参数的方法。要想更详细深入地了解请参照the Python documentation on defining functions。这里我展示一个简版:函数参数既可以是强制的位置参数(positional parameters)或者是命名参数,参数的默认值是可选的。

>>> def foo(x, y=0): # 1
...     return x - y
>>> foo(3, 1) # 2
2
>>> foo(3) # 3
3
>>> foo() # 4
Traceback (most recent call last):
...
TypeError: foo() takes at least 1 argument (0 given)
>>> foo(y=1, x=3) # 5
2 

6、内嵌函数(Nested functions)

Python允许创建嵌套函数,这意味着我们可以在函数内声明函数并且所有的作用域和声明周期规则也同样适用。

>>> def outer():
...     x = 1
...     def inner():
...         print x # 1
...     inner() # 2
...
>>> outer()
1 

7、函数是一等公民(Functions are first class objects in Python)

在Python中,这是一个常识,函数是和其它任何东西一样的对象。呃,函数包含变量,它不是那么的特殊!

>>> issubclass(int, object) # all objects in Python inherit from a common baseclass
True
>>> def foo():
...     pass
>>> foo.__class__ # 1>>> issubclass(foo.__class__, object)
True 


你也许从没想到过函数也有属性,但是在Python中,和其它任何东西一样,函数是对象。(如果你发觉这令你感到困惑,请等一下,知道你了解到在Python中像其它任何东西一样,class也是对象!)也许正是因为这一点使Python多少有点“学术”的意味——在Python中像其它任何值一样只是常规的值而已。这意味着你可以将函数作为参数传递给函数或者在函数中将函数作为返回值返回!如果你从未考虑过这种事情请考虑下如下的合法Python代码:

>>> def add(x, y):
...     return x + y
>>> def sub(x, y):
...     return x - y
>>> def apply(func, x, y): # 1
...     return func(x, y) # 2
>>> apply(add, 2, 1) # 3
3
>>> apply(sub, 2, 1)
1 

你之前可能见过这种行为——Python将函数作为参数经常见于像通过为key参数提供一个函数来自定义sorted内建函数等操作中。但是,将函数作为返回值返回会怎样呢?请考虑:

>>> def outer():
...     def inner():
...         print "Inside inner"
...     return inner # 1
...
>>> foo = outer() #2
>>> foo # doctest:+ELLIPSIS
 
>>> foo()
Inside inner 

8、闭包(Closures)

让我们不从定义而是从另一个代码示例开始。如果我们将上一个例子稍加修改会怎样呢?

>>> def outer():
...     x = 1
...     def inner():
...         print x # 1
...     return inner
>>> foo = outer()
>>> foo.func_closure # doctest: +ELLIPSIS
( ,) 

请记住,每次当outer函数被调用时inner函数都被重新定义一次。目前x的值没有改变,因此我们得到的每个inner函数和其它的inner函数拥有相同的行为,但是如果我们将它做出一点改变呢?

>>> def outer(x):
...     def inner():
...         print x # 1
...        return inner
>>> print1 = outer(1)
>>> print2 = outer(2)
>>> print1()
1
>>> print2()
2 

9、装饰器(Decorators)

一个decorator只是一个带有一个函数作为参数并返回一个替换函数的闭包。我们将从简单的开始一直到写出有用的decorators。

>>> def outer(some_func):
...        def inner():
...            print "before some_func"
...            ret = some_func() # 1
...            return ret + 1
...        return inner
>>> def foo():
...        return 1
>>> decorated = outer(foo) # 2
>>> decorated()
before some_func
2 

我们可以说decorated变量是foo的一个“装饰”版本——由foo加上一些东西构成。实际上,如果我们写了一个有用的decorator,我们可能想用装饰后的版本来替换foo,从而可以得到foo的“增添某些东西”的版本。我们可以不用学习任何新语法而做到这一点——重新将包含我们函数的变量进行赋值:

>>> foo = outer(foo)
>>> foo # doctest: +ELLIPSIS
  

10、装饰器的语法糖--@符号(The @ symbol applies a decorator to a function)

Python 2.4通过在函数定义前添加一个@符号实现对函数的包装。在上面的代码示例中,我们用一个包装了的函数来替换包含函数的变量来实现了包装。

>>> add = wrapper(add) 

这一模式任何时候都可以用来包装任何函数,但是如果们定义了一个函数,我们可以用@符号像下面示例那样包装它:

>>> @wrapper
... def add(a, b):
...     return Coordinate(a.x + b.x, a.y + b.y) 

这种情况很常见,所以Python为这一特性提供了语法支持。请确保阅读Python Tutorial以了解更多,但是在函数定义时使用*运算符意味着任何传递给函数的额外位置参数最终以一个*作为前导。因此:

>>> def one(*args):
...     print args # 1
>>> one()
()
>>> one(1, 2, 3)
(1, 2, 3)
>>> def two(x, y, *args): # 2
...     print x, y, args
>>> two('a', 'b', 'c')
a b ('c') 

*运算符也可以用于函数调用中,这时它也有着类似的意义。在调用一个函数时带有一个以*为前导的变量作为参数表示这个变量内容需要被解析然后用作位置参数。再一次以实例来说明:

>>> def add(x, y):
...     return x + y
>>> lst = [1, 2]
>>> add(lst[0], lst[1]) # 1
3
>>> add(*lst) # 2
3 

当我们引入**时,事情变得更加复杂点,与*表示iterables和位置参数一样,**表示dictionaries & key/value对。很简单,不是么?

>>> def foo(**kwargs):
...     print kwargs
>>> foo()
{}
>>> foo(x=1, y=2)
{'y': 2, 'x': 1} 

当我们定义一个函数时我们可以用**kwargs表明所有未捕获的keyword变量应该被存储在一个名为kwargs的字典中。前面的例子中的args和本例中的kwargs都不是Python语法的一部分,但是在函数定义时使用这两个作为变量名时一种惯例。就像一样,我们可以在函数调用时使用\*。

>>> dct = {'x': 1, 'y': 2}
>>> def bar(x, y):
...     rturn x + y
>>> bar(**dct)
3 

12、更通用的装饰器(More generic decorators)

用我们掌握的新“武器”我们可以写一个decorator用来“记录”函数的参数。为了简单起见,我们将其打印在stdout上:

>>> def logger(func):
...     def inner(*args, **kwargs): # 1
...     print "Arguments were: %s, %s" % (args, kwargs)
...     return func(*args, **kwargs) # 2
... return inner 

注意到在#1处inner函数带有任意数量的任何类型的参数,然后在#2处将它们传递到被包装的函数中。这允许我们包装或者装饰任何函数。

>>> @logger
... def foo1(x, y=1):
...     return x * y
>>> @logger
... def foo2():
...     return 2
>>> foo1(5, 4)
Arguments were: (5, 4), {}
20
>>> foo1(1)
Arguments were: (1,), {}
1
>>> foo2()
Arguments were: (),{}
2 

如果你一直跟到了最后一个实例,祝贺你,你已经理解了decorators了!

查看更多关于一步步教你理解Python装饰器的详细内容...

  阅读:43次