Python热更新详解

reload函数

原生imp.relaod函数:

  • 模块代码将重新编译,模块级别的代码被重新执行,init函数将不再次执行
  • 在Python中一切皆为对象,包括函数、变量等,模块中的函数、变量等全部包含在模块字典中,即module_dict,reload方法执行后module_dict中的keys对应的values为新的对象。
  • 所有reload之前旧的对象在引用计数为0时被回收。

这就意味着imp.reload在使用过程中有很多问题,比如:

  1. 不支持from xxx import xxx形式导入的重新加载
  2. 只支持拓展模块的重新加载,sys、__main__等内置模块不能使用。我们最好不要重新加载除拓展模块外的其他模块。
  3. reload某个模块,该模块的依赖模块不能自动reload,且只能先reload依赖的模块
  4. 所有引用旧的对象的变量不会更换引用新的对象。重新加载类,其已实例化对象引用的方法不会变化,继续使用旧类的定义,对于派生类的对象同样如此。

reloader模块

这个库为Python实现了一个基于依赖关系的模块重载器。不像前面imp.reload函数,此重载程序将重新加载请求的模块和依赖于该模块的所有其他模块。对reload函数的问题进行了一定程度上的改进。

需要注意的是,reloader最终还是会调用imp.reload函数来进行reload。

主要分为三个重要步骤:

  • 记录模块之间的依赖
  • 重新加载模块
  • 自定义重新重新加载函数

reloader模块提供了enable、disable、get_dependencies、reload四个接口,应用时调用enable就开始记录模块之间的依赖,使用reload便开始按依赖顺序加载模块。

记录依赖

通过建立模块之间的加载依赖图,可以实现正确的重新加载顺序。
实现的逻辑是通过重载全局的imprt hook函数(__import__)来实现。当需要热更新时,保存原始的__import__函数。当热更新时,我们重新import的行为,记为函数_import,递归调用_import导入模块并将此模块加入其父模块的依赖列表,即可构建模块依赖图。热更新后,恢复原有的__import__函数。

实例代码如下:

import builtins

_baseimport = builtins.__import__
_dependencies = dict()
_parent = None

def _import(name, globals=None, locals=None, fromlist=None, level=-1):
    # Track our current parent module.  This is used to find our current
    # place in the dependency graph.
    global _parent
    parent = _parent
    _parent = name

    # Perform the actual import using the base import function.
    m = _baseimport(name, globals, locals, fromlist, level)

    # If we have a parent (i.e. this is a nested import) and this is a
    # reloadable (source-based) module, we append ourself to our parent's
    # dependency list.
    if parent is not None and hasattr(m, '__file__'):
        l = _dependencies.setdefault(parent, [])
        l.append(m)

    # Lastly, we always restore our global _parent pointer.
    _parent = parent

    return m

builtins.__import__ = _import

重载模块

递归遍历需要重新加载的模块,这是一个典型的递归调用,visited集合是为了重复导入模块。示例代码如下:

import imp

def _reload(m, visited):
    """Internal module reloading routine."""
    name = m.__name__

    # Start by adding this module to our set of visited modules.  We use
    # this set to avoid running into infinite recursion while walking the
    # module dependency graph.
    visited.add(m)

    # Start by reloading all of our dependencies in reverse order.  Note
    # that we recursively call ourself to perform the nested reloads.
    deps = _dependencies.get(name, None)
    if deps is not None:
        for dep in reversed(deps):
            if dep not in visited:
                _reload(dep, visited)

    # Clear this module's list of dependencies.  Some import statements
    # may have been removed.  We'll rebuild the dependency list as part
    # of the reload operation below.
    try:
        del _dependencies[name]
    except KeyError:
        pass

    # Because we're triggering a reload and not an import, the module
    # itself won't run through our _import hook.  In order for this
    # module's dependencies (which will pass through the _import hook) to
    # be associated with this module, we need to set our parent pointer
    # beforehand.
    global _parent
    _parent = name

    # Perform the reload operation.
    imp.reload(m)

    # Reset our parent pointer.
    _parent = None

def reload(m):
    """Reload an existing module.

    Any known dependencies of the module will also be reloaded."""
    _reload(m, set())

自定义__reload__函数

我们可以在模块中自定义__reload__,用于进行数据处理。

def _deepcopy_module_dict(m):
    """Make a deep copy of a module's dictionary."""
    import copy

    # We can't deepcopy() everything in the module's dictionary because
    # some items, such as '__builtins__', aren't deepcopy()-able.
    # To work around that, we start by making a shallow copy of the
    # dictionary, giving us a way to remove keys before performing the
    # deep copy.
    d = vars(m).copy()
    del d['__builtins__']
    return copy.deepcopy(d)

# If the module has a __reload__(d) function, we'll call it with a
# copy of the original module's dictionary after it's been reloaded.
callback = getattr(m, '__reload__', None)
if callback is not None:
    d = _deepcopy_module_dict(m)
    imp.reload(m)
    callback(d)
else:
    imp.reload(m)

reloader黑名单

可以使用blacklist参数来设置reload的黑名单:
reloader.enable(blacklist=['os', 'ConfigParser'])

reloader的问题

只解决了imp.reload的模块依赖顺序问题,但是问题1/2/4依旧未解决。在需要reload的模块中自定义__reload__虽然可以解决问题4,但是自己写__reload__显然比较麻烦且容易出错,于是有了下面优化方案。

热更新优化

函数和方法的更新

该方案可以解决imp.reload的问题3和问题4,这种方案本质是对reload后对老代码的模块/对象引用的方法更新到新代码,而变量的值不变。

需要到两个知识点:

  • 一个是使用到Python探针技术sys.meta_path,使得可以在import时自定义做点什么事
  • 第二个是使用到了imp.load_module(name, file, pathname, description),加载模块, 如果模块已经被加载, 等同于reload()。

单个函数更新逻辑:把老的function的func_code、func_doc、func_dict、func_defaults引用新function的属性

更新流程:

  • 先对sys.modules遍历,找到有代码改动或者新增的modules
  • 对modules进行import,然后通过sys.meta_path机制,对每个module进行后面操作
  • 如果是新加的module,直接return,否则进行后面操作
  • 通过inspect.getmembers(module)找到module所有的function和type类型的对象。
  • 对于module的function类型对象,如果有新增function就直接add到老模块中,对已有的function,使用函数更新逻辑更新。
  • 对于module的type类型的,对type对象引用的function进行增删改,变量不变。

优点:

  • 无论这些function/class以什么方式引用,只要不深入直接引用到func_code/func_default对象,均可动态更新到;
  • 有代码改动的模块都会更新一遍,不用考虑模块依赖问题。

缺点:

  • 不能动态更新class的派生关系相关的信息

新对象替换旧对象

module被热更新后,找出所有对module中的class/function...有引用的对象,逐个执行新对象替换旧对象的操作。

这个方案实现起来相对简单,但是运行效率过低,一般不做考虑。

其它

  • 在热更新期间可以暂停gc
  • 配表数据就不仅仅是更新函数,还要更新数据

虽然使用函数和方法的更新的热更新方法基本能满足需求,但是reload终究会让系统卡一段时间,还有优化方案是不要代码自动判断需要更新哪些模块,而是通过指令来指定。但是哪怕这样也还是会有一小段卡顿时间,后面会讲一下另一个热更新方案,可以解决卡顿问题。

引用

Python imp.reload
pypi/reloader
Reloading Python Modules
Python探针技术
python之imp模块

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容

  • 介绍: 热更新,就是在维持服务不间断的情况下,对软件代码逻辑或配置数据进行更新修复。随着游戏项目引入了脚本语言以后...
    人在广州_2017阅读 3,302评论 1 4
  • 一、模块 1、模块和导入 当程序代码量变得相当大、逻辑结构变得非常复杂的时候,我们最好把代码按照逻辑和功能划分成一...
    常大鹏阅读 2,899评论 0 9
  • Python系列技巧文章,主要用力强化Python变成技巧。 一、通识 1、Python中一个python文件就是...
    杨强AT南京阅读 453评论 0 0
  • 正式开坑分享python啦~ 从最开头讲起吧,说一下python里导入一个模块的逻辑 文章目录 概念明确 三种模块...
    Woko阅读 1,336评论 1 2
  • Python基础知识_0001 1.0 Python是一种怎样的语言 Python是一门跨平台、开源、免费的解释型...
    爱学习的小白F1阅读 1,007评论 0 1