upstream/ipython Files · IPython/nbconvert/utils/base.py

DOC: Warn the user when they pass `default` to a TraitType....

DOC: Warn the user when they pass `default` to a TraitType. Most TraitType subclasses accept a `default_value` parameter. On more occasions than I care to admit, I've written something like: ``` class Foo(HasTraits): foo_int = Integer(default=5) ``` when what I actually meant was ``` class Foo(HasTraits): foo_int = Integer(default_value=5) ``` I suspect I'm not the only one who's had to track down this same bug multiple times.

Damon Allen - - Load All Authors

File last commit:

r19476:9df62b7c


                r20649:fbe6a44e

Download file

             base.py
        
                    29 lines
            
             | 1.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / utils / base.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Global configuration class."""

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      from IPython.utils.traitlets import List

      from IPython.config.configurable import LoggingConfigurable

      from IPython.utils.traitlets import Unicode

      class NbConvertBase(LoggingConfigurable):

          """Global configurable class for shared config

          Useful for display data priority that might be use by many transformers

          """

          display_data_priority = List(['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/plain'],

                  config=True,

                    help= """

                          An ordered list of preferred output type, the first

                          encountered will usually be used when converting discarding

                          the others.

                          """

                  )

          default_language = Unicode('ipython', config=True,

             help='DEPRECATED default highlight language, please use language_info metadata instead')

          def __init__(self, **kw):

              super(NbConvertBase, self).__init__(**kw)

	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

				"""Global configuration class."""

				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.

				from IPython.utils.traitlets import List
				from IPython.config.configurable import LoggingConfigurable
				from IPython.utils.traitlets import Unicode

				class NbConvertBase(LoggingConfigurable):
				"""Global configurable class for shared config

				Useful for display data priority that might be use by many transformers
				"""

				display_data_priority = List(['text/html', 'application/pdf', 'text/latex', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/plain'],
				config=True,
				help= """
				An ordered list of preferred output type, the first
				encountered will usually be used when converting discarding
				the others.
				"""
				)

				default_language = Unicode('ipython', config=True,
				help='DEPRECATED default highlight language, please use language_info metadata instead')

				def __init__(self, **kw):
				super(NbConvertBase, self).__init__(**kw)