upstream/ipython Files · IPython/html/widgets/__init__.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.

Nicholas Bollweg - - Load All Authors

File last commit:

r20287:e8dddcc1


                r20649:fbe6a44e

Download file

             __init__.py
        
                    38 lines
            
             | 1.9 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html / widgets / __init__.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      from .widget import Widget, DOMWidget, CallbackDispatcher, register

      from .widget_bool import Checkbox, ToggleButton

      from .widget_button import Button

      from .widget_box import Box, FlexBox, HBox, VBox

      from .widget_float import FloatText, BoundedFloatText, FloatSlider, FloatProgress, FloatRangeSlider

      from .widget_image import Image

      from .widget_int import IntText, BoundedIntText, IntSlider, IntProgress, IntRangeSlider

      from .widget_output import Output

      from .widget_selection import RadioButtons, ToggleButtons, Dropdown, Select, SelectMultiple

      from .widget_selectioncontainer import Tab, Accordion

      from .widget_string import HTML, Latex, Text, Textarea

      from .interaction import interact, interactive, fixed, interact_manual

      from .widget_link import jslink, jsdlink

      # Deprecated classes

      from .widget_bool import CheckboxWidget, ToggleButtonWidget

      from .widget_button import ButtonWidget

      from .widget_box import ContainerWidget

      from .widget_float import FloatTextWidget, BoundedFloatTextWidget, FloatSliderWidget, FloatProgressWidget

      from .widget_image import ImageWidget

      from .widget_int import IntTextWidget, BoundedIntTextWidget, IntSliderWidget, IntProgressWidget

      from .widget_selection import RadioButtonsWidget, ToggleButtonsWidget, DropdownWidget, SelectWidget

      from .widget_selectioncontainer import TabWidget, AccordionWidget

      from .widget_string import HTMLWidget, LatexWidget, TextWidget, TextareaWidget

      # We use warn_explicit so we have very brief messages without file or line numbers.

      # The concern is that file or line numbers will confuse the interactive user.

      # To ignore this warning, do:

      #

      #     from warnings import filterwarnings

      #     filterwarnings('ignore', module='IPython.html.widgets')

      from warnings import warn_explicit

      __warningregistry__ = {}

      warn_explicit("IPython widgets are experimental and may change in the future.",

                    FutureWarning, '', 0, module = 'IPython.html.widgets',

                    registry = __warningregistry__, module_globals = globals)

	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

				from .widget import Widget, DOMWidget, CallbackDispatcher, register

				from .widget_bool import Checkbox, ToggleButton
				from .widget_button import Button
				from .widget_box import Box, FlexBox, HBox, VBox
				from .widget_float import FloatText, BoundedFloatText, FloatSlider, FloatProgress, FloatRangeSlider
				from .widget_image import Image
				from .widget_int import IntText, BoundedIntText, IntSlider, IntProgress, IntRangeSlider
				from .widget_output import Output
				from .widget_selection import RadioButtons, ToggleButtons, Dropdown, Select, SelectMultiple
				from .widget_selectioncontainer import Tab, Accordion
				from .widget_string import HTML, Latex, Text, Textarea
				from .interaction import interact, interactive, fixed, interact_manual
				from .widget_link import jslink, jsdlink

				# Deprecated classes
				from .widget_bool import CheckboxWidget, ToggleButtonWidget
				from .widget_button import ButtonWidget
				from .widget_box import ContainerWidget
				from .widget_float import FloatTextWidget, BoundedFloatTextWidget, FloatSliderWidget, FloatProgressWidget
				from .widget_image import ImageWidget
				from .widget_int import IntTextWidget, BoundedIntTextWidget, IntSliderWidget, IntProgressWidget
				from .widget_selection import RadioButtonsWidget, ToggleButtonsWidget, DropdownWidget, SelectWidget
				from .widget_selectioncontainer import TabWidget, AccordionWidget
				from .widget_string import HTMLWidget, LatexWidget, TextWidget, TextareaWidget

				# We use warn_explicit so we have very brief messages without file or line numbers.
				# The concern is that file or line numbers will confuse the interactive user.
				# To ignore this warning, do:
				#
				# from warnings import filterwarnings
				# filterwarnings('ignore', module='IPython.html.widgets')

				from warnings import warn_explicit
				__warningregistry__ = {}
				warn_explicit("IPython widgets are experimental and may change in the future.",
				FutureWarning, '', 0, module = 'IPython.html.widgets',
				registry = __warningregistry__, module_globals = globals)