Merge pull request #10266 from Carreau/ipython-ext-dir

Carreau · web-flow · commit cf7e3a387e7a · 2017-02-17T12:39:41.000-08:00
Warn about IPython extension dir
diff --git a/IPython/core/extensions.py b/IPython/core/extensions.py
@@ -5,12 +5,14 @@
 # Distributed under the terms of the Modified BSD License.
 
 import os
+import os.path
+import warnings
 from shutil import copyfile
 import sys
 from importlib import import_module
 
 from traitlets.config.configurable import Configurable
-from IPython.utils.path import ensure_dir_exists
+from IPython.utils.path import ensure_dir_exists, compress_user
 from traitlets import Instance
 
 try:
@@ -75,13 +77,18 @@ def load_extension(self, module_str):
         """
         if module_str in self.loaded:
             return "already loaded"
-        
+
         from IPython.utils.syspathcontext import prepended_to_syspath
-        
+
         with self.shell.builtin_trap:
             if module_str not in sys.modules:
                 with prepended_to_syspath(self.ipython_extension_dir):
-                    import_module(module_str)
+                    mod = import_module(module_str)
+                    if mod.__file__.startswith(self.ipython_extension_dir):
+                        print(("Loading extensions from {dir} is deprecated. "
+                               "We recommend managing extensions like any "
+                               "other Python packages, in site-packages.").format(
+                              dir=compress_user(self.ipython_extension_dir)))
             mod = sys.modules[module_str]
             if self._call_load_ipython_extension(mod):
                 self.loaded.add(module_str)
@@ -168,3 +175,5 @@ def install_extension(self, url, filename=None):
         filename = os.path.join(self.ipython_extension_dir, filename)
         copy(url, filename)
         return filename
+
+
diff --git a/docs/source/whatsnew/pr/pending-deprecation-ipython-extension.rst b/docs/source/whatsnew/pr/pending-deprecation-ipython-extension.rst
@@ -0,0 +1,5 @@
+Loading extensions from ``ipython_extension_dir`` print a warning that this location is pending
+deprecation. This should only affect users still having extensions installed with ``%install_ext``
+which has been deprecated since IPython 4.0, and removed in 5.0. extensions still present in
+``ipython_extension_dir`` may shadow more recently installed versions using pip. It is thus
+recommended to clean ``ipython_extension_dir`` of any extension now available as a package.
