django的autoreload机制实现


Posted in Python onJune 03, 2020

在开发django应用的过程中,使用开发者模式启动服务是特别方便的一件事,只需要 python manage.py runserver 就可以运行服务,并且提供了非常人性化的autoreload机制,不需要手动重启程序就可以修改代码并看到反馈。

源码分析:

runserver命令

命令行键入 python manage.py runserver 后,django会去寻找runserver这个命令的执行模块,最后落在 django\contrib\staticfiles\management\commands\runserver.py模块上:

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模块。看autoreload.main():

django\utils\autoreload.py:

这里有关于use_reloader的判断。如果我们在启动命令中没有加--noreload,程序就会走autoreload.main这个函数,如果加了,就会走self.inner_run,直接启动应用。 其实从autoreload.main的参数也可以看出,它应该是对self.inner_run做了一些封装,autoreload的机制就在这些封装当中,下面我们继续跟。

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)

这里针对jpython和其他python做了区别处理,先忽略jpython;check_errors就是把对main_func进行错误处理,也先忽略。看python_reloader:

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), 其实就是再调一遍命令行,又走了一遍 python manage.py runserver。

接着看restart_with_reloader里的while循环,需要注意的是while循环退出的唯一条件是exit_code!=3。 如果子进程不退出,就一直停在 os.spawnve这一步; 如果子进程退出,而退出码不是3,while就被终结了;如果是3,继续循环,重新创建子进程。从这个逻辑可以猜想autoreload的机制:当前进程(主进程)其实啥也不干,就监视子进程的运行状况,子进程才是真正干事儿的;如果子进程以exit_code=3退出(应该由于检测到了文件修改),就再启动一遍子进程,新代码自然就生效了;如果子进程以exit_code!=3退出,主进程也结束,整个django程序就算跪了。这只是猜想,下面接着来验证。

子进程。上面其实有一个疑问,既然是重新启动了一次,为什么子进程不会接着生成子进程?原因就在于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

if条件满足了,和主进程走了不一样的逻辑分支。在这里,首先去开一个线程,运行main_func,就是上文的 Command.inner_run。这里的thread模块是这么import的:

然后再开一个reloader_thread:

def reloader_thread():
 ensure_echo_on()
 if USE_INOTIFY:
  fn = inotify_code_changed
 else:
  fn = code_changed
 while RUN_RELOADER:
  change = fn()
  if change == FILE_MODIFIED:
   sys.exit(3) # force reload
  elif change == I18N_MODIFIED:
   reset_translations()
  time.sleep(1)

ensure_echo_on()其实还没看明白,貌似是针对类unix系统文件处理的,先略过; USE_INOTIFY也是系统文件操作相关的变量,根据 inotify 是否可用选择检测文件变化的方法。 while循环,每隔1秒检测一下文件状态,如果是普通文件有变化,进程退出,退出码为3,主进程一看:退出码是3,就重启子进程。。。。这样就和上面连上了;如果不是普通文件变化,而是I18N_MODIFIED(.mo后缀的文件变化,二进制库文件之类的),那就 reset_translations ,大概意思是把已加载过的库缓存清理掉,下次重新加载。

以上就是autoreload机制的流程。其中还是有些细节不是特别清楚,比如不同操作系统文件变化的检测,但都是很细节的东西了,不涉及主流程。看完这些,我又问了自己一遍,如果是让我设计autoreload机制会怎样搞。现在我的答案是:直接把 django\utils\autoreload.py 文件拿来用啊。其实这是很独立的一个模块,而且特别通用,完全可以作为通用的autoreload解决方案。

到此这篇关于django的autoreload机制实现的文章就介绍到这了,更多相关django autoreload内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
python修改注册表终止360进程实例
Oct 13 Python
Python实现八大排序算法
Aug 13 Python
Flask框架的学习指南之开发环境搭建
Nov 20 Python
一个Python最简单的接口自动化框架
Jan 02 Python
Python爬虫实现抓取京东店铺信息及下载图片功能示例
Aug 07 Python
Pycharm以root权限运行脚本的方法
Jan 19 Python
python实现对象列表根据某个属性排序的方法详解
Jun 11 Python
python选取特定列 pandas iloc,loc,icol的使用详解(列切片及行切片)
Aug 06 Python
python selenium实现发送带附件的邮件代码实例
Dec 10 Python
python3实现网页版raspberry pi(树莓派)小车控制
Feb 12 Python
基于matplotlib xticks用法详解
Apr 16 Python
Python Opencv轮廓常用操作代码实例解析
Sep 01 Python
浅谈python量化 双均线策略(金叉死叉)
Jun 03 #Python
Django用户登录与注册系统的实现示例
Jun 03 #Python
python 瀑布线指标编写实例
Jun 03 #Python
Django微信小程序后台开发教程的实现
Jun 03 #Python
python判断正负数方式
Jun 03 #Python
Python绘制动态水球图过程详解
Jun 03 #Python
解决numpy矩阵相减出现的负值自动转正值的问题
Jun 03 #Python
You might like
PHP和JAVA中的重载(overload)和覆盖(override) 介绍
2012/03/01 PHP
php引用地址改变变量值的问题
2012/03/23 PHP
Yii快速入门经典教程
2015/12/28 PHP
PHP6连接SQLServer2005的三部曲
2016/04/15 PHP
php事务回滚简单实现方法示例
2017/03/28 PHP
php检测mysql表是否存在的方法小结
2017/07/20 PHP
PHP耦合设计模式实例分析
2018/08/08 PHP
php往mysql中批量插入数据实例教程
2018/12/12 PHP
在html中引入外部js文件,并调用带参函数的方法
2016/10/31 Javascript
利用jQuery来动态为属性添加或者删除属性的简单方法
2016/12/02 Javascript
详解Vue2 无限级分类(添加,删除,修改)
2017/03/07 Javascript
JavaScript new对象的四个过程实例浅析
2018/07/31 Javascript
jQuery实现的3D版图片轮播示例【滑动轮播】
2019/01/18 jQuery
教你搭建按需加载的Vue组件库(小结)
2019/07/29 Javascript
JavaScript基于用户照片姓名生成海报
2020/05/29 Javascript
JS数组及对象遍历方法代码汇总
2020/06/16 Javascript
Vue 实现拨打电话操作
2020/11/16 Javascript
JavaScript async/await原理及实例解析
2020/12/02 Javascript
[00:43]TI7不朽珍藏III——幽鬼不朽展示
2017/07/15 DOTA
Python判断操作系统类型代码分享
2014/11/22 Python
Pandas之MultiIndex对象的示例详解
2019/06/25 Python
Python Socketserver实现FTP文件上传下载代码实例
2020/03/27 Python
Python过滤掉numpy.array中非nan数据实例
2020/06/08 Python
keras使用Sequence类调用大规模数据集进行训练的实现
2020/06/22 Python
CSS3中伪元素::before和::after的用法示例
2017/09/18 HTML / CSS
The North Face官方旗舰店:美国著名户外品牌
2020/09/28 全球购物
大学生水文观测实习自我鉴定
2013/09/29 职场文书
行政管理毕业生自荐信
2014/02/24 职场文书
求职信范文大全
2014/05/26 职场文书
个人总结与自我评价
2014/09/18 职场文书
2014年班主任工作总结
2014/11/08 职场文书
升学宴答谢词
2015/01/05 职场文书
晶体管单管来复再生式收音机
2021/04/22 无线电
原生JS中应该禁止出现的写法
2021/05/05 Javascript
vue3获取当前路由地址
2022/02/18 Vue.js
Python数据处理的三个实用技巧分享
2022/04/01 Python