upstream/ipython Files · IPython/nbconvert/filters/datatypefilter.py

DOC : modified docs is HasTraits.traits and HasTraits.class_traits...

DOC : modified docs is HasTraits.traits and HasTraits.class_traits - change list -> dict to reflect what the code does - clarified how kwargs work (instead of just referencing enthought.traits). - fix classes -> class' spelling

Jonathan Frederic - - Load All Authors

File last commit:

r11547:917c213a


                r15487:fc211a9a

Download file

             datatypefilter.py
        
                    33 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / filters / datatypefilter.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Filter used to select the first preferred output format available.

      The filter contained in the file allows the converter templates to select

      the output format that is most valuable to the active export format.  The

      value of the different formats is set via 

      NbConvertBase.display_data_priority

      """

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

      # Copyright (c) 2013, 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.

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

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

      # Classes and functions

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

      from ..utils.base import NbConvertBase

      __all__ = ['DataTypeFilter']

      class DataTypeFilter(NbConvertBase):

          """ Returns the preferred display format """

          def __call__(self, output):

              """ Return the first available format in the priority """

              for fmt in self.display_data_priority:

                  if fmt in output:

                      return [fmt]

              return []

	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

				"""Filter used to select the first preferred output format available.

				The filter contained in the file allows the converter templates to select
				the output format that is most valuable to the active export format. The
				value of the different formats is set via
				NbConvertBase.display_data_priority
				"""
				#-----------------------------------------------------------------------------
				# Copyright (c) 2013, 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.
				#-----------------------------------------------------------------------------

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

				from ..utils.base import NbConvertBase

				__all__ = ['DataTypeFilter']

				class DataTypeFilter(NbConvertBase):
				""" Returns the preferred display format """

				def __call__(self, output):
				""" Return the first available format in the priority """

				for fmt in self.display_data_priority:
				if fmt in output:
				return [fmt]
				return []