Source code for pyquickhelper.ipythonhelper.widgets

"""
To add interactive widgets in a notebook and connect it to Python function,
Source: https://github.com/jakevdp/ipywidgets, the module was modified for Python 3
See notebook :ref:`havingaforminanotebookrst`.

Copyright (c) 2013, Jake Vanderplas
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.

* Neither the name of the {organization} nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


:githublink:`%|py|35`
"""

import copy


[docs]class StaticWidget(object): """ Base Class for Static Widgets :githublink:`%|py|43` """
[docs] def __init__(self, name=None, divclass=None): """ constructor :param name: name :param divclass: class for div section :githublink:`%|py|51` """ self.name = name if divclass is None: self.divargs = "" else: self.divargs = 'class:"{0}"'.format(divclass)
[docs] def __repr__(self): """ operator, call method html :githublink:`%|py|61` """ return self.html()
[docs] def _repr_html_(self): """ operator, call method html :githublink:`%|py|67` """ return self.html()
[docs] def html(self): "abstract method" raise NotImplementedError("This should overriden.")
[docs] def copy(self): """ calls deepcopy :return: copy of self :githublink:`%|py|79` """ return copy.deepcopy(self)
[docs] def renamed(self, name): """ rename *name* if *name* is an attribute :return: object :githublink:`%|py|87` """ if (self.name is not None) and (self.name != name): obj = self.copy() else: obj = self obj.name = name return obj
[docs]class RangeWidget(StaticWidget): """ Range (slider) widget The class overloads :meth:`html <pyquickhelper.ipythonhelper.widgets.RangeWidget.html>` and :meth:`values <pyquickhelper.ipythonhelper.widgets.RangeWidget.values>`. :githublink:`%|py|103` """ slider_html = ('<b>{name}:</b> <input type="range" name="{name}" ' 'min="{range[0]}" max="{range[1]}" step="{range[2]}" ' 'value="{default}" style="{style}" ' 'oninput="interactUpdate(this.parentNode);" ' 'onchange="interactUpdate(this.parentNode);">')
[docs] def __init__(self, min, max, step=1, name=None, default=None, width=350, divclass=None, show_range=False): """ constructor :param min: min value :param max: max value :param step: step :param name: name :param default: default value :param width: width in pixel :param divclass: class for div section :param show_range: boolean :githublink:`%|py|124` """ StaticWidget.__init__(self, name, divclass) self.datarange = (min, max, step) self.width = width self.show_range = show_range if default is None: self.default = min else: self.default = default
[docs] def values(self): """ :return: all possible values :githublink:`%|py|137` """ min, max, step = self.datarange import numpy as np return np.arange(min, max + step, step)
[docs] def html(self): """ HTML code :return: string HTML :githublink:`%|py|147` """ style = "" if self.width is not None: style += "width:{0}px".format(self.width) output = self.slider_html.format(name=self.name, range=self.datarange, default=self.default, style=style) if self.show_range: output = "{0} {1} {2}".format(self.datarange[0], output, self.datarange[1]) return output
[docs]class RadioWidget(StaticWidget): """ radio button :githublink:`%|py|240` """ #: template 1 radio_html = ('<input type="radio" name="{name}" value="{value}" ' '{checked} ' 'onchange="interactUpdate(this.parentNode);">')
[docs] def __init__(self, values, name=None, labels=None, default=None, divclass=None, delimiter=" "): """ constructor :param values: values for the list :param name: name of the object :param labels: ? :param default: default value :param divclass: class for div section :param delimiter: delimiter :githublink:`%|py|259` """ StaticWidget.__init__(self, name, divclass) self._values = values self.delimiter = delimiter if labels is None: labels = map(str, values) elif len(labels) != len(values): raise ValueError("length of labels must match length of values") self.labels = labels if default is None: self.default = values[0] elif default in values: self.default = default else: raise ValueError( "if specified, default must be in values: default={0}, values={1}".format(default, values))
[docs] def _single_radio(self, value): """ private :githublink:`%|py|281` """ if value == self.default: checked = 'checked="checked"' else: checked = '' return self.radio_html.format(name=self.name, value=value, checked=checked)
[docs] def values(self): """ return all the possible values :githublink:`%|py|292` """ return self._values
[docs] def html(self): """ return HTML string :githublink:`%|py|298` """ preface = '<b>{name}:</b> '.format(name=self.name) return preface + self.delimiter.join( ["{0}: {1}".format(label, self._single_radio(value)) for (label, value) in zip(self.labels, self._values)])