像webpack一样直接热更新代码

0x01背景

在web开发中,我们一般会用一个develop server来启动本地开发环境,web框架一般会用watchdog或者pyinotify来监控文件系统,如果文件系统有任务变动(新建、编辑、删除、移动文件), 就会重启develop server, 然而,随着项目越来越大 , 每次重启develop server都会耗时2-3秒。而在webpack中，每当修改本地文件，都可以通过webpack直接热更新代码。

0x02思路

我的思路是每当有文件变动的时候，直接reload这个文件或者import这个变动的文件。下面对sanic框架开刀。

# main.py
import sys
import os
import time
from subprocess import Popen
from signal import SIGTERM

from watchdog.observers import Observer
from watchdog.events import PatternMatchingEventHandler
from importlib import import_module

import sanic
sys_modules = sys.modules


class LiveLoadingHandler(PatternMatchingEventHandler):
    def __init__(self, executable, args):
        super().__init__(patterns=['*.py'])
        self._args = (['python', 'src/test.py'])
        self._start()
        self._last_time = 0
        self._skip_time = 0.75

    def _start(self):
        proc = Popen(self._args)
        self.pid = proc.pid
        self._last_time = time.time()


    def on_modified(self, event):
        module = _find(event.src_path)
        if hasattr(module, '__spec__'):
            from importlib import reload
            reload(module)
            return
        self._reload()

def _find(path):
    try:
        return import_module(path)
    except (ImportError, TypeError):
        pass
    path = '.'.join(path.split('.')[:-1])
    if '.' in path:
        return _find(path)
    return path

def main():
    path = sys.argv[1] if len(sys.argv) > 1 else '.'
    observer = Observer()
    observer.schedule(LiveLoadingHandler(), path, recursive=True)
    observer.start()
    while True:
        try:
            time.sleep(0.6)
        except KeyboardInterrupt:
            os.kill(handler.pid, SIGTERM)
            time.sleep(0.6)
            observer.stop()
            break
    observer.join()



if __name__ == '__main__':
    main()

由于我们要执行的main.py文件，所以当main.py有变化的时候，并不能直接reload，我把views.py文件放到了src目录下来避免这个问题。

#src/views.py

import sanic
from sanic.response import json
app = sanic.Sanic()


@app.route("/")
async def test(request):
    return json({"hello": "world!"})

app.run()

0x03问题

当我试图修改我的views.py文件然后启动热更新的时候，并没有出现期望的直接热更新代码。由于在路由表中用的是字典来存放每条路由，而每条路径对应于一个视图函数，并且视图函数的id值是不一样的，当我们reload模块的时候，router中记录的函数还是之前的，所以我们需要重新reload router类。

def reload_router(router):
    for route, handler in router.routes_all .items:
        router.routes_all [route] = reimport(handler)

def reimport(handler):
    module = import_module(handler.__module__)
    return getattr(module, handler.__name__)