Reloading submodules in IPython

Question

Currently I am working on a python project that contains sub modules and uses numpy scipy  Ipython is used as interactive console  Unfortunately I am not very happy with workflow that I am using right now  I would appreciate some advice   In IPython  the framework is loaded by a simple import command  However  it is often necessary to change code in one of the submodules of the framework  At this point a model is already loaded and I use IPython to interact with it    Now  the framework contains many modules that depend on each other  i e  when the framework is initially loaded the main module is importing and configuring the submodules   The changes to the code are only executed if the module is reloaded using reload main mod sub mod   This is cumbersome as I need to reload all changed modules individually using the full path  It would be very convenient if reload main module  would also reload all sub modules  but without reloading numpy scipy

User · Answer

In IPython 0 12  and possibly earlier   you can use this    load ext autoreload  autoreload 2   This is essentially the same as the answer by pv   except that the extension has been renamed and is now loaded using  load ext

User · Answer

I hate to add yet another answer to a long thread  but I found a solution that enables recursive reloading of submodules on  run   that others might find useful  I have anyway  del the submodule you wish to reload on run from sys modules in iPython  In 1   from sys import modules In 2   del modules  quot mymodule mysubmodule quot     tab completion can be used like mymodule  lt tab gt    Now your script will recursively reload this submodule  In 3    run myscript py

User · Answer

Any subobjects will not be reloaded by this  I believe you have to use IPython s deepreload for that

User · Answer

http   shawnleezx github io blog 2015 08 03 some-notes-on-ipython-startup-script   To avoid typing those magic function again and again  they could be put in the ipython startup script Name it with  py suffix under  ipython profile default startup  All python scripts under that folder will be loaded according to lexical order   which looks like the following   from IPython import get ipython ipython   get ipython    ipython magic  pylab   ipython magic  load ext autoreload   ipython magic  autoreload 2

User · Answer

How about this   import inspect    needs to be primed with an empty set for loaded def recursively reload all submodules module  loaded None       for name in dir module           member   getattr module  name          if inspect ismodule member  and member not in loaded              recursively reload all submodules member  loaded      loaded add module      reload module   import mymodule recursively reload all submodules mymodule  set      This should effectively reload the entire tree of modules and submodules you give it  You can also put this function in your  ipythonrc  I think  so it is loaded every time you start the interpreter

User · Answer

IPython comes with some automatic reloading magic    load ext autoreload  autoreload 2   It will reload all changed modules every time before executing a new line  The way this works is slightly different than dreload  Some caveats apply  type  autoreload  to see what can go wrong     If you want to always enable this settings  modify your IPython configuration file    ipython profile default ipython config py 1  and appending   c InteractiveShellApp extensions     autoreload        c InteractiveShellApp exec lines      autoreload 2     Credit to  Kos via a comment below    1  If you don t have the file    ipython profile default ipython config py  you need to call ipython profile create first  Or the file may be located at  IPYTHONDIR

User · Answer

My standard practice for reloading is to combine both methods following first opening of IPython   from IPython lib deepreload import reload  load ext autoreload  autoreload 2   Loading modules before doing this will cause them not to be reloaded  even with a manual reload module name   I still  very rarely  get inexplicable problems with class methods not reloading that I ve not yet looked into

User · Answer

Module named importlib allow to access to import internals  Especially  it provide function importlib reload     import importlib importlib reload my module    In contrary of  autoreload  importlib reload   also reset global variables set in module  In most cases  it is what you want   importlib is only available since Python 3 1  For older version  you have to use module imp

User · Answer

Another option     cat  lt  lt  EOF  gt     ipython profile default startup 50-autoreload ipy  load ext autoreload  autoreload 2 EOF   Verified on ipython and ipython3 v5 1 0 on Ubuntu 14 04

User · Answer

On Jupyter Notebooks on Anaconda  doing this    load ext autoreload  autoreload 2   produced the message      The autoreload extension is already loaded  To reload it  use       reload ext autoreload   It looks like it s preferable to do    reload ext autoreload  autoreload 2   Version information       The version of the notebook server is 5 0 0 and is running on    Python 3 6 2  Anaconda  Inc    default  Sep 20 2017  13 35 58   MSC v 1900 32 bit  Intel

User · Answer

IPython offers dreload   to recursively reload all submodules   Personally  I prefer to use the  run   magic command  though it does not perform a deep reload  as pointed out by John Salvatier in the comments

User · Answer

Note that the above mentioned autoreload only works in IntelliJ if you manually save the changed file  e g  using ctrl s or cmd s   It doesn t seem to work with auto-saving

User · Answer

For some reason  neither  autoreload  nor dreload seem to work for the situation when you import code from one notebook to another  Only plain Python reload works   reload module    Based on  1

[python] Reloading submodules in IPython

Examples related to python

Examples related to ipython