Coding~

Bottle 源码阅读(四) -- 注解, functools, yield, inspect

1. Python 注解使用

高阶函数, 指的是能将函数当成入参来操作, Python 注解也是这么做的, 使用 @ 符号, 让代码更简洁.

示例

def logger(fn):
    def wrapper():
        print('%s starts to executing' % fn.__name__)
        fn()
        print('%s finished executing' % fn.__name__)
    return wrapper


@logger
def hello():
    print('Hello world!')
##
hello starts to executing
Hello world!
hello finished executing

如果一个函数上面多个 decorator, 可以这么理解:

@decorator_one
@decorator_two
def func():
    pass
===>
func = decorator(arg1,arg2)(func)

带一个入参的

def route(url):
    def wrapper(fn):
        print('visiting url: {}'.format(url))
        fn()

    return wrapper


@route('hello/world')
def index():
    print('I am index')
##
visiting url: hello/world
I am index

带多个入参

函数上有入参, 需要在 decorator 中再嵌套一层, def inline(text): fn(text)

def route(**kwargs):
    def wrapper(fn):
        if 'url' in kwargs.keys():
            print('visiting url: {}'.format(kwargs['url']))

        def inline(text):
            fn(text)

        return inline

    return wrapper


@route(url='hello/world')
def index(name):
    print('I am ' + name)


index('world')
###
visiting url: hello/world
I am world

2. @functools.wraps(func) 作用

wraps()的作用就是把原函数的相关信息代入到新的函数中

如上面的例子, 使用了装饰器后, index 函数的函数名如下:

print(index.__name__)
print(index.__doc__)
##
visiting url: hello/world
inline
None

在闭包函数上, 添加 @functools.wraps(fn) 就可以复原函数的 __name__ __doc__.

3. load 函数

def load(target, **namespace):
    """ Import a module or fetch an object from a module.

        * ``package.module`` returns `module` as a module object.
        * ``pack.mod:name`` returns the module variable `name` from `pack.mod`.
        * ``pack.mod:func()`` calls `pack.mod.func()` and returns the result.

        The last form accepts not only function calls, but any type of
        expression. Keyword arguments passed to this function are available as
        local variables. Example: ``import_string('re:compile(x)', x='[a-z]')``
    """
    module, target = target.split(":", 1) if ':' in target else (target, None)
    if module not in sys.modules: __import__(module)
    if not target: return sys.modules[module]
    if target.isalnum(): return getattr(sys.modules[module], target)
    package_name = module.split('.')[0]
    namespace[package_name] = sys.modules[package_name]
    return eval('%s.%s' % (module, target), namespace)

上面的load 函数, 在源码中大量被使用, 具体的作用, 注释讲解的很清楚, 可以返回文件中 from xx import xx 的模块, 变量, 函数.

简单测试一下:


def load(target, **namespace):
    module, target = target.split(":", 1) if ':' in target else (target, None)
    if module not in sys.modules: __import__(module)
    if not target: return sys.modules[module]
    if target.isalnum(): return getattr(sys.modules[module], target)
    package_name = module.split('.')[0]
    namespace[package_name] = sys.modules[package_name]
    print('Start to load: \nmodule:%s\npackage_name: %s\nnamespace: %s' % (module, package_name, namespace))
    object = eval('%s.%s' % (module, target), namespace)
    print(object)
    return object


fp = load('six_web.cli:_get_version')
fp()
###
Start to load:
module:six_web.cli
package_name: six_web
namespace: {'six_web': <module 'six_web' from '/Users/fish/Documents/GitHub/six-web/six_web/__init__.py'>}
<function _get_version at 0x10a2bad08>
six_web version: 2.0.

3. yield 使用

yield 的作用就是把一个函数变成一个 generator，带有 yield 的函数不再是一个普通函数，Python 解释器会将其视为一个 generator. 主要的功能是节省内存.

在 python2 中, range(10) 返回一个 list, 而 xrange(10) 返回的是 iterable 对象, 在 python3 中, 直接使用 range 统一返回 iterable 对象.

def fab(max):
    n, a, b = 0, 0, 1
    while n < max:
        yield b
        # print b
        a, b = b, a + b
        n = n + 1

输出如下:

>>> f = fab(3)
>>> f
<generator object fab at 0x10de1f9e8>
>>> next(f)
1
>>> f.__next__()
1
>>> f.__next__()
2
>>> f.__next__()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

综合来讲, yield 的目的是中断函数, 返回当前的值, 当 next(f) or f.__next__() 或者在 for 循环时, 从中断位置继续向下走.

挺好玩的!

Bottle 源码中, 路由处理, 有这么一处用法:

def yieldroutes(func):
    """ Return a generator for routes that match the signature (name, args)
    of the func parameter. This may yield more than one route if the function
    takes optional keyword arguments. The output is best described by example::

        a()         -> '/a'
        b(x, y)     -> '/b/<x>/<y>'
        c(x, y=5)   -> '/c/<x>' and '/c/<x>/<y>'
        d(x=5, y=6) -> '/d' and '/d/<x>' and '/d/<x>/<y>'
    """
    path = '/' + func.__name__.replace('__', '/').lstrip('/')
    spec = getargspec(func)
    argc = len(spec[0]) - len(spec[3] or [])
    path += ('/<%s>' * argc) % tuple(spec[0][:argc])
    print(path)
    yield path
    for arg in spec[0][argc:]:
        path += '/<%s>' % arg
        print(path)
        yield path

4. inspect 模块

上面源码中有一句 spec = getargspec(func), 为了弄清这行代码意思, 了解了一下 inspect 模块, 该模块提供一些有用的函数去帮助获取活动对象信息.

getargspec 用法

getargspec 是获取函数入参的, 示例如下:

>>> from inspect import getargspec
>>> getargspec(f)
ArgSpec(args=['a', 'b'], varargs='pos', keywords='named', defaults=(1,))
>>> from inspect import getargspec
>>> def f(a, b=1, *pos, **named):
...     pass
...
>>> getargspec(f)
ArgSpec(args=['a', 'b'], varargs='pos', keywords='named', defaults=(1,))

常用用法

inspect.ismodule
inspect.isclass
inspect.ismethod

inspect.getmembers()            返回 dict(), 获取 Object 中所有的对象.

inspect.getsource(hello)        查看整个模块hello的源代码

inspect.getsource(hello.w)      查看模块hello里面wo这个类的全部代码

inspect.getsource(hello.h)      查看模块内某个函数的代码

inspect.getsource(hello.w.g)    查看模块内某个类中函数的代码

inspect.getabsfile(hello)       查看模块的路径
blog comments powered by Disqus

Published

31 October 2017

Tags