upstream/ipython Files · IPython/core/magics/__init__.py

Backport PR : Define `_repr_mimebundle_`...

Backport PR : Define `_repr_mimebundle_` Allows objects to display arbitrary mime-types by returning a mimebundle. This is getting increasingly important as custom mime-types are growing in popularity. - mime-bundle is computed first, but other formatters are still called - if a mime-type is present in repr-mimebundle, `_repr_<mime>_` will not be called (avoids redundant calls for backward-compatible objects) closes 10090 cc rgbkrk Alternative design: rather than single method returning the mimebundle itself, return mime-keyed mapping to callables, e.g.: ```python def _repr_mime_methods_(self): return { 'text/html': self._repr_html_, } ``` Another more minor alternative: rather than allowing return of `data` or `(data, metadata)`, require returning the full mime-bundle with `data`, `metadata` keys: ```python def _repr_mimebundle(self): return { 'data': { 'application/vnd.foo+json': [1,2,3], }, } ```

Matthias Bussonnier - - Load All Authors

File last commit:

r22403:6f69404f


                r23619:abbf312f

Download file

             __init__.py
        
                    41 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / magics / __init__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Implementation of all the magic functions built into IPython.

      """

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

      #  Copyright (c) 2012 The IPython Development Team.

      #

      #  Distributed under the terms of the Modified BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

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

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

      # Imports

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

      from ..magic import Magics, magics_class

      from .auto import AutoMagics

      from .basic import BasicMagics

      from .code import CodeMagics, MacroToEdit

      from .config import ConfigMagics

      from .display import DisplayMagics

      from .execution import ExecutionMagics

      from .extension import ExtensionMagics

      from .history import HistoryMagics

      from .logging import LoggingMagics

      from .namespace import NamespaceMagics

      from .osm import OSMagics

      from .pylab import PylabMagics

      from .script import ScriptMagics

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

      # Magic implementation classes

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

      @magics_class

      class UserMagics(Magics):

          """Placeholder for user-defined magics to be added at runtime.

          All magics are eventually merged into a single namespace at runtime, but we

          use this class to isolate the magics defined dynamically by the user into

          their own class.

          """

	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

				"""Implementation of all the magic functions built into IPython.
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2012 The IPython Development Team.
				#
				# Distributed under the terms of the Modified BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------

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

				from ..magic import Magics, magics_class
				from .auto import AutoMagics
				from .basic import BasicMagics
				from .code import CodeMagics, MacroToEdit
				from .config import ConfigMagics
				from .display import DisplayMagics
				from .execution import ExecutionMagics
				from .extension import ExtensionMagics
				from .history import HistoryMagics
				from .logging import LoggingMagics
				from .namespace import NamespaceMagics
				from .osm import OSMagics
				from .pylab import PylabMagics
				from .script import ScriptMagics

				#-----------------------------------------------------------------------------
				# Magic implementation classes
				#-----------------------------------------------------------------------------

				@magics_class
				class UserMagics(Magics):
				"""Placeholder for user-defined magics to be added at runtime.

				All magics are eventually merged into a single namespace at runtime, but we
				use this class to isolate the magics defined dynamically by the user into
				their own class.
				"""