django的autoreload機(jī)制實(shí)現(xiàn)
在開發(fā)django應(yīng)用的過程中,使用開發(fā)者模式啟動(dòng)服務(wù)是特別方便的一件事,只需要 python manage.py runserver 就可以運(yùn)行服務(wù),并且提供了非常人性化的autoreload機(jī)制,不需要手動(dòng)重啟程序就可以修改代碼并看到反饋。
源碼分析:
runserver命令
命令行鍵入 python manage.py runserver 后,django會(huì)去尋找runserver這個(gè)命令的執(zhí)行模塊,最后落在 django\contrib\staticfiles\management\commands\runserver.py模塊上:
def run(self, **options): """ Runs the server, using the autoreloader if needed """ use_reloader = options['use_reloader'] if use_reloader: autoreload.main(self.inner_run, None, options) else: self.inner_run(None, **options)
autoreload模塊??碼utoreload.main():
django\utils\autoreload.py:
這里有關(guān)于use_reloader的判斷。如果我們在啟動(dòng)命令中沒有加--noreload,程序就會(huì)走autoreload.main這個(gè)函數(shù),如果加了,就會(huì)走self.inner_run,直接啟動(dòng)應(yīng)用。 其實(shí)從autoreload.main的參數(shù)也可以看出,它應(yīng)該是對self.inner_run做了一些封裝,autoreload的機(jī)制就在這些封裝當(dāng)中,下面我們繼續(xù)跟。
def main(main_func, args=None, kwargs=None): if args is None: args = () if kwargs is None: kwargs = {} if sys.platform.startswith('java'): reloader = jython_reloader else: reloader = python_reloader wrapped_main_func = check_errors(main_func) reloader(wrapped_main_func, args, kwargs)
這里針對jpython和其他python做了區(qū)別處理,先忽略jpython;check_errors就是把對main_func進(jìn)行錯(cuò)誤處理,也先忽略。看python_reloader:
def python_reloader(main_func, args, kwargs): if os.environ.get("RUN_MAIN") == "true": thread.start_new_thread(main_func, args, kwargs) try: reloader_thread() except KeyboardInterrupt: pass else: try: exit_code = restart_with_reloader() if exit_code < 0: os.kill(os.getpid(), -exit_code) else: sys.exit(exit_code) except KeyboardInterrupt: pass
第一次走到這里時(shí)候,環(huán)境變量中RUN_MAIN變量不是"true", 甚至都沒有,所以走else, 看restart_with_reloader:
#django\utils\autoreload.py: def restart_with_reloader(): while True: args = [sys.executable] + ['-W%s' % o for o in sys.warnoptions] + sys.argv if sys.platform == "win32": args = ['"%s"' % arg for arg in args] new_environ = os.environ.copy() new_environ["RUN_MAIN"] = 'true' exit_code = os.spawnve(os.P_WAIT, sys.executable, args, new_environ) if exit_code != 3: return exit_code
這里首先起一個(gè)while循環(huán), 內(nèi)部先把RUN_MAIN改成了"true",然后用os.spawnve方法開一個(gè)子進(jìn)程(subprocess), 其實(shí)就是再調(diào)一遍命令行,又走了一遍 python manage.py runserver。
接著看restart_with_reloader里的while循環(huán),需要注意的是while循環(huán)退出的唯一條件是exit_code!=3。 如果子進(jìn)程不退出,就一直停在 os.spawnve這一步; 如果子進(jìn)程退出,而退出碼不是3,while就被終結(jié)了;如果是3,繼續(xù)循環(huán),重新創(chuàng)建子進(jìn)程。從這個(gè)邏輯可以猜想autoreload的機(jī)制:當(dāng)前進(jìn)程(主進(jìn)程)其實(shí)啥也不干,就監(jiān)視子進(jìn)程的運(yùn)行狀況,子進(jìn)程才是真正干事兒的;如果子進(jìn)程以exit_code=3退出(應(yīng)該由于檢測到了文件修改),就再啟動(dòng)一遍子進(jìn)程,新代碼自然就生效了;如果子進(jìn)程以exit_code!=3退出,主進(jìn)程也結(jié)束,整個(gè)django程序就算跪了。這只是猜想,下面接著來驗(yàn)證。
子進(jìn)程。上面其實(shí)有一個(gè)疑問,既然是重新啟動(dòng)了一次,為什么子進(jìn)程不會(huì)接著生成子進(jìn)程?原因就在于RUN_MAIN這個(gè)環(huán)境變量,主進(jìn)程中把它改成了true,子進(jìn)程走到python_reloader函數(shù)的時(shí)候:
#django\utils\autoreload.py: def python_reloader(main_func, args, kwargs): if os.environ.get("RUN_MAIN") == "true": thread.start_new_thread(main_func, args, kwargs) try: reloader_thread() except KeyboardInterrupt: pass else: try: exit_code = restart_with_reloader() if exit_code < 0: os.kill(os.getpid(), -exit_code) else: sys.exit(exit_code) except KeyboardInterrupt: pass
if條件滿足了,和主進(jìn)程走了不一樣的邏輯分支。在這里,首先去開一個(gè)線程,運(yùn)行main_func,就是上文的 Command.inner_run。這里的thread模塊是這么import的:
然后再開一個(gè)reloader_thread:
def reloader_thread(): ensure_echo_on() if USE_INOTIFY: fn = inotify_code_changed else: fn = code_changed while RUN_RELOADER: change = fn() if change == FILE_MODIFIED: sys.exit(3) # force reload elif change == I18N_MODIFIED: reset_translations() time.sleep(1)
ensure_echo_on()其實(shí)還沒看明白,貌似是針對類unix系統(tǒng)文件處理的,先略過; USE_INOTIFY也是系統(tǒng)文件操作相關(guān)的變量,根據(jù) inotify 是否可用選擇檢測文件變化的方法。 while循環(huán),每隔1秒檢測一下文件狀態(tài),如果是普通文件有變化,進(jìn)程退出,退出碼為3,主進(jìn)程一看:退出碼是3,就重啟子進(jìn)程。。。。這樣就和上面連上了;如果不是普通文件變化,而是I18N_MODIFIED(.mo后綴的文件變化,二進(jìn)制庫文件之類的),那就 reset_translations ,大概意思是把已加載過的庫緩存清理掉,下次重新加載。
以上就是autoreload機(jī)制的流程。其中還是有些細(xì)節(jié)不是特別清楚,比如不同操作系統(tǒng)文件變化的檢測,但都是很細(xì)節(jié)的東西了,不涉及主流程。看完這些,我又問了自己一遍,如果是讓我設(shè)計(jì)autoreload機(jī)制會(huì)怎樣搞?,F(xiàn)在我的答案是:直接把 django\utils\autoreload.py 文件拿來用啊。其實(shí)這是很獨(dú)立的一個(gè)模塊,而且特別通用,完全可以作為通用的autoreload解決方案。
到此這篇關(guān)于django的autoreload機(jī)制實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)django autoreload內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
python實(shí)現(xiàn)圖書館研習(xí)室自動(dòng)預(yù)約功能
這篇文章主要為大家詳細(xì)介紹了python實(shí)現(xiàn)圖書館研習(xí)室自動(dòng)預(yù)約功能,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-04-04解決Python下json.loads()中文字符出錯(cuò)的問題
今天小編就為大家分享一篇解決Python下json.loads()中文字符出錯(cuò)的問題,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-12-12Python3 pip3 list 出現(xiàn) DEPRECATION 警告的解決方法
今天小編就為大家分享一篇Python3 pip3 list 出現(xiàn) DEPRECATION 警告的解決方法,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2019-02-02詳細(xì)解讀Python中解析XML數(shù)據(jù)的方法
這篇文章主要介紹了Python中解析XML數(shù)據(jù)的方法,是Python入門學(xué)習(xí)中的基礎(chǔ)知識(shí),需要的朋友可以參考下2015-10-10Python標(biāo)準(zhǔn)庫datetime之datetime模塊用法分析詳解
這篇文章主要介紹了Python標(biāo)準(zhǔn)庫datetime之datetime模塊用法分析詳解,文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的小伙伴可以參考一下2022-07-07