在開發django應用的過程中,使用開發者模式啟動服務是特別方便的一件事,只需要python manage.py runserver 就可以運行服務,並且提供了非常人性化的autoreload機制,不需要手動重啟程式就可以修改程式碼並看到回饋。剛接觸的時候覺得這個功能比較人性化,也沒覺得是什麼特別高大上的技術。後來有空就想著如果是我來實現這個autoreload會怎麼做,想了很久沒想明白,總有些地方理不清楚,看來第一反應真是眼高手低了。於是就特別花了一些時間研究了django是怎麼實現autoreload的,每一步都看源碼說話,不允許有絲毫的想當然:
1、runserver指令。在進入正題之前其實有一大段廢話,是關於runserver指令如何執行的,跟主題關係不大,就簡單帶一下:
指令列鍵入python manage.py runserver 後,django會去尋找runserver這個指令的執行模組,最後落在
django\contrib\staticfiles\management\commands\runserver.py模組上:
#django\contrib\staticfiles\management\commands\runserver.pyfrom django.core.management.commands.runserver import \ Command as RunserverCommandclass Command(RunserverCommand): help = "Starts a lightweight Web server for development and also serves static files."
#django\core\management\commands\runserver.pyclass Command(BaseCommand): 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.main的參數也可以看出,它應該是對self.inner_run做了一些封裝,autoreload的機制就在這些封裝當中,下面我們繼續跟著。
PS: 看原始碼的時候發現django的command模式還是實現的很漂亮的,值得學習。
#django\utils\autoreload.py: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)
#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
#第一次走到這裡時候,環境變數中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
這裡首先起一個while循環, 內部先把RUN_MAIN改成了"true",然後用os.spawnve方法開一個子程序(subprocess),看看os.spawnve的說明:
_spawnvef(mode, file, args, env, execve)
3、子行程。上面其實有一個疑問,既然是重新啟動了一次,為什麼子行程不會接著生成子進程?原因就在於RUN_MAIN這個環境變量,主進程中把它改成了true,子進程走到python_reloader函數的時候:
#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
#django\utils\autoreload.py:from django.utils.six.moves import _thread as thread
#這裡six模組的作用是相容於各種python版本:
[codeblock six]#django\utils\six.pyclass _SixMetaPathImporter(object):"""A meta path importer to import six.moves and its submodules. This class implements a PEP302 finder and loader. It should be compatible with Python 2.5 and all existing versions of Python3"""官网说明:# https://pythonhosted.org/six/Six: Python 2 and 3 Compatibility Library Six provides simple utilities for wrapping over differences between Python 2 and Python 3. It is intended to support codebases that work on both Python 2 and 3 without modification. six consists of only one Python file, so it is painless to copy into a project.
=== change ==3) change ==1)
以上就是autoreload機制的流程。其中還是有些細節不是特別清楚,例如不同作業系統檔案變化的偵測,但都是很細節的東西了,不涉及主流程。看完這些,我又問了自己一遍,如果是讓我設計autoreload機制會怎麼搞。現在我的答案是:直接把 django\utils\autoreload.py 檔案拿來用啊。其實這是很獨立的模組,而且特別通用,完全可以當作通用的autoreload解決方案,我還自己寫個毛啊。
以上是django開發者模式中的autoreload是怎麼達成的的詳細內容。更多資訊請關注PHP中文網其他相關文章!