微信号:TechTalking

介绍:这可能是最接地气的技术分享公众号,我愿在这里与你们分享成长路上的点点滴滴. 关注各类Linux相关后端技术,关爱程序员的生活,与你分享我的思考. 技术·生活·思考

探究如何给Python程序做hotfix

2016-12-17 15:26 Tech

点击上方蓝色文字 “后端技术小黑屋” 关注微信公众号吧



使用Python来写服务器端程序,很大的一个优势就是可以进行热更新,即在不停机的情况下,使改动后的程序生效。在开发阶段,这个功能可以大大提高开发效率(写代码–启动服务器–看效果–改代码–hotfix–看效果–提交~);而在生产环境中,可以以最小的代价(不停机)修复线上的bug。


我在项目中使用hotfix功能很长时间了,大概了解它是利用了Python的import/reload功能,但是并没有去自己研究过。最近看了云风大大写的一篇文章:《如何让 lua 做尽量正确的热更新》,收获很多。也觉得应该研究一下Python的hotfix机制,毕竟是跟了自己这么久的小伙伴嘛。  


import


说到hotfix就要从import语句说起。

首先建立这样一个简单的文件用作测试。


from __future__ import print_function

class RefreshClass(object):
   def __init__(self):
       self.value = 1

   def print_info(self):
       print('RefreshClass value: {} ver1.0'.format(self.value))

version = 1.0
 
print(version)


下面启动一个python解释器。


>>> import test_refresh as tr
1.0
>>> import test_refresh as tr
>>>> # edit  version=2.0
>>> import test_refresh as tr
>>> tr.version
1.0


重新import一个已经import过的模块,并不会重新执行文件(第二个import之后没有输出)。后面修改源文件并重新import后,对内存中tr.version的检查也验证了这一点。


为了能够重新加载修改后的源文件,我们需要明确的告诉Python解释器这一点。在Python中,sys.modules保存了已经加载过的模块。所以


>>> del sys.modules['test_refresh']
>>> import test_refresh as tr
2.0
>>> tr.version
2.0


在将test_refresh从sys.modules中删除之后再进行import操作,就会重新加载源文件了。


另外,如果我们只能拿到模块的字符串名字,可以使用__import__函数。


# edit version=3.0
>>> del sys.modules['test_refresh']
>>> tr = __import__('test_refresh')
3.0
>>> tr.version
3.0


reload


当我们面对的是一个之前已经import过的模块时,可以直接使用reload进行重新加载。


初步尝试hotfix


知道了模块重新加载的方法后,我们在Python的交互式命令行中,尝试动态改变一个类的行为逻辑。


from __future__ import print_function

class RefreshClass(object):
   def __init__(self):
       self.value = 1

   def print_info(self):
       print('RefreshClass value: {} ver1.0'.format(self.value))


这是测试类的当前状态。


我们创建一个该类的对象,验证下它的行为。


>>> a = tr.RefreshClass()
>>> a.value
1
>>> a.print_info()
RefreshClass value: 1 ver1.0


符合预期。


接下来,修改类的print_info函数为ver2.0,并reload模块。


# edit print_info ver2.0
>>> reload(tr)
4.0
<module 'test_refresh' from 'test_refresh.py'>
>>> a.value
1
>>> a.print_info()
RefreshClass value: 1 ver1.0


输出并没有如预期一样输出ver2.0……


那我们重新创建一个对象试试。


>>> b = tr.RefreshClass()
>>> b.value
2
>>> b.print_info()
RefreshClass value: 2 ver2.0


新对象b的行为是符合重新加载后的逻辑的。这说明,reload确实更新了RefreshClass类的行为,但是对于已经实例化的RefreshClass类的对象,却没有进行更新。对象a中的行为还是指向了旧的RefreshClass类。


在Python中,一切皆是对象。不仅实例a是对象,a的类RefreshClass也是对象。


这时,要修改a的行为,就需要用到a的__class__属性,来强制使a的类行为指向重新加载后的RefreshClass对象。


>>> a.__class__ = tr.RefreshClass
>>> a.value
1
>>> a.print_info()
RefreshClass value: 1 ver2.0


由于value是绑定在实例a上的,所以它的值并不会随RefreshClass的改变而改变。这也符合hotfix的预期逻辑:更新内存中实例的行为逻辑,但是不更新它们的数据。


接下来,我们还可以通过print_info函数的im_func属性,验证在更改了__class__属性后,函数确实更新成了新版本。


# edit print_info ver3.0
>>> reload(tr)
4.0
<module 'test_refresh' from 'test_refresh.py'>
>>> a.print_info.im_func
<function print_info at 0x7f50beeb2c08>
>>> c = tr.RefreshClass()
>>> c.print_info()
RefreshClass value: 3 ver3.0
>>> c.print_info.im_func
<function print_info at 0x7f50beeb2cf8>
>>> a.__class__ = tr.RefreshClass
>>> a.print_info.im_func
<function print_info at 0x7f50beeb2cf8>
>>> a.print_info()
RefreshClass value: 1 ver3.0


触发hotfix


上面的操作都是在Python的交互式解释器中运行的。下面我们将尝试使一个运行中的Python程序进行热更新。


这里遇到一个问题:作为Python程序入口的那个文件,不是以module的形式存在的,因此不能用上面的方式进行hotfix。所以我们需要保持入口文件的尽量简洁,而将绝大多数的逻辑功能交给其他的模块执行。


要触发一个正在运行中的Python程序进行热更新,我们需要有一种方式和Python程序通信。直接使用OS的标识文件是一个简单易行的方法。


from __future__ import print_function

import os
import time
import refresh_class


rc = refresh_class.RefreshClass()
while True:
   if os.path.exists('refresh.signal'):
       reload(refresh_class)
       rc.__class__ = refresh_class.RefreshClass
   time.sleep(5)
   rc.print_info()


class RefreshClass(object):
   def __init__(self):
       self.value = 1

   def print_info(self):
       print('RefreshClass value: {} ver1.0'.format(self.value))


每次我们修改完refresh_class.py文件,就创建一个refresh.signal文件。当refresh执行完毕,删除此文件即可。


这种做法一般来讲,会导致多次重新加载(因为一般不能及时的删除refresh.signal文件)。


所以,我们考虑使用Linux下的信号量,来同Python程序通信。


from __future__ import print_function

import time
import signal

import refresh_class

rc = refresh_class.RefreshClass()


def handl_refresh(signum, frame):
   reload(refresh_class)
   rc.__class__ = refresh_class.RefreshClass


signal.signal(signal.SIGUSR1, handl_refresh)
while True:
   time.sleep(5)
   rc.print_info()


我们在Python中注册了信号量SIGUSR1的handler,在其中热更新RefreshClass。


那么只需在另一个terminal中,输入:


kill -SIGUSR1 pid  


即可向pid进程发送信号量SIGUSR1。


当然,还有其他方法可以触发hotfix,比如使用PIPE,或者直接开一个socket监听,自己设计消息格式来触发hotfix。


总结


以上进行Python热更新的方式,原理简单明了,就是利用了Python提供的import/reload机制。但是这种方式,需要去替换每一个类的实例的__class__成员。这就往往需要在某处保存目前内存中存在的所有对象(或者能够索引到所有活动对象的根对象),并且在类的设计上,需要所有类的基类提供一个通用的refresh方法,在其中进行__class__的替换工作。对于复杂的类组合方式,这种方法比较容易在热更新的时候漏掉某些实例。


其实还有一种途径可以代替__class__的替换工作。我们知道,如果不替换__class__的话,即使我们重新加载进来了新的module,但是所有的__class__还将指向旧的module的class。那么,我们不妨将新的module的内容插入到旧的module中。这样我们就可以不用费劲去更新每一个__class__了。一般的,我们会利用import hook(sys.meta_path,详见PEP302)来实现这个替换。当然,这种方法的实现细节较多(因为module中可能存在module,class,function等互相嵌套的情况),不过只要实现完整后,就是一劳永逸的事情了。



题图: Comfreak

授权基于: CC0协议

欢迎扫描下方二维码,关注我的微信公众号,技术·生活·思考:


 
后端技术小黑屋 更多文章 Python最差实践 ghub:一个基于grpc的rpc&nbsp;hub ghub:一个基于grpc的rpc hub 国庆在贵州的思考 grpc:google官方的rpc框架
猜您喜欢 坑系列 --- 时间和空间的平衡 Hadoop启动报Error: JAVA_HOME is not set and could not be found解决办法 2015-2016前端架构体系技术精简版 大数据时代快速SQL引擎-Impala Android开发的前景到底怎么样?