Python中的魔法方法深入理解

# 从当前request获取内容
request.args
request.forms
request.cookies
... ...

# 获取当前request
request = get_request()
get_request().args

# File: flask/globals.py
from functools import partial
from werkzeug.local import LocalStack, LocalProxy

def _lookup_req_object(name):
    top = _request_ctx_stack.top
    if top is None:
        raise RuntimeError('working outside of request context')
    return getattr(top, name)

# context locals
_request_ctx_stack = LocalStack()
request = LocalProxy(partial(_lookup_req_object, 'request'))

@implements_bool
class LocalProxy(object):
    __slots__ = ('__local', '__dict__', '__name__')

    def __init__(self, local, name=None):
        # 这里有一个点需要注意一下，通过了__setattr__方法，self的
        # "_LocalProxy__local" 属性被设置成了local，你可能会好奇
        # 这个属性名称为什么这么奇怪，其实这是因为Python不支持真正的
        # Private member，具体可以参见官方文档：
        # http://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references
        # 在这里你只要把它当做 self.__local = local 就可以了 :)
        object.__setattr__(self, '_LocalProxy__local', local)
        object.__setattr__(self, '__name__', name)

    def _get_current_object(self):
        """
        获取当前被代理的真正对象，一般情况下不会主动调用这个方法，除非你因为
        某些性能原因需要获取做这个被代理的真正对象，或者你需要把它用来另外的
        地方。
        """
        # 这里主要是判断代理的对象是不是一个werkzeug的Local对象，在我们分析request
        # 的过程中，不会用到这块逻辑。
        if not hasattr(self.__local, '__release_local__'):
            # 从LocalProxy(partial(_lookup_req_object, 'request'))看来
            # 通过调用self.__local()方法，我们得到了 partial(_lookup_req_object, 'request')()
            # 也就是 ``_request_ctx_stack.top.request``
            return self.__local()
        try:
            return getattr(self.__local, self.__name__)
        except AttributeError:
            raise RuntimeError('no object bound to %s' % self.__name__)

    # 接下来就是一大段一段的Python的魔法方法了，Local Proxy重载了(几乎)?所有Python
    # 内建魔法方法，让所有的关于他自己的operations都指向到了_get_current_object()
    # 所返回的对象，也就是真正的被代理对象。

    ... ...
    __setattr__ = lambda x, n, v: setattr(x._get_current_object(), n, v)
    __delattr__ = lambda x, n: delattr(x._get_current_object(), n)
    __str__ = lambda x: str(x._get_current_object())
    __lt__ = lambda x, o: x._get_current_object() < o
    __le__ = lambda x, o: x._get_current_object() <= o
    __eq__ = lambda x, o: x._get_current_object() == o
    __ne__ = lambda x, o: x._get_current_object() != o
    __gt__ = lambda x, o: x._get_current_object() > o
    __ge__ = lambda x, o: x._get_current_object() >= o
    ... ...

def _lookup_req_object(name):
    top = _request_ctx_stack.top
    if top is None:
        raise RuntimeError('working outside of request context')
    return getattr(top, name)

# context locals
_request_ctx_stack = LocalStack()
request = LocalProxy(partial(_lookup_req_object, 'request'))

    def __init__(self):
        # 其实LocalStack主要还是用到了另外一个Local类
        # 它的一些关键的方法也被代理到了这个Local类上
        # 相对于Local类来说，它多实现了一些和堆栈“Stack”相关方法，比如push、pop之类
        # 所以，我们只要直接看Local代码就可以
        self._local = Local()

    ... ...

    @property
    def top(self):
        """
        返回堆栈顶部的对象
        """
        try:
            return self._local.stack[-1]
        except (AttributeError, IndexError):
            return None

# 所以，当我们调用_request_ctx_stack.top时，其实是调用了 _request_ctx_stack._local.stack[-1]
# 让我们来看看Local类是怎么实现的吧，不过在这之前我们得先看一下下面出现的get_ident方法

# 首先尝试着从greenlet导入getcurrent方法，这是因为如果flask跑在了像gevent这种容器下的时候
# 所以的请求都是以greenlet作为最小单位，而不是thread线程。
try:
    from greenlet import getcurrent as get_ident
except ImportError:
    try:
        from thread import get_ident
    except ImportError:
        from _thread import get_ident

# 总之，这个get_ident方法将会返回当前的协程/线程ID，这对于每一个请求都是唯一的

class Local(object):
    __slots__ = ('__storage__', '__ident_func__')

    def __init__(self):
        object.__setattr__(self, '__storage__', {})
        object.__setattr__(self, '__ident_func__', get_ident)

    ... ...

    # 问题的关键就在于Local类重载了__getattr__和__setattr__这两个魔法方法

    def __getattr__(self, name):
        try:
            # 在这里我们返回调用了self.__ident_func__()，也就是当前的唯一ID
            # 来作为__storage__的key
            return self.__storage__[self.__ident_func__()][name]
        except KeyError:
            raise AttributeError(name)

    def __setattr__(self, name, value):
        ident = self.__ident_func__()
        storage = self.__storage__
        try:
            storage[ident][name] = value
        except KeyError:
            storage[ident] = {name: value}

    ... ...

    # 重载了这两个魔法方法之后

    # Local().some_value 不再是它看上去那么简单了:
    # 首先我们先调用get_ident方法来获取当前运行的线程/协程ID
    # 然后获取这个ID空间下的some_value属性，就像这样：
    #
    #   Local().some_value -> Local()[current_thread_id()].some_value
    #
    # 设置属性的时候也是这个道理