add ShimWarning for shimmed imports

makes it easier to catch/suppress warnings about shim imports

still shown by default (not a DeprecationWarning)

IPython/utils/tests/test_shimmodule.py

@@ -0,0 +1,15 b''
+import sys
+import warnings
+
+import nose.tools as nt
+
+from IPython.utils.capture import capture_output
+from IPython.utils.shimmodule import ShimWarning
+
+def test_shim_warning():
+    sys.modules.pop('IPython.config', None)
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        import IPython.config
+    assert len(w) == 1
+    assert issubclass(w[-1].category, ShimWarning)

IPython/config.py

@@ -1,18 +1,19 b''
 """
 Shim to maintain backwards compatibility with old IPython.config imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import sys
 from warnings import warn
 
+from IPython.utils.shimmodule import ShimModule, ShimWarning
+
 warn("The `IPython.config` package has been deprecated. "
-     "You should import from traitlets.config instead.")
+     "You should import from traitlets.config instead.", ShimWarning)
 
-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.config'] = ShimModule(src='IPython.config', mirror='traitlets.config')

IPython/frontend.py

@@ -1,29 +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.
 
 import sys
 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, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The top-level `frontend` package has been deprecated. "
+     "All its subpackages have been moved to the top `IPython` level.", ShimWarning)
 
 # 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(
     src='IPython.frontend.html.notebook', mirror='IPython.html')
 sys.modules['IPython.frontend'] = ShimModule(
     src='IPython.frontend', mirror='IPython')

IPython/html.py

@@ -1,28 +1,28 b''
 """
 Shim to maintain backwards compatibility with old IPython.html imports.
 """
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import sys
 from warnings import warn
 
+from IPython.utils.shimmodule import ShimModule, ShimWarning
+
 warn("The `IPython.html` package has been deprecated. "
      "You should import from `notebook` instead. "
-     "`IPython.html.widgets` has moved to `ipywidgets`.")
-
-from IPython.utils.shimmodule import ShimModule
+     "`IPython.html.widgets` has moved to `ipywidgets`.", ShimWarning)
 
 _widgets = sys.modules['IPython.html.widgets'] = ShimModule(
     src='IPython.html.widgets', mirror='ipywidgets')
 
 _html = ShimModule(
     src='IPython.html', mirror='notebook')
 
 # hook up widgets
 _html.widgets = _widgets
 sys.modules['IPython.html'] = _html
 
 if __name__ == '__main__':
     from notebook import notebookapp as app
     app.launch_new_instance()

IPython/kernel/__init__.py

@@ -1,35 +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 ipykernel or jupyter_client instead.")
+from IPython.utils.shimmodule import ShimModule, ShimWarning
 
+warn("The `IPython.kernel` package has been deprecated. "
+     "You should import from ipykernel or jupyter_client instead.", ShimWarning)
 
-from IPython.utils.shimmodule import ShimModule
 
 # zmq subdir is gone
 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='ipykernel')
 
 for pkg in ('comm', 'inprocess'):
     src = 'IPython.kernel.%s' % pkg
     sys.modules[src] = ShimModule(src=src, mirror='ipykernel.%s' % pkg)
 
 for pkg in ('ioloop', 'blocking'):
     src = 'IPython.kernel.%s' % pkg
     sys.modules[src] = ShimModule(src=src, mirror='jupyter_client.%s' % pkg)
 
 # required for `from IPython.kernel import PKG`
 from ipykernel import comm, inprocess
 from jupyter_client import ioloop, blocking
 # public API
 from ipykernel.connect import *
 from jupyter_client import *

IPython/nbconvert.py

@@ -1,19 +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.
 
 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, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The `IPython.nbconvert` package has been deprecated. "
+     "You should import from ipython_nbconvert instead.", ShimWarning)
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
 sys.modules['IPython.nbconvert'] = ShimModule(
     src='IPython.nbconvert', mirror='nbconvert')

IPython/nbformat.py

@@ -1,19 +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.
 
 import sys
 from warnings import warn
 
-warn("The `IPython.nbformat` package has been deprecated. "
-     "You should import from nbformat instead.")
+from IPython.utils.shimmodule import ShimModule, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The `IPython.nbformat` package has been deprecated. "
+     "You should import from nbformat instead.", ShimWarning)
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
 sys.modules['IPython.nbformat'] = ShimModule(
     src='IPython.nbformat', mirror='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.
 
 import sys
 from warnings import warn
 
-warn("The `IPython.parallel` package has been deprecated. "
-     "You should import from ipyparallel instead.")
+from IPython.utils.shimmodule import ShimModule, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The `IPython.parallel` package has been deprecated. "
+     "You should import from ipyparallel instead.", ShimWarning)
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
 sys.modules['IPython.parallel'] = ShimModule(
     src='IPython.parallel', mirror='ipyparallel')
 

IPython/qt.py

@@ -1,24 +1,24 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.
 
 import sys
 from warnings import warn
 
-warn("The `IPython.qt` package has been deprecated. "
-     "You should import from qtconsole instead.")
+from IPython.utils.shimmodule import ShimModule, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The `IPython.qt` package has been deprecated. "
+     "You should import from qtconsole instead.", ShimWarning)
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
 _console = sys.modules['IPython.qt.console'] = ShimModule(
     src='IPython.qt.console', mirror='qtconsole')
 
 _qt = ShimModule(src='IPython.qt', mirror='qtconsole')
 
 _qt.console = _console
 sys.modules['IPython.qt'] = _qt

IPython/terminal/console.py

@@ -1,21 +1,19 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, ShimWarning
 
-from IPython.utils.shimmodule import ShimModule
+warn("The `IPython.terminal.console` package has been deprecated. "
+     "You should import from jupyter_console instead.", ShimWarning)
 
 # Unconditionally insert the shim into sys.modules so that further import calls
 # trigger the custom attribute access above
 
 sys.modules['IPython.terminal.console'] = ShimModule(
     src='IPython.terminal.console', mirror='jupyter_console')

IPython/utils/shimmodule.py

@@ -1,90 +1,92 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 ShimWarning(Warning):
+    """A warning to show when a module has moved, and a shim is in its place."""
 
 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 __dir__(self):
         return dir(__import__(self._mirror))
     
     @property
     def __all__(self):
         """Ensure __all__ is always defined"""
         mod = __import__(self._mirror)
         try:
             return mod.__all__
         except AttributeError:
             return [name for name in dir(mod) if not name.startswith('_')]
 
     def __getattr__(self, key):
         # Use the equivalent of import_item(name), see below
         name = "%s.%s" % (self._mirror, key)
         try:
             return import_item(name)
         except ImportError:
             raise AttributeError(key)