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

add a little detail to custom repr method docs (#13945)...

add a little detail to custom repr method docs (#13945) These docs are a bit sparse, so I added a couple details that might help implementers: - explicitly state the return type, rather than only via example - give some examples of PNG, HTML - note that formatters shouldn't be sensitive to other formats related to https://github.com/Textualize/rich/pull/2806 which didn't follow the spec, in part I think because the docs weren't explicit enough about exactly what a formatter should do.

Matthias Bussonnier - - Load All Authors

File last commit:

r27288:33f5b346


                r28126:29190f63

Download file

             getipython.py
        
                    24 lines
            
             | 912 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()