Merge pull request #8186 from minrk/shim-import-hook

add import hook to shims

IPython/frontend.py

@@ -1,31 +1,29 b''
 """
 Shim to maintain backwards compatibility with old frontend imports.
 
 We have moved all contents of the old `frontend` subpackage into top-level
 subpackages (`html`, `qt` and `terminal`), and flattened the notebook into
 just `IPython.html`, formerly `IPython.frontend.html.notebook`.
 
 This will let code that was making `from IPython.frontend...` calls continue
 working, though a warning will be printed.
 """
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from __future__ import print_function
-
-# Stdlib
 import sys
-import types
 from warnings import warn
 
 warn("The top-level `frontend` package has been deprecated. "
      "All its subpackages have been moved to the top `IPython` level.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.frontend.html.notebook'] = ShimModule('notebook', mirror='IPython.html')
-sys.modules['IPython.frontend'] = ShimModule('frontend', mirror='IPython')
+sys.modules['IPython.frontend.html.notebook'] = ShimModule(
+    src='IPython.frontend.html.notebook', mirror='IPython.html')
+sys.modules['IPython.frontend'] = ShimModule(
+    src='IPython.frontend', mirror='IPython')

IPython/kernel/__init__.py

@@ -1,31 +1,35 b''
 """
 Shim to maintain backwards compatibility with old IPython.kernel imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import sys
 from warnings import warn
 
 warn("The `IPython.kernel` package has been deprecated. "
      "You should import from ipython_kernel or jupyter_client instead.")
 
 
 from IPython.utils.shimmodule import ShimModule
 
 # zmq subdir is gone
-sys.modules['IPython.kernel.zmq.session'] = ShimModule('session', mirror='jupyter_client.session')
-sys.modules['IPython.kernel.zmq'] = ShimModule('zmq', mirror='ipython_kernel')
+sys.modules['IPython.kernel.zmq.session'] = ShimModule(
+    src='IPython.kernel.zmq.session', mirror='jupyter_client.session')
+sys.modules['IPython.kernel.zmq'] = ShimModule(
+    src='IPython.kernel.zmq', mirror='ipython_kernel')
 
 for pkg in ('comm', 'inprocess'):
-    sys.modules['IPython.kernel.%s' % pkg] = ShimModule(pkg, mirror='ipython_kernel.%s' % pkg)
+    src = 'IPython.kernel.%s' % pkg
+    sys.modules[src] = ShimModule(src=src, mirror='ipython_kernel.%s' % pkg)
 
 for pkg in ('ioloop', 'blocking'):
-    sys.modules['IPython.kernel.%s' % pkg] = ShimModule(pkg, mirror='jupyter_client.%s' % pkg)
+    src = 'IPython.kernel.%s' % pkg
+    sys.modules[src] = ShimModule(src=src, mirror='jupyter_client.%s' % pkg)
 
 # required for `from IPython.kernel import PKG`
 from ipython_kernel import comm, inprocess
 from jupyter_client import ioloop, blocking
 # public API
 from ipython_kernel.connect import *
 from jupyter_client import *

IPython/nbconvert.py

@@ -1,20 +1,19 b''
 """
 Shim to maintain backwards compatibility with old IPython.nbconvert imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from __future__ import print_function
-
 import sys
 from warnings import warn
 
 warn("The `IPython.nbconvert` package has been deprecated. "
      "You should import from ipython_nbconvert instead.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.nbconvert'] = ShimModule('nbconvert', mirror='jupyter_nbconvert')
+sys.modules['IPython.nbconvert'] = ShimModule(
+    src='IPython.nbconvert', mirror='jupyter_nbconvert')

IPython/nbformat.py

@@ -1,22 +1,19 b''
 """
 Shim to maintain backwards compatibility with old IPython.nbformat imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from __future__ import print_function
-
-# Stdlib
 import sys
-import types
 from warnings import warn
 
 warn("The `IPython.nbformat` package has been deprecated. "
      "You should import from jupyter_nbformat instead.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.nbformat'] = ShimModule('nbformat', mirror='jupyter_nbformat')
+sys.modules['IPython.nbformat'] = ShimModule(
+    src='IPython.nbformat', mirror='jupyter_nbformat')

IPython/parallel.py

@@ -1,20 +1,20 b''
 """
 Shim to maintain backwards compatibility with old IPython.parallel imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from __future__ import print_function
-
 import sys
 from warnings import warn
 
 warn("The `IPython.parallel` package has been deprecated. "
      "You should import from ipython_parallel instead.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.parallel'] = ShimModule('parallel', mirror='ipython_parallel')
+sys.modules['IPython.parallel'] = ShimModule(
+    src='IPython.parallel', mirror='ipython_parallel')
+

IPython/qt.py

@@ -1,22 +1,18 b''
 """
 Shim to maintain backwards compatibility with old IPython.qt imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from __future__ import print_function
-
-# Stdlib
 import sys
-import types
 from warnings import warn
 
 warn("The `IPython.qt` package has been deprecated. "
      "You should import from jupyter_qtconsole instead.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.qt'] = ShimModule('qt', mirror='jupyter_qtconsole')
+sys.modules['IPython.qt'] = ShimModule(src='IPython.qt', mirror='jupyter_qtconsole')

IPython/terminal/console.py

@@ -1,20 +1,21 b''
 """
 Shim to maintain backwards compatibility with old IPython.terminal.console imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 from __future__ import print_function
 
 import sys
 from warnings import warn
 
 warn("The `IPython.terminal.console` package has been deprecated. "
      "You should import from jupyter_console instead.")
 
 from IPython.utils.shimmodule import ShimModule
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
-sys.modules['IPython.terminal.console'] = ShimModule('console', mirror='jupyter_console')
+sys.modules['IPython.terminal.console'] = ShimModule(
+    src='IPython.terminal.console', mirror='jupyter_console')

IPython/utils/shimmodule.py

@@ -1,44 +1,78 b''
 """A shim module for deprecated imports
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
+import sys
 import types
 
+from .importstring import import_item
+
+
+class ShimImporter(object):
+    """Import hook for a shim.
+    
+    This ensures that submodule imports return the real target module,
+    not a clone that will confuse `is` and `isinstance` checks.
+    """
+    def __init__(self, src, mirror):
+        self.src = src
+        self.mirror = mirror
+    
+    def _mirror_name(self, fullname):
+        """get the name of the mirrored module"""
+        
+        return self.mirror + fullname[len(self.src):]
+
+    def find_module(self, fullname, path=None):
+        """Return self if we should be used to import the module."""
+        if fullname.startswith(self.src + '.'):
+            mirror_name = self._mirror_name(fullname)
+            try:
+                mod = import_item(mirror_name)
+            except ImportError:
+                return
+            else:
+                if not isinstance(mod, types.ModuleType):
+                    # not a module
+                    return None
+                return self
+
+    def load_module(self, fullname):
+        """Import the mirrored module, and insert it into sys.modules"""
+        mirror_name = self._mirror_name(fullname)
+        mod = import_item(mirror_name)
+        sys.modules[fullname] = mod
+        return mod
+
+
 class ShimModule(types.ModuleType):
 
     def __init__(self, *args, **kwargs):
         self._mirror = kwargs.pop("mirror")
+        src = kwargs.pop("src", None)
+        if src:
+            kwargs['name'] = src.rsplit('.', 1)[-1]
         super(ShimModule, self).__init__(*args, **kwargs)
+        # add import hook for descendent modules
+        if src:
+            sys.meta_path.append(
+                ShimImporter(src=src, mirror=self._mirror)
+            )
+    
+    @property
+    def __path__(self):
+        return []
 
     @property
     def __spec__(self):
         """Don't produce __spec__ until requested"""
         return __import__(self._mirror).__spec__
 
     def __getattr__(self, key):
         # Use the equivalent of import_item(name), see below
         name = "%s.%s" % (self._mirror, key)
-
-        # NOTE: the code below was copied *verbatim* from
-        # importstring.import_item. For some very strange reason that makes no
-        # sense to me, if we call it *as a function*, it doesn't work.  This
-        # has something to do with the deep bowels of the import machinery and
-        # I couldn't find a way to make the code work as a standard function
-        # call.  But at least since it's an unmodified copy of import_item,
-        # which is used extensively and has a test suite, we can be reasonably
-        # confident this is OK.  If anyone finds how to call the function, all
-        # the below could be replaced simply with:
-        #
-        # from IPython.utils.importstring import import_item
-        # return import_item('MIRROR.' + key)
-
-        parts = name.rsplit('.', 1)
-        if len(parts) == 2:
-            # called with 'foo.bar....'
-            package, obj = parts
-            module = __import__(package, fromlist=[obj])
-            return getattr(module, obj)
-        else:
-            # called with un-dotted string
-            return __import__(parts[0])
+        try:
+            return import_item(name)
+        except ImportError:
+            raise AttributeError(key)