"""Float class. Represents an unbounded float using a widget. """ #----------------------------------------------------------------------------- # 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. #----------------------------------------------------------------------------- #----------------------------------------------------------------------------- # Imports #----------------------------------------------------------------------------- from .widget import DOMWidget, register from .trait_types import Color from IPython.utils.traitlets import Unicode, CFloat, Bool, CaselessStrEnum, Tuple from IPython.utils.warn import DeprecatedClass #----------------------------------------------------------------------------- # Classes #----------------------------------------------------------------------------- class _Float(DOMWidget): value = CFloat(0.0, help="Float value", sync=True) disabled = Bool(False, help="Enable or disable user changes", sync=True) description = Unicode(help="Description of the value this widget represents", sync=True) def __init__(self, value=None, **kwargs): if value is not None: kwargs['value'] = value super(_Float, self).__init__(**kwargs) class _BoundedFloat(_Float): max = CFloat(100.0, help="Max value", sync=True) min = CFloat(0.0, help="Min value", sync=True) step = CFloat(0.1, help="Minimum step that the value can take (ignored by some views)", sync=True) def __init__(self, *pargs, **kwargs): """Constructor""" super(_BoundedFloat, self).__init__(*pargs, **kwargs) self._handle_value_changed('value', None, self.value) self._handle_max_changed('max', None, self.max) self._handle_min_changed('min', None, self.min) self.on_trait_change(self._handle_value_changed, 'value') self.on_trait_change(self._handle_max_changed, 'max') self.on_trait_change(self._handle_min_changed, 'min') def _handle_value_changed(self, name, old, new): """Validate value.""" if self.min > new or new > self.max: self.value = min(max(new, self.min), self.max) def _handle_max_changed(self, name, old, new): """Make sure the min is always <= the max.""" if new < self.min: raise ValueError("setting max < min") if new < self.value: self.value = new def _handle_min_changed(self, name, old, new): """Make sure the max is always >= the min.""" if new > self.max: raise ValueError("setting min > max") if new > self.value: self.value = new @register('IPython.FloatText') class FloatText(_Float): """ Displays a float value within a textbox. For a textbox in which the value must be within a specific range, use BoundedFloatText. Parameters ---------- value : float value displayed description : str description displayed next to the textbox color : str Unicode color code (eg. '#C13535'), optional color of the value displayed """ _view_name = Unicode('FloatTextView', sync=True) @register('IPython.BoundedFloatText') class BoundedFloatText(_BoundedFloat): """ Displays a float value within a textbox. Value must be within the range specified. For a textbox in which the value doesn't need to be within a specific range, use FloatText. Parameters ---------- value : float value displayed min : float minimal value of the range of possible values displayed max : float maximal value of the range of possible values displayed description : str description displayed next to the textbox color : str Unicode color code (eg. '#C13535'), optional color of the value displayed """ _view_name = Unicode('FloatTextView', sync=True) @register('IPython.FloatSlider') class FloatSlider(_BoundedFloat): """ Slider/trackbar of floating values with the specified range. Parameters ---------- value : float position of the slider min : float minimal position of the slider max : float maximal position of the slider step : float step of the trackbar description : str name of the slider orientation : {'vertical', 'horizontal}, optional default is horizontal readout : {True, False}, optional default is True, display the current value of the slider next to it slider_color : str Unicode color code (eg. '#C13535'), optional color of the slider color : str Unicode color code (eg. '#C13535'), optional color of the value displayed (if readout == True) """ _view_name = Unicode('FloatSliderView', sync=True) orientation = CaselessStrEnum(values=['horizontal', 'vertical'], default_value='horizontal', help="Vertical or horizontal.", sync=True) _range = Bool(False, help="Display a range selector", sync=True) readout = Bool(True, help="Display the current value of the slider next to it.", sync=True) slider_color = Color(None, allow_none=True, sync=True) @register('IPython.FloatProgress') class FloatProgress(_BoundedFloat): """ Displays a progress bar. Parameters ----------- value : float position within the range of the progress bar min : float minimal position of the slider max : float maximal position of the slider step : float step of the progress bar description : str name of the progress bar bar_style: {'success', 'info', 'warning', 'danger', ''}, optional color of the progress bar, default is '' (blue) colors are: 'success'-green, 'info'-light blue, 'warning'-orange, 'danger'-red """ _view_name = Unicode('ProgressView', sync=True) bar_style = CaselessStrEnum( values=['success', 'info', 'warning', 'danger', ''], default_value='', allow_none=True, sync=True, help="""Use a predefined styling for the progess bar.""") class _FloatRange(_Float): value = Tuple(CFloat, CFloat, default_value=(0.0, 1.0), help="Tuple of (lower, upper) bounds", sync=True) lower = CFloat(0.0, help="Lower bound", sync=False) upper = CFloat(1.0, help="Upper bound", sync=False) def __init__(self, *pargs, **kwargs): value_given = 'value' in kwargs lower_given = 'lower' in kwargs upper_given = 'upper' in kwargs if value_given and (lower_given or upper_given): raise ValueError("Cannot specify both 'value' and 'lower'/'upper' for range widget") if lower_given != upper_given: raise ValueError("Must specify both 'lower' and 'upper' for range widget") DOMWidget.__init__(self, *pargs, **kwargs) # ensure the traits match, preferring whichever (if any) was given in kwargs if value_given: self.lower, self.upper = self.value else: self.value = (self.lower, self.upper) self.on_trait_change(self._validate, ['value', 'upper', 'lower']) def _validate(self, name, old, new): if name == 'value': self.lower, self.upper = min(new), max(new) elif name == 'lower': self.value = (new, self.value[1]) elif name == 'upper': self.value = (self.value[0], new) class _BoundedFloatRange(_FloatRange): step = CFloat(1.0, help="Minimum step that the value can take (ignored by some views)", sync=True) max = CFloat(100.0, help="Max value", sync=True) min = CFloat(0.0, help="Min value", sync=True) def __init__(self, *pargs, **kwargs): any_value_given = 'value' in kwargs or 'upper' in kwargs or 'lower' in kwargs _FloatRange.__init__(self, *pargs, **kwargs) # ensure a minimal amount of sanity if self.min > self.max: raise ValueError("min must be <= max") if any_value_given: # if a value was given, clamp it within (min, max) self._validate("value", None, self.value) else: # otherwise, set it to 25-75% to avoid the handles overlapping self.value = (0.75*self.min + 0.25*self.max, 0.25*self.min + 0.75*self.max) # callback already set for 'value', 'lower', 'upper' self.on_trait_change(self._validate, ['min', 'max']) def _validate(self, name, old, new): if name == "min": if new > self.max: raise ValueError("setting min > max") self.min = new elif name == "max": if new < self.min: raise ValueError("setting max < min") self.max = new low, high = self.value if name == "value": low, high = min(new), max(new) elif name == "upper": if new < self.lower: raise ValueError("setting upper < lower") high = new elif name == "lower": if new > self.upper: raise ValueError("setting lower > upper") low = new low = max(self.min, min(low, self.max)) high = min(self.max, max(high, self.min)) # determine the order in which we should update the # lower, upper traits to avoid a temporary inverted overlap lower_first = high < self.lower self.value = (low, high) if lower_first: self.lower = low self.upper = high else: self.upper = high self.lower = low @register('IPython.FloatRangeSlider') class FloatRangeSlider(_BoundedFloatRange): """ Slider/trackbar for displaying a floating value range (within the specified range of values). Parameters ---------- value : float tuple range of the slider displayed min : float minimal position of the slider max : float maximal position of the slider step : float step of the trackbar description : str name of the slider orientation : {'vertical', 'horizontal}, optional default is horizontal readout : {True, False}, optional default is True, display the current value of the slider next to it slider_color : str Unicode color code (eg. '#C13535'), optional color of the slider color : str Unicode color code (eg. '#C13535'), optional color of the value displayed (if readout == True) """ _view_name = Unicode('FloatSliderView', sync=True) orientation = CaselessStrEnum(values=['horizontal', 'vertical'], default_value='horizontal', help="Vertical or horizontal.", sync=True) _range = Bool(True, help="Display a range selector", sync=True) readout = Bool(True, help="Display the current value of the slider next to it.", sync=True) slider_color = Color(None, allow_none=True, sync=True) # Remove in IPython 4.0 FloatTextWidget = DeprecatedClass(FloatText, 'FloatTextWidget') BoundedFloatTextWidget = DeprecatedClass(BoundedFloatText, 'BoundedFloatTextWidget') FloatSliderWidget = DeprecatedClass(FloatSlider, 'FloatSliderWidget') FloatProgressWidget = DeprecatedClass(FloatProgress, 'FloatProgressWidget')