從源碼解析Python的Flask框架中request對象的用法
from flask import request
Flask 是一個人氣非常高的Python Web框架,筆者也拿它寫過一些大大小小的項目,F(xiàn)lask 有一個特性我非常的喜歡,就是無論在什么地方,如果你想要獲取當(dāng)前的request對象,只要 簡單的:
從當(dāng)前request獲取內(nèi)容:
- method: 起始行,元數(shù)據(jù)
- host: 起始行,元數(shù)據(jù)
- path: 起始行,元數(shù)據(jù)
- environ: 其中的 SERVER_PROTOCOL 是起始行,元數(shù)據(jù)
- headers: 頭,元數(shù)據(jù)
- data: body, 元數(shù)據(jù)
- remote_addr: 客戶端地址
- args: 請求鏈接中的參數(shù)(GET 參數(shù)),解析后
- form: form 提交中的參數(shù),解析后
- values: args 和 forms 的集合
- json: json 格式的 body 數(shù)據(jù),解析后
- cookies: 指向 Cookie 的鏈接
Request 對象對參數(shù)的分類很細,注意 args, form, valeus, json 的區(qū)別。當(dāng)然最保險也最原始的方式就是自己去解析 data。
另一個需注意的地方是某些屬性的類型,并不是 Python 標(biāo)準(zhǔn)的 dict ,而是 MultiDict 或者 CombinedMultiDict。這是為了應(yīng)對 HTTP 協(xié)議中參數(shù)都是可重復(fù)的這點而做的設(shè)定。因此取值的時候要注意這些對象的特性,比如 .get() 和 .get_list() 方法返回的東西是不同的。
非常簡單好記,用起來也非常的友好。不過,簡單的背后藏的實現(xiàn)可就稍微有一些復(fù)雜了。 跟隨我的文章來看看其中的奧秘吧!
兩個疑問?
在我們往下看之前,我們先提出兩個疑問:
疑問一 : request ,看上去只像是一個靜態(tài)的類實例,我們?yōu)槭裁纯梢灾苯邮褂胷equest.args 這樣的表達式來獲取當(dāng)前request的args屬性,而不用使用比如:
from flask import get_request # 獲取當(dāng)前request request = get_request() get_request().args
這樣的方式呢?flask是怎么把request對應(yīng)到當(dāng)前的請求對象的呢?
疑問二 : 在真正的生產(chǎn)環(huán)境中,同一個工作進程下面可能有很多個線程(又或者是協(xié)程), 就像我剛剛所說的,request這個類實例是怎么在這樣的環(huán)境下正常工作的呢?
要知道其中的秘密,我們只能從flask的源碼開始看了。
源碼,源碼,還是源碼
首先我們打開flask的源碼,從最開始的__init__.py來看看request是怎么出來的:
# File: flask/__init__.py from .globals import current_app, g, request, session, _request_ctx_stack # 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'))
我們可以看到flask的request是從globals.py引入的,而這里的定義request的代碼為 request = LocalProxy(partial(_lookup_req_object, 'request')) , 如果有不了解 partial是什么東西的同學(xué)需要先補下課,首先需要了解一下 partial 。
不過我們可以簡單的理解為 partial(func, 'request') 就是使用 'request' 作為func的第一個默認參數(shù)來產(chǎn)生另外一個function。
所以, partial(_lookup_req_object, 'request') 我們可以理解為:
生成一個callable的function,這個function主要是從 _request_ctx_stack 這個LocalStack對象獲取堆棧頂部的第一個RequestContext對象,然后返回這個對象的request屬性。
這個werkzeug下的LocalProxy引起了我們的注意,讓我們來看看它是什么吧:
@implements_bool class LocalProxy(object): """Acts as a proxy for a werkzeug local. Forwards all operations to a proxied object. The only operations not supported for forwarding are right handed operands and any kind of assignment. ... ...
看前幾句介紹就能知道它主要是做什么的了,顧名思義,LocalProxy主要是就一個Proxy, 一個為werkzeug的Local對象服務(wù)的代理。他把所以作用到自己的操作全部“轉(zhuǎn)發(fā)”到 它所代理的對象上去。
那么,這個Proxy通過Python是怎么實現(xiàn)的呢?答案就在源碼里:
# 為了方便說明,我對代碼進行了一些刪減和改動 @implements_bool class LocalProxy(object): __slots__ = ('__local', '__dict__', '__name__') def __init__(self, local, name=None): # 這里有一個點需要注意一下,通過了__setattr__方法,self的 # "_LocalProxy__local" 屬性被設(shè)置成了local,你可能會好奇 # 這個屬性名稱為什么這么奇怪,其實這是因為Python不支持真正的 # Private member,具體可以參見官方文檔: # http://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references # 在這里你只要把它當(dāng)做 self.__local = local 就可以了 :) object.__setattr__(self, '_LocalProxy__local', local) object.__setattr__(self, '__name__', name) def _get_current_object(self): """ 獲取當(dāng)前被代理的真正對象,一般情況下不會主動調(diào)用這個方法,除非你因為 某些性能原因需要獲取做這個被代理的真正對象,或者你需要把它用來另外的 地方。 """ # 這里主要是判斷代理的對象是不是一個werkzeug的Local對象,在我們分析request # 的過程中,不會用到這塊邏輯。 if not hasattr(self.__local, '__release_local__'): # 從LocalProxy(partial(_lookup_req_object, 'request'))看來 # 通過調(diào)用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 # 內(nèi)建魔法方法,讓所有的關(guān)于他自己的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 ... ...
事情到了這里,我們在文章開頭的第二個疑問就能夠得到解答了,我們之所以不需要使用get_request() 這樣的方法調(diào)用來獲取當(dāng)前的request對象,都是LocalProxy的功勞。
LocalProxy作為一個代理,通過自定義魔法方法。代理了我們對于request的所有操作, 使之指向到真正的request對象。
怎么樣,現(xiàn)在知道了 request.args 不是它看上去那么簡簡單單的吧。
現(xiàn)在,讓我們來看看第二個問題,在多線程的環(huán)境下,request是怎么正常工作的呢? 還是讓我們回到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'))
問題的關(guān)鍵就在于這個 _request_ctx_stack 對象了,讓我們找到LocalStack的源碼:
class LocalStack(object): def __init__(self): # 其實LocalStack主要還是用到了另外一個Local類 # 它的一些關(guān)鍵的方法也被代理到了這個Local類上 # 相對于Local類來說,它多實現(xiàn)了一些和堆?!癝tack”相關(guān)方法,比如push、pop之類 # 所以,我們只要直接看Local代碼就可以 self._local = Local() ... ... @property def top(self): """ 返回堆棧頂部的對象 """ try: return self._local.stack[-1] except (AttributeError, IndexError): return None # 所以,當(dāng)我們調(diào)用_request_ctx_stack.top時,其實是調(diào)用了 _request_ctx_stack._local.stack[-1] # 讓我們來看看Local類是怎么實現(xiàn)的吧,不過在這之前我們得先看一下下面出現(xiàn)的get_ident方法 # 首先嘗試著從greenlet導(dǎo)入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方法將會返回當(dāng)前的協(xié)程/線程ID,這對于每一個請求都是唯一的 class Local(object): __slots__ = ('__storage__', '__ident_func__') def __init__(self): object.__setattr__(self, '__storage__', {}) object.__setattr__(self, '__ident_func__', get_ident) ... ... # 問題的關(guān)鍵就在于Local類重載了__getattr__和__setattr__這兩個魔法方法 def __getattr__(self, name): try: # 在這里我們返回調(diào)用了self.__ident_func__(),也就是當(dāng)前的唯一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 不再是它看上去那么簡單了: # 首先我們先調(diào)用get_ident方法來獲取當(dāng)前運行的線程/協(xié)程ID # 然后獲取這個ID空間下的some_value屬性,就像這樣: # # Local().some_value -> Local()[current_thread_id()].some_value # # 設(shè)置屬性的時候也是這個道理
通過這些分析,相信疑問二也得到了解決,通過使用了當(dāng)前的線程/協(xié)程ID,加上重載一些魔法 方法,F(xiàn)lask實現(xiàn)了讓不同工作線程都使用了自己的那一份stack對象。這樣保證了request的正常 工作。
說到這里,這篇文章也差不多了。我們可以看到,為了使用者的方便,作為框架和工具的開發(fā)者 需要付出很多額外的工作,有時候,使用一些語言上的魔法是無法避免的,Python在這方面也有著 相當(dāng)不錯的支持。
我們所需要做到的就是,學(xué)習(xí)掌握好Python中那些魔法的部分,使用魔法來讓自己的代碼更簡潔, 使用更方便。
但是要記住,魔法雖然炫,千萬不要濫用哦。
相關(guān)文章
Python機器學(xué)習(xí)之K-Means聚類實現(xiàn)詳解
這篇文章主要為大家詳細介紹了Python機器學(xué)習(xí)之K-Means聚類的實現(xiàn),具有一定的參考價值,感興趣的小伙伴們可以參考一下2018-02-02手把手教你搭建python+selenium自動化環(huán)境(圖文)
本文主要介紹了手把手教你搭建python+selenium自動化環(huán)境,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06python使用tcp實現(xiàn)局域網(wǎng)內(nèi)文件傳輸
這篇文章主要介紹了python使用tcp實現(xiàn)局域網(wǎng)內(nèi)文件傳輸,文件包括文本,圖片,視頻等,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2018-07-07用Python監(jiān)控NASA TV直播畫面的實現(xiàn)步驟
本文分享一個名為"Spacestills"的開源程序,它可以用于查看 NASA TV 的直播畫面(靜止幀)2021-05-05python命令行解析之parse_known_args()函數(shù)和parse_args()使用區(qū)別介紹
這篇文章主要介紹了python命令行解析之parse_known_args()函數(shù)和parse_args()使用介紹,需要的朋友可以參考下2018-01-01Python發(fā)送網(wǎng)絡(luò)請求(requests)
這篇文章主要介紹了Python發(fā)送網(wǎng)絡(luò)請求(requests),具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-09-09