摘要：主要的作用是將維護(hù)的字典中鍵為對應(yīng)的值定義為。如果沒有，則會將當(dāng)前到中，同時將加入列表中否則添加。注意清理之后的動作。上述代碼涉及到，它強(qiáng)調(diào)必須是一個可調(diào)用對象。后期的工作之一是了解。這僅僅是我的個人理解。實(shí)際上這是解決多個實(shí)例運(yùn)行的問題。

知乎問題 編程中什么是「Context(上下文)」 已經(jīng)能夠簡單地說明什么是 Context，它是一個程序需要的外部對象，類似于一個全局變量。而這個變量的值會根據(jù)提供的值而改變。

Flask 中有分為請求上下文和應(yīng)用上下文：

Flask 分發(fā)請求之前激活程序請求上下文，請求處理完成后再將其刪除。

Flask 中的 Context 是通過棧來實(shí)現(xiàn)。

Flask 的核心功能依賴于 Werkzeug 庫。

這兩種棧定義在 flask/global.py 中。

_request_ctx_stack = LocalStack()
_app_ctx_stack = LocalStack()

首先需要了解一下 Werkzeug 中關(guān)于 LcoalStack 的相關(guān)內(nèi)容。

Local 類

Local 是定義了一個 __storage__ 字典，其中的鍵為 thread 的 id 值。

class Local(object):
    __slots__ = ("__storage__", "__ident_func__")
    
    def __init__(self):
        object.__setattr__(self, "__storage__", {})
        object.__setattr__(self, "__ident_func__", get_ident)
        
    def __setattr__(self, name, value):
        ident  = self.__ident_func__()
        storage = self.__storage__
        try:
            storage[ident][name] = value
        except KeyError:
            raise AttributeError(name)
    ...

LocalStack 類

LocalStack 則內(nèi)部維護(hù)一個 Local 實(shí)例。主要的作用是將 Local 維護(hù)的 __storage__ 字典中鍵為 __ident_func__() 對應(yīng)的值定義為 {"stack" : [] }。

class LocalStack(object):
    def __init__(self):
        self._local = Local()
        
    def push(self, obj):
        rv = getattr(self._local, "stack", None)
        if rv is None:
            self._local.stack = rv = []
        rv.append(obj)
        return rv
        
    def pop(self, obj):
        pass

LocalProxy 類

LocalProxy類是一個代理類，應(yīng)用到設(shè)計(jì)模式當(dāng)中的代理模式。簡單地講，我們不需要去了解當(dāng)前的環(huán)境，而直接去操作這個 Proxy 類，這個 Proxy 類會將所有的操作反饋給正確的對象。

class LocalProxy(object):
    __slots__ = ("__local", "__dict__", "__name__")
    def __init__(self, local, name=None):
        object.__setattr__(self, "_LocalProxy__local", local)
        object.__setattr__(self, "__name__", name)
    
    def _get_current_object(self):
        # 通過此方法獲取被代理的對象
        if not hasattr(self.__local, "__release_local__")
            return self.__local
        try:
            return gerattr(self.__local,self.__name__)
        except Attribute:
            raise RuntimeError("no object bound to %s" % self.__name__)
    ...
    # 其他操作

Flask 源碼中關(guān)于 request 的定義：

def _lookup_req_object(name):
    top = _request_ctx_stack.top
    if top is None:
        raise RuntimeError(_request_ctx_err_msg)
    return getattr(top, name)
    
request = LocalProxy(partial(_lookup_req_object, "request"))

從源碼可以看出，request 是 _request_ctx_stack 棧頂元素的一個屬性。實(shí)際上 _request_ctx_stack 棧中的元素是 ReuqestContext 對象的實(shí)例， 而 ReuqestContext 中包含了 request 請求的所有信息,包括 Session 信息。

class ReuqestContext(object):
    def __init__(self, app, environ, request=None):
        if reuqest is None:
            request  = Request(environ)
        self.requst = request
        self.app = app 
        self.session = None
        ...
        # 這個列表包含了與 request 相關(guān)聯(lián)的 Application
        self._implicit_app_ctx_stack = []
        self.match_request()

    def push(self, object):
        """
        這里需要實(shí)現(xiàn)的是：當(dāng) RequestContext push 到
        _request_ctx_stack 時， 需要檢測是否有對應(yīng)的
        AppContext。如果沒有，則會將當(dāng)前 self.app push
        到 AppContext 中，同時將self.app 加入
        _implicit_app_ctx_stack 列表中； 否則
        _implicit_app_ctx_stack 添加 None。
        """
        pass
        
    def pop(self):
        """
        當(dāng) ReuqestContext 彈出 _request_ctx_stack 的
        方法。注意：request 清理之后的動作。如執(zhí)行
        teardown_request。
        """
        pass

這里傳入的 app，就是 Flask 的程序?qū)嵗?
RequestContext 實(shí)例的創(chuàng)建在 Flask 類方法中。

class Flask(_PackageBoundObject):
    ...
    request_class = ReuqestContext
    def wsgi_app(self, environ, start_response):
        ctx = self.request_class(environ)
        ctx.push
        ...
        
    def __call__(self, environ, start_response):
        return self.wsgi_app(environ, start_response)

Flask 中 Request 對象繼承了 Werkzeug 中的 Request 對象。
上述代碼涉及到 WSGI，它強(qiáng)調(diào) Appication 必須是一個可調(diào)用對象。
后期的工作之一是了解 WSGI。

在 session.py 文件中定義了 有關(guān)Session的內(nèi)容。Flask 中 Session 是構(gòu)建在 Cookie 上面的。其中定義了關(guān)于 Session 的接口。

class SessionMixin(object):
    """定義了Session的最小屬性"""
    
class SecureCookieSession(CallDict, SessionMixin):
    """ CallDict 是 werkzeug 中的數(shù)據(jù)結(jié)構(gòu) """

class NullSession(SecureCookieSession):
    """ 定義了空 session 結(jié)構(gòu) """
    
class SessionInterface(object):
    """ 定義了 Session接口的屬性，依賴于 app.config 
    中的信息。同時，規(guī)定了只要是繼承SessionInterface
    必須實(shí)現(xiàn) open_session 和 save_session 方法
    """
class SecureCookieSessionInterface(SessionInterface):
    """ 
    主要是實(shí)現(xiàn)了 open_session 和 save_session 方法
    """

如下代碼則是 session 的應(yīng)用。

# flask/app.py
class Flask(_PackageBoundObject):
    session_interface = SecureCookieSessionInterface()
    def open_session(self, request):
        return self.session_interface.open_session(self, request)
        
    def save_session(self, session, response)
        return self.session_interface.save_session(
            self, session, response)
            
    def process_response(self, response):
        ctx = _request_ctx_stack.top
        ...
        if not self.session_interface.is_null_session(ctx.session):
            self.save_session(ctx.session, response)

#ReuqestContext
class ReuqestContext():
    def push(self, object):
        ...
        self.session = self.app.open_session(self.reuqest)
        if self.session is None:
            self.session = self.app.make_null_session()
        ...

session 是 RequestContext 中屬性，所以代理說明如下：

session = LocalProxy(partial(_lookup_req_object,"session")

一般來講， 在 Flask Web 開發(fā)時， Flask的實(shí)例是延遲創(chuàng)建的。也就是說 AppContext還沒有壓入 _app_ctx_stack 中，所以我們在編寫代碼時，是無法獲取完整的 Flask 實(shí)例的屬性。而當(dāng)用戶訪問時，程序的實(shí)例已經(jīng)初始化完成了，因此我們采用 current_app代理獲取當(dāng)前 app。這僅僅是我的個人理解。實(shí)際上這是解決 多個 Flask 實(shí)例運(yùn)行的問題。

current_app是獲取 _app_ctx_stack 棧頂 AppContext實(shí)例元素的代理.

def _find_app():
    top = _app_ctx_stack.top
    if top is None:
        raise RuntimeError(_app_ctx_err_msg)
    return top.app
current_app = LocalProxy(_find_app)

flask.g 是存儲一下資源信息的，如數(shù)據(jù)庫連接信息。更多應(yīng)用的則是體現(xiàn)在 Flask 擴(kuò)展當(dāng)中。

def _lookup_app_object(name):
    top = _app_ctx_stack.top
    if top is None:
        raise RuntimeError(_app_ctx_err_msg)
        return getattr(top,name)
g = LocalProxy(partical(_lookup_app_object, "g"))

# flask.app.py
class Flask(_PackageBoundObject):
    app_ctx_globals_class = _AppCtxGlobals #實(shí)現(xiàn)的是類似字典的功能

# AppContext
class AppContext(object):
    def __init__(self, app):
        self.g = self.app.app_ctx_globals_class()

#RequestContext
class RequestContext(object):
    #定義與request相關(guān)的 g 變量
    def _get_g(self):
        return _app_ctx_stack.top.g
    def _set_g(self, value):
        _app_ctx_stack.top.g = value
    g = property(_get_g, _set_g)
    del _get_g, _set_g   

上述代碼存在一個疑問是 g 對象是基于請求的，每次請求都會重置。那么 g 為什么不是 RequestContext 而是 AppContext ?
flask.g API 文檔 中說明了 g 變量的改動。

個人博客