Merge pull request jupyter-widgets#3477 from jasongrout/settitle

Add back set_title and get_title to selection containers

Author: ibdafna

python/ipywidgets/ipywidgets/widgets/tests/test_selectioncontainer.py

@@ -26,3 +26,29 @@ def test_selected_index(self):
     def test_selected_index_out_of_bounds(self):
         with self.assertRaises(TraitError):
             Accordion(self.children, selected_index=-1)
+
+
+    def test_titles(self):
+        accordion = Accordion(self.children, selected_index=None)
+        assert accordion.get_state()['titles'] == ('', '')
+        assert accordion.titles == ('', '')
+
+        accordion.set_title(1, 'Title 1')
+        assert accordion.get_state()['titles'] == ('', 'Title 1')
+        assert accordion.titles[1] == 'Title 1'
+        assert accordion.get_title(1) == 'Title 1'
+
+        # Backwards compatible with 7.x api
+        accordion.set_title(1, None)
+        assert accordion.get_state()['titles'] == ('', '')
+        assert accordion.titles[1] == ''
+        assert accordion.get_title(1) == ''
+
+        with self.assertRaises(IndexError):
+            accordion.set_title(2, 'out of bounds')
+        with self.assertRaises(IndexError):
+            accordion.get_title(2)
+
+        accordion.children = tuple(accordion.children[:1])
+        assert len(accordion.children) == 1
+        assert accordion.titles == ('',)

python/ipywidgets/ipywidgets/widgets/widget_selectioncontainer.py

@@ -12,6 +12,12 @@
 from .widget_core import CoreWidget
 from traitlets import Unicode, Dict, CInt, TraitError, validate, observe
 from .trait_types import TypedTuple
+from itertools import chain, repeat, islice
+
+# Inspired by an itertools recipe: https://docs.python.org/3/library/itertools.html#itertools-recipes
+def pad(iterable, padding=None, length=None):
+    """Returns the sequence elements and then returns None up to the given size (or indefinitely if size is None)."""
+    return islice(chain(iterable, repeat(padding)), length)
 
 class _SelectionContainer(Box, CoreWidget):
     """Base class used to display multiple child widgets."""
@@ -29,10 +35,42 @@ def _validated_index(self, proposal):
         else:
             raise TraitError('Invalid selection: index out of bounds')
 
+    @validate('titles')
+    def _validate_titles(self, proposal):
+        return tuple(pad(proposal.value, '', len(self.children)))
+
     @observe('children')
     def _observe_children(self, change):
         if self.selected_index is not None and len(change.new) < self.selected_index:
             self.selected_index = None
+        if len(self.titles) != len(change.new):
+            # Run validation function
+            self.titles = tuple(self.titles)
+
+    def set_title(self, index, title):
+        """Sets the title of a container page.
+        Parameters
+        ----------
+        index : int
+            Index of the container page
+        title : unicode
+            New title
+        """
+        titles = list(self.titles)
+        # for backwards compatibility with ipywidgets 7.x
+        if title is None:
+            title = ''
+        titles[index]=title
+        self.titles = tuple(titles)
+
+    def get_title(self, index):
+        """Gets the title of a container page.
+        Parameters
+        ----------
+        index : int
+            Index of the container page
+        """
+        return self.titles[index]
 
 @register
 class Accordion(_SelectionContainer):