Merge pull request #5520 from jdfreder/2.x

Backport PR  #5493: made a minor fix to one of the widget examples

IPython/html/widgets/widget_selection.py

@@ -1,121 +1,125 b''
 """SelectionWidget classes.
 
 Represents an enumeration 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 collections import OrderedDict
 from threading import Lock
 
 from .widget import DOMWidget
 from IPython.utils.traitlets import Unicode, List, Bool, Any, Dict, TraitError
 from IPython.utils.py3compat import unicode_type
 
 #-----------------------------------------------------------------------------
 # SelectionWidget
 #-----------------------------------------------------------------------------
 class _SelectionWidget(DOMWidget):
     """Base class for Selection widgets
     
     ``values`` can be specified as a list or dict. If given as a list,
     it will be transformed to a dict of the form ``{str(value):value}``.
     """
     
     value = Any(help="Selected value")
     values = Dict(help="""Dictionary of {name: value} the user can select.
     
     The keys of this dictionary are the strings that will be displayed in the UI,
     representing the actual Python choices.
     
     The keys of this dictionary are also available as value_names.
     """)
     value_name = Unicode(help="The name of the selected value", sync=True)
     value_names = List(Unicode, help="""Read-only list of names for each value.
         
         If values is specified as a list, this is the string representation of each element.
         Otherwise, it is the keys of the values dictionary.
         
         These strings are used to display the choices in the front-end.""", 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, *args, **kwargs):
         self.value_lock = Lock()
         self._in_values_changed = False
         if 'values' in kwargs:
             values = kwargs['values']
             # convert list values to an dict of {str(v):v}
             if isinstance(values, list):
                 # preserve list order with an OrderedDict
                 kwargs['values'] = OrderedDict((unicode_type(v), v) for v in values)
+            # python3.3 turned on hash randomization by default - this means that sometimes, randomly
+            # we try to set value before setting values, due to dictionary ordering.  To fix this, force
+            # the setting of self.values right now, before anything else runs
+            self.values = kwargs.pop('values')
         DOMWidget.__init__(self, *args, **kwargs)
     
     def _values_changed(self, name, old, new):
         """Handles when the values dict has been changed.
 
         Setting values implies setting value names from the keys of the dict.
         """
         self._in_values_changed = True
         try:
             self.value_names = list(new.keys())
         finally:
             self._in_values_changed = False
         
         # ensure that the chosen value is one of the choices
         if self.value not in new.values():
             self.value = next(iter(new.values()))
     
     def _value_names_changed(self, name, old, new):
         if not self._in_values_changed:
             raise TraitError("value_names is a read-only proxy to values.keys(). Use the values dict instead.")
 
     def _value_changed(self, name, old, new):
         """Called when value has been changed"""
         if self.value_lock.acquire(False):
             try:
                 # Reverse dictionary lookup for the value name
                 for k,v in self.values.items():
                     if new == v:
                         # set the selected value name
                         self.value_name = k
                         return
                 # undo the change, and raise KeyError
                 self.value = old
                 raise KeyError(new)
             finally:
                 self.value_lock.release()
 
     def _value_name_changed(self, name, old, new):
         """Called when the value name has been changed (typically by the frontend)."""
         if self.value_lock.acquire(False):
             try:
                 self.value = self.values[new]
             finally:
                 self.value_lock.release()
 
 
 class ToggleButtonsWidget(_SelectionWidget):
     _view_name = Unicode('ToggleButtonsView', sync=True)
 
 
 class DropdownWidget(_SelectionWidget):
     _view_name = Unicode('DropdownView', sync=True)
 
 
 class RadioButtonsWidget(_SelectionWidget):
     _view_name = Unicode('RadioButtonsView', sync=True)
     
 
 class SelectWidget(_SelectionWidget):
     _view_name = Unicode('SelectView', sync=True)

examples/Interactive Widgets/Export As (nbconvert).ipynb

@@ -1,186 +1,187 b''
 {
  "metadata": {
   "name": ""
  },
  "nbformat": 3,
  "nbformat_minor": 0,
  "worksheets": [
   {
    "cells": [
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "# Widget related imports\n",
       "from IPython.html import widgets\n",
       "from IPython.display import display, clear_output, Javascript\n",
       "from IPython.utils.traitlets import Unicode\n",
       "\n",
       "# nbconvert related imports\n",
       "from IPython.nbconvert import get_export_names, export_by_name\n",
       "from IPython.nbconvert.writers import FilesWriter\n",
-      "from IPython.nbformat import current"
+      "from IPython.nbformat import current\n",
+      "from IPython.nbconvert.utils.exceptions import ConversionException"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 1
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Create a text Widget without displaying it.  The widget will be used to store the notebook's name which is otherwise only available in the front-end."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "notebook_name = widgets.TextWidget()"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 2
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Get the current notebook's name by pushing JavaScript to the browser that sets the notebook name in a string widget."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "js = \"\"\"var model = IPython.notebook.kernel.widget_manager.get_model('{model_id}');\n",
       "model.set('value', IPython.notebook.notebook_name);\n",
       "model.save();\"\"\".format(model_id=notebook_name.model_id)\n",
       "display(Javascript(data=js))"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "javascript": [
         "var model = IPython.notebook.kernel.widget_manager.get_model('8c6583524eb3422c99491730a3e1ce6c');\n",
         "model.set('value', IPython.notebook.notebook_name);\n",
         "model.save();"
        ],
        "metadata": {},
        "output_type": "display_data",
        "text": [
         "<IPython.core.display.Javascript at 0x164ea50>"
        ]
       }
      ],
      "prompt_number": 3
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "filename = notebook_name.value\n",
       "filename"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [
       {
        "metadata": {},
        "output_type": "pyout",
        "prompt_number": 4,
        "text": [
         "u'Export As (nbconvert).ipynb'"
        ]
       }
      ],
      "prompt_number": 4
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Create the widget that will allow the user to Export the current notebook."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "exporter_names = widgets.DropdownWidget(values=get_export_names(), value='html')\n",
       "export_button = widgets.ButtonWidget(description=\"Export\")\n",
       "download_link = widgets.HTMLWidget(visible=False)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 5
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Export the notebook when the export button is clicked."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "file_writer = FilesWriter()\n",
       "\n",
       "def export(name, nb):\n",
       "    \n",
       "    # Get a unique key for the notebook and set it in the resources object.\n",
       "    notebook_name = name[:name.rfind('.')]\n",
       "    resources = {}\n",
       "    resources['unique_key'] = notebook_name\n",
       "    resources['output_files_dir'] = '%s_files' % notebook_name\n",
       "\n",
       "    # Try to export\n",
       "    try:\n",
       "        output, resources = export_by_name(exporter_names.value, nb)\n",
       "    except ConversionException as e:\n",
       "        download_link.value = \"<br>Could not export notebook!\"\n",
       "    else:\n",
       "        write_results = file_writer.write(output, resources, notebook_name=notebook_name)\n",
       "    \n",
       "        download_link.value = \"<br>Results: <a href='files/{filename}'><i>\\\"{filename}\\\"</i></a>\".format(filename=write_results)\n",
       "        download_link.visible = True\n",
       "        \n",
-      "def handle_export():\n",
+      "def handle_export(widget):\n",
       "    with open(filename, 'r') as f:\n",
       "        export(filename, current.read(f, 'json'))\n",
       "export_button.on_click(handle_export)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 6
     },
     {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
       "Display the controls."
      ]
     },
     {
      "cell_type": "code",
      "collapsed": false,
      "input": [
       "display(exporter_names, export_button, download_link)"
      ],
      "language": "python",
      "metadata": {},
      "outputs": [],
      "prompt_number": 7
     }
    ],
    "metadata": {}
   }
  ]
 }