简单实现热加载python交互模式（利用文件修改时间和 python模块重载）

左手的ㄟ右手 2023-07-18 09:11 11阅读 0赞

最近写公司 项目的时候碰到一个问题，公司使用flask，在自测单个模块下的函数会用到flask自带的shell调试，但是这个shell有一个问题就是无发热加载，每次修改了文件，就要退出重新进入，然后在输入from ..... import .... 然后开始执行函数，效率极其低下，还让人有点恼火，所以我就想写一个可以热加载的shell，提高一下效率，因为时间比较短，所以比较简陋，不过目前能满足我的需求

import sys, os, importlib, readline, traceback
    """
    importlib.reload 重载模块
    readline 这个模块必须有，因为接收输入并保存在内存
    """
    
    def iteration_module_files():
        # 获取环境
        # 筛选内置模块和一些项目外的模块
        for module in sys.modules.values():
            filename = getattr(module, '__file__', None)
            if filename:
                # 减少判断只检测本目录下的模块
                if not os.getcwd() in filename:
                    continue
                if filename[-4:] in ('.pyo', '.pyc'):
                    filename = filename[:-1]
                # 将模块也带过去，因为后面需要重载被修改文件的模块
                yield (filename, module)
    
    def is_files_modify(mtimes, module_list):
        # 检测模块文件是否修改
        for filename, module in iteration_module_files():
            try:
                # 文件修改时间
                mtime = os.stat(filename).st_mtime
            except IOError:
                continue
            # 从dict中根据文件名取出上一次文件修改时间
            old_time = mtimes.get(filename, None)
            # 如果没有上一次的修改时间，加入dict
            if old_time is None:
                mtimes[filename] = mtime
            # 对比修改时间
            elif mtime > old_time:
                # 将修改了时间的模块加入列表
                module_list.add(module)
                # 如果不把新的时间赋值给文件，那么会一直进入重载
                mtimes[filename] = mtime
        return module_list
    
    def file_detector():
        # 添加文件修改时间
        mtimes = {}
        # 添加模块
        module_list = set()
        # 输出信息
        cprt = 'Type "help", "copyright", "credits" or "license" for more information.'
        sys.stderr.write("* Python * %s on %s\n%s\n" %
                   (sys.version, sys.platform, cprt))
        # 死循环检测文件是否修改
        while 1:
            is_files_modify(mtimes, module_list)
            # 如果有文件修改，就重载修改过的模块
            if module_list:
                for module in module_list:
                    importlib.reload(module)
                    # 记得清空模块列表
                    module_list = set()
    
            # 执行语句
            try:
                exec(input('=>'))
            except KeyboardInterrupt as k:
                print('  Ctrl+C')
                return
            except Exception as e:
                print(traceback.print_exc())
    
    def runs():
        file_detector()
    
    if __name__ == '__main__':
        # 导入项目的入口模块
        __import__('test')
        # print(sys.modules.keys())
        runs()
    
    """
    思路：不停检测模块文件的修改时间，如果文件修改就重新加载该模块
    
    用法：
    文件 test.py
    这个程序中导入test
    __import__('test')
    
    终端中：
    import test
    test.demo()
    结果：
     1111
    
     修改文件，终端：
     import test
    test.demo()
    结果：
     1111222
    
    退出：
     输入 exit()
     或者
     Ctrl+C
    
     缺点：
     只支持单行python语句，需要print打印信息
    
     这里还有一个缺点就是，如果通过from... import ...的形式调用摸一个函数或者类，
     修改了该文件以后必须用import...形式导入修改过的文件模块，重新加载，
     因为直接用from... import ...形式没有重载这个模块文件的话调用的是缓存中的模块数据，
     不过因为这里有输入缓存区，所以可以每次开始先用import...再用from...import...，
     每次直接上下键选择即可，不需要太多额外输入
    
    目前在公司项目中使用还可以，但是有时候会碰到一些服务项目中用到os.path.abspath(".")当路径，
    所以要这个程序与入口程序在同级目录下
    """