upstream/ipython Files · IPython/core/getipython.py

Backport PR : Update docs on declaring a magic function...

Backport PR : Update docs on declaring a magic function The extension docs were telling people to use `define_magic()`, but the docstring says it is deprecated, and it only supports line magics. The replacement seems to be `register_magic_function()`. This directs people to that, and ensures that it is documented.

Thomas Kluyver - - Load All Authors

File last commit:

r11124:9567c77a


                r12314:b5f44d4e

Download file

             getipython.py
        
                    24 lines
            
             | 916 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / getipython.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """Simple function to call to get the current InteractiveShell instance

      """

      #-----------------------------------------------------------------------------

      #  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.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Classes and functions

      #-----------------------------------------------------------------------------

      def get_ipython():

          """Get the global InteractiveShell instance.

          Returns None if no InteractiveShell instance is registered.

          """

          from IPython.core.interactiveshell import InteractiveShell

          if InteractiveShell.initialized():

              return InteractiveShell.instance()

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# encoding: utf-8
				"""Simple function to call to get the current InteractiveShell instance
				"""

				#-----------------------------------------------------------------------------
				# 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.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Classes and functions
				#-----------------------------------------------------------------------------


				def get_ipython():
				"""Get the global InteractiveShell instance.

				Returns None if no InteractiveShell instance is registered.
				"""
				from IPython.core.interactiveshell import InteractiveShell
				if InteractiveShell.initialized():
				return InteractiveShell.instance()