Merge pull request #3286 from minrk/get_ipython

minrk · minrk · commit b82bef4a43c5 · 2013-05-20T09:36:51.000-07:00
don't use `get_ipython` from builtins in library code

mainly adds IPython.get_ipython() as a library-level handle that does the same thing.
diff --git a/IPython/__init__.py b/IPython/__init__.py
@@ -41,6 +41,7 @@
 #-----------------------------------------------------------------------------
 
 from .config.loader import Config
+from .core.getipython import get_ipython
 from .core import release
 from .core.application import Application
 from .frontend.terminal.embed import embed
diff --git a/IPython/core/completerlib.py b/IPython/core/completerlib.py
@@ -33,7 +33,7 @@
 from IPython.utils._process_common import arg_split
 
 # FIXME: this should be pulled in with the right call via the component system
-from IPython.core.ipapi import get as get_ipython
+from IPython import get_ipython
 
 #-----------------------------------------------------------------------------
 # Globals and constants
diff --git a/IPython/core/debugger.py b/IPython/core/debugger.py
@@ -31,8 +31,8 @@
 import linecache
 import sys
 
+from IPython import get_ipython
 from IPython.utils import PyColorize, ulinecache
-from IPython.core import ipapi
 from IPython.utils import coloransi, io, py3compat
 from IPython.core.excolors import exception_colors
 
@@ -113,9 +113,8 @@ def __init__(self,colors=None):
         from the Python standard library for usage details.
         """
 
-        try:
-            ip = get_ipython()
-        except NameError:
+        ip = get_ipython()
+        if ip is None:
             # Outside of ipython, we set our own exception hook manually
             sys.excepthook = functools.partial(BdbQuit_excepthook,
                                                excepthook=sys.excepthook)
@@ -205,7 +204,7 @@ def __init__(self,color_scheme='NoColor',completekey=None,
         # IPython changes...
         self.is_pydb = has_pydb
 
-        self.shell = ipapi.get()
+        self.shell = get_ipython()
 
         if self.is_pydb:
 
diff --git a/IPython/core/getipython.py b/IPython/core/getipython.py
@@ -1,13 +1,9 @@
 # encoding: utf-8
-"""
-This module is *completely* deprecated and should no longer be used for
-any purpose.  Currently, we have a few parts of the core that have
-not been componentized and thus, still rely on this module.  When everything
-has been made into a component, this module will be sent to deathrow.
+"""Simple function to call to get the current InteractiveShell instance
 """
 
 #-----------------------------------------------------------------------------
-#  Copyright (C) 2008-2011  The IPython Development Team
+#  Copyright (C) 2013  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
@@ -17,13 +13,18 @@
 # Imports
 #-----------------------------------------------------------------------------
 
+import warnings
+
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 
-def get():
-    """Get the global InteractiveShell instance."""
+def get_ipython():
+    """Get the global InteractiveShell instance.
+    
+    Returns None if no InteractiveShell instance is registered.
+    """
     from IPython.core.interactiveshell import InteractiveShell
-    return InteractiveShell.instance()
-
+    if InteractiveShell.initialized():
+        return InteractiveShell.instance()
diff --git a/IPython/core/page.py b/IPython/core/page.py
@@ -34,7 +34,7 @@
 
 from io import UnsupportedOperation
 
-from IPython.core import ipapi
+from IPython import get_ipython
 from IPython.core.error import TryNext
 from IPython.utils.data import chop
 from IPython.utils import io
@@ -158,7 +158,7 @@ def page(strng, start=0, screen_lines=0, pager_cmd=None):
     start = max(0, start)
 
     # first, try the hook
-    ip = ipapi.get()
+    ip = get_ipython()
     if ip:
         try:
             ip.hooks.show_in_pager(strng)
diff --git a/IPython/core/tests/refbug.py b/IPython/core/tests/refbug.py
@@ -18,7 +18,7 @@
 #-----------------------------------------------------------------------------
 import sys
 
-from IPython.core import ipapi
+from IPython import get_ipython
 
 #-----------------------------------------------------------------------------
 # Globals
@@ -29,7 +29,7 @@
 # want to prevent.
 if __name__ == '__main__':
 
-    ip = ipapi.get()
+    ip = get_ipython()
 
     if not '_refbug_cache' in ip.user_ns:
         ip.user_ns['_refbug_cache'] = []
diff --git a/IPython/core/tests/test_imports.py b/IPython/core/tests/test_imports.py
@@ -21,8 +21,8 @@ def test_import_history():
 def test_import_hooks():
     from IPython.core import hooks
 
-def test_import_ipapi():
-    from IPython.core import ipapi
+def test_import_getipython():
+    from IPython.core import getipython
 
 def test_import_interactiveshell():
     from IPython.core import interactiveshell
diff --git a/IPython/core/ultratb.py b/IPython/core/ultratb.py
@@ -99,7 +99,8 @@
 
 # IPython's own modules
 # Modified pdb which doesn't damage IPython's readline handling
-from IPython.core import debugger, ipapi
+from IPython import get_ipython
+from IPython.core import debugger
 from IPython.core.display_trap import DisplayTrap
 from IPython.core.excolors import exception_colors
 from IPython.utils import PyColorize
@@ -279,7 +280,7 @@ def _format_traceback_lines(lnum, index, lines, Colors, lvals=None,scheme=None):
 
     # This lets us get fully syntax-highlighted tracebacks.
     if scheme is None:
-        ipinst = ipapi.get()
+        ipinst = get_ipython()
         if ipinst is not None:
             scheme = ipinst.colors
         else:
@@ -602,7 +603,7 @@ def _format_exception_only(self, etype, value):
 
         # sync with user hooks
         if have_filedata:
-            ipinst = ipapi.get()
+            ipinst = get_ipython()
             if ipinst is not None:
                 ipinst.hooks.synchronize_with_editor(value.filename, value.lineno, 0)
 
@@ -957,7 +958,7 @@ def linereader(file=file, lnum=[lnum], getline=ulinecache.getline):
              filepath, lnum = records[-1][1:3]
              #print "file:", str(file), "linenb", str(lnum) # dbg
              filepath = os.path.abspath(filepath)
-             ipinst = ipapi.get()
+             ipinst = get_ipython()
              if ipinst is not None:
                  ipinst.hooks.synchronize_with_editor(filepath, lnum, 0)
         # vds: <<
diff --git a/IPython/lib/backgroundjobs.py b/IPython/lib/backgroundjobs.py
@@ -33,6 +33,7 @@
 import sys
 import threading
 
+from IPython import get_ipython
 from IPython.core.ultratb import AutoFormattedTB
 from IPython.utils.warn import error
 
diff --git a/IPython/lib/editorhooks.py b/IPython/lib/editorhooks.py
@@ -8,6 +8,8 @@
 import os
 import pipes
 import subprocess
+
+from IPython import get_ipython
 from IPython.core.error import TryNext
 
 
diff --git a/IPython/lib/kernel.py b/IPython/lib/kernel.py
@@ -4,7 +4,7 @@
 """
 
 import warnings
-warnings.warn("IPython.lib.kernel moved to IPython.kernel.connect in IPython 0.14",
+warnings.warn("IPython.lib.kernel moved to IPython.kernel.connect in IPython 1.0",
     DeprecationWarning
 )
 
