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

Merge pull request from bfroehle/lsmagic_docs...

Merge pull request from bfroehle/lsmagic_docs Refactor %magic into using a new lsmagic_docs method. Added a `lsmagic_docs` method which returns a dictionary of magic function docstrings. It optionally takes parameters `brief` (list only first line of the docstring) and `missing` (to use in lieu of an empty docstring).

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r7654:edaad4c7

Download file

             ipapi.py
        
                    29 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / ipapi.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

      """

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

      #  Copyright (C) 2008-2011  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.

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

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

      # Imports

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

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

      # Classes and functions

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

      def get():

          """Get the global InteractiveShell instance."""

          from IPython.core.interactiveshell import InteractiveShell

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

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 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.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

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


				def get():
				"""Get the global InteractiveShell instance."""
				from IPython.core.interactiveshell import InteractiveShell
				return InteractiveShell.instance()