##// END OF EJS Templates
Finished renaming Multicontainer to SelectionContainer
Finished renaming Multicontainer to SelectionContainer

File last commit:

r14558:17ae963c
r14578:10a84acc
Show More
widget.py
411 lines | 13.8 KiB | text/x-python | PythonLexer
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Base Widget class. Allows user to create widgets in the backend that render
in the IPython notebook frontend.
"""
#-----------------------------------------------------------------------------
# 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
#-----------------------------------------------------------------------------
Jonathan Frederic
Added widget.py
r14223 from copy import copy
Jonathan Frederic
Updates to widget.py...
r14232 from glob import glob
Jonathan Frederic
Added widget.py
r14223 import uuid
import sys
Jonathan Frederic
Updates to widget.py...
r14232 import os
Jonathan Frederic
Fix: added inspect import to widget.py
r14341 import inspect
Jonathan Frederic
Added missing types import
r14344 import types
Jonathan Frederic
Added widget.py
r14223
Jonathan Frederic
Updates to widget.py...
r14232 import IPython
Jonathan Frederic
Basic display logic...
r14229 from IPython.kernel.comm import Comm
from IPython.config import LoggingConfigurable
Jonathan Frederic
Added `visible` property to all widgets
r14311 from IPython.utils.traitlets import Unicode, Dict, List, Instance, Bool
Jonathan Frederic
Basic display logic...
r14229 from IPython.display import Javascript, display
Jonathan Frederic
Updates to widget.py...
r14232 from IPython.utils.py3compat import string_types
Jonathan Frederic
Cleaned up Python widget code.
r14283 #-----------------------------------------------------------------------------
# Classes
#-----------------------------------------------------------------------------
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 class Widget(LoggingConfigurable):
Jonathan Frederic
Added widget.py
r14223
Jonathan Frederic
Added event for widget construction
r14478 # Shared declarations (Class level)
widget_construction_callback = None
Jonathan Frederic
s/default_view_name/view_name
r14541 keys = ['view_name']
Jason Grout
Get rid of keys magic; make the keys very explicit
r14530
Jonathan Frederic
Added event for widget construction
r14478 def on_widget_constructed(callback):
"""Class method, registers a callback to be called when a widget is
constructed. The callback must have the following signature:
callback(widget)"""
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 Widget.widget_construction_callback = callback
Jonathan Frederic
Added event for widget construction
r14478
Jonathan Frederic
s/_handle_widget_constructed/_call_widget_constructed
r14542 def _call_widget_constructed(widget):
Jonathan Frederic
Added event for widget construction
r14478 """Class method, called when a widget is constructed."""
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 if Widget.widget_construction_callback is not None and callable(Widget.widget_construction_callback):
Widget.widget_construction_callback(widget)
Jonathan Frederic
Added event for widget construction
r14478
Jonathan Frederic
Added add_class and remove_class methods.
r14313
Jonathan Frederic
Added event for widget construction
r14478
# Public declarations (Instance level)
Jonathan Frederic
Cleaned up Python widget code.
r14283 target_name = Unicode('widget', help="""Name of the backbone model
registered in the frontend to create and sync this widget with.""")
Jonathan Frederic
s/default_view_name/view_name
r14541 view_name = Unicode(help="""Default view registered in the frontend
Jonathan Frederic
Cleaned up Python widget code.
r14283 to use to represent the widget.""")
Jonathan Frederic
Added add_class and remove_class methods.
r14313
Jonathan Frederic
Cleaned up Python widget code.
r14283 # Private/protected declarations
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 # todo: change this to a context manager
Jonathan Frederic
Fixed a bug that didn't allow callbacks to set a property...
r14392 _property_lock = (None, None) # Last updated (key, value) from the front-end. Prevents echo.
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 _comm = Instance('IPython.kernel.comm.Comm')
Jonathan Frederic
Added widget.py
r14223
Jonathan Frederic
Allow parent to be set after construction......
r14310 def __init__(self, **kwargs):
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Public constructor
"""
Jonathan Frederic
Added on_display callback
r14330 self._display_callbacks = []
Jonathan Frederic
Added support for custom widget msgs
r14387 self._msg_callbacks = []
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 super(Widget, self).__init__(**kwargs)
Jonathan Frederic
Added event for widget construction
r14478
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 self.on_trait_change(self._handle_property_changed, self.keys)
Jonathan Frederic
s/_handle_widget_constructed/_call_widget_constructed
r14542 Widget._call_widget_constructed(self)
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
Added widget.py
r14223 def __del__(self):
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Object disposal"""
Jonathan Frederic
Added widget.py
r14223 self.close()
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
Cleaned up Python widget code.
r14283
Jonathan Frederic
Added widget.py
r14223 def close(self):
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Close method. Closes the widget which closes the underlying comm.
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 When the comm is closed, all of the widget views are automatically
Jonathan Frederic
Cleaned up Python widget code.
r14283 removed from the frontend."""
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479 self._close_communication()
Jonathan Frederic
Added widget.py
r14223
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 @property
def comm(self):
if self._comm is None:
self._open_communication()
return self._comm
Jonathan Frederic
Re-decoupled comm_id from widget models
r14512
@property
def model_id(self):
Jonathan Frederic
Fixed typo in model_id property
r14527 return self.comm.comm_id
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
Cleaned up Python widget code.
r14283 # Event handlers
Jonathan Frederic
Added widget.py
r14223 def _handle_msg(self, msg):
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Called when a msg is recieved from the frontend"""
Jonathan Frederic
Added support for custom widget msgs
r14387 data = msg['content']['data']
Jonathan Frederic
Added `method` property to messages from the front-end
r14432 method = data['method']
Jonathan Frederic
Removed ViewWidget
r14538 # Handle backbone sync methods CREATE, PATCH, and UPDATE all in one.
if method == 'backbone' and 'sync_data' in data:
sync_data = data['sync_data']
self._handle_recieve_state(sync_data) # handles all methods
Jonathan Frederic
Added support for custom widget msgs
r14387
# Handle a custom msg from the front-end
Jonathan Frederic
Added `method` property to messages from the front-end
r14432 elif method == 'custom':
if 'custom_content' in data:
self._handle_custom_msg(data['custom_content'])
Jonathan Frederic
Added support for custom widget msgs
r14387
Jonathan Frederic
re-order handle custom msg and handle recieve state
r14558
def _handle_recieve_state(self, sync_data):
"""Called when a state is recieved from the frontend."""
for name in self.keys:
if name in sync_data:
try:
self._property_lock = (name, sync_data[name])
setattr(self, name, sync_data[name])
finally:
self._property_lock = (None, None)
Jonathan Frederic
Added support for custom widget msgs
r14387 def _handle_custom_msg(self, content):
"""Called when a custom msg is recieved."""
for handler in self._msg_callbacks:
if callable(handler):
argspec = inspect.getargspec(handler)
nargs = len(argspec[0])
# Bound methods have an additional 'self' argument
if isinstance(handler, types.MethodType):
nargs -= 1
# Call the callback
if nargs == 1:
handler(content)
elif nargs == 2:
handler(self, content)
else:
raise TypeError('Widget msg callback must ' \
'accept 1 or 2 arguments, not %d.' % nargs)
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
Added widget.py
r14223 def _handle_property_changed(self, name, old, new):
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 """Called when a property has been changed."""
Jonathan Frederic
Fixed a bug that didn't allow callbacks to set a property...
r14392 # Make sure this isn't information that the front-end just sent us.
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479 if self._property_lock[0] != name and self._property_lock[1] != new:
Jonathan Frederic
Added widget.py
r14223 # Send new state to frontend
Jonathan Frederic
Add state packet delta compression.
r14273 self.send_state(key=name)
Jonathan Frederic
Updates to widget.py...
r14232
Jonathan Frederic
Display handler now supports full kwargs
r14484 def _handle_displayed(self, **kwargs):
Jonathan Frederic
remove 3rd callback type from on_displayed
r14550 """Called when a view has been displayed for this widget instance"""
Jonathan Frederic
Added support for custom widget msgs
r14387 for handler in self._display_callbacks:
if callable(handler):
argspec = inspect.getargspec(handler)
nargs = len(argspec[0])
# Bound methods have an additional 'self' argument
if isinstance(handler, types.MethodType):
nargs -= 1
# Call the callback
if nargs == 0:
handler()
elif nargs == 1:
handler(self)
else:
Jonathan Frederic
Display handler now supports full kwargs
r14484 handler(self, **kwargs)
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
Cleaned up Python widget code.
r14283 # Public methods
def send_state(self, key=None):
"""Sends the widget state, or a piece of it, to the frontend.
Parameters
----------
key : unicode (optional)
A single property's name to sync with the frontend.
"""
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479 self._send({"method": "update",
Jonathan Frederic
Further indentation cleanup
r14514 "state": self.get_state()})
Jonathan Frederic
Cleaned up Python widget code.
r14283
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 def get_state(self, key=None):
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 """Gets the widget state, or a piece of it.
Jonathan Frederic
Cleaned up Python widget code.
r14283
Parameters
----------
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 key : unicode (optional)
A single property's name to get.
Jonathan Frederic
Cleaned up Python widget code.
r14283 """
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 state = {}
Jonathan Frederic
Updated set_css so it can handle a dictionary of keys and values.
r14322
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 # If a key is provided, just send the state of that key.
if key is None:
keys = self.keys[:]
Jonathan Frederic
Updated set_css so it can handle a dictionary of keys and values.
r14322 else:
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 keys = [key]
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 for k in keys:
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 value = getattr(self, k)
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 # a more elegant solution to encoding Widgets would be
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 # to tap into the JSON encoder and teach it how to deal
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 # with Widget objects, or maybe just teach the JSON
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 # encoder to look for a _repr_json property before giving
# up encoding
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 if isinstance(value, Widget):
Jonathan Frederic
Re-decoupled comm_id from widget models
r14512 value = value.model_id
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 elif isinstance(value, list) and len(value)>0 and isinstance(value[0], Widget):
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 # assume all elements of the list are widgets
Jonathan Frederic
Re-decoupled comm_id from widget models
r14512 value = [i.model_id for i in value]
Jason Grout
Remove the automatic _children_attr and _children_lists_attr....
r14487 state[k] = value
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 return state
Jonathan Frederic
Cleaned up Python widget code.
r14283
Jonathan Frederic
Added support for custom widget msgs
r14387 def send(self, content):
"""Sends a custom msg to the widget model in the front-end.
Parameters
----------
content : dict
Content of the message to send.
"""
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479 self._send({"method": "custom",
Jonathan Frederic
Further indentation cleanup
r14514 "custom_content": content})
Jonathan Frederic
Added support for custom widget msgs
r14387
def on_msg(self, callback, remove=False):
"""Register a callback for when a custom msg is recieved from the front-end
Parameters
----------
callback: method handler
Can have a signature of:
- callback(content)
- callback(sender, content)
remove: bool
True if the callback should be unregistered."""
if remove and callback in self._msg_callbacks:
self._msg_callbacks.remove(callback)
elif not remove and not callback in self._msg_callbacks:
self._msg_callbacks.append(callback)
Jonathan Frederic
Added on_display callback
r14330 def on_displayed(self, callback, remove=False):
"""Register a callback to be called when the widget has been displayed
Jonathan Frederic
Fixed doc string comments, removed extra space
r14332 Parameters
----------
Jonathan Frederic
Added on_display callback
r14330 callback: method handler
Can have a signature of:
- callback()
- callback(sender)
Jonathan Frederic
Display handler now supports full kwargs
r14484 - callback(sender, **kwargs)
kwargs from display call passed through without modification.
Jonathan Frederic
Added on_display callback
r14330 remove: bool
True if the callback should be unregistered."""
Jonathan Frederic
Added support for custom widget msgs
r14387 if remove and callback in self._display_callbacks:
Jonathan Frederic
Added on_display callback
r14330 self._display_callbacks.remove(callback)
Jonathan Frederic
Added support for custom widget msgs
r14387 elif not remove and not callback in self._display_callbacks:
Jonathan Frederic
Added on_display callback
r14330 self._display_callbacks.append(callback)
Jonathan Frederic
Cleaned up Python widget code.
r14283 # Support methods
Jonathan Frederic
Display handler now supports full kwargs
r14484 def _repr_widget_(self, **kwargs):
Jonathan Frederic
Cleaned up Python widget code.
r14283 """Function that is called when `IPython.display.display` is called on
Jonathan Frederic
Remove view_name from display
r14549 the widget."""
Jonathan Frederic
Added widget.py
r14223
Jonathan Frederic
Fixed _send so it can open a comm if needed....
r14548 # Show view. By sending a display message, the comm is opened and the
# initial state is sent.
Jonathan Frederic
Remove view_name from display
r14549 self._send({"method": "display"})
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 self._handle_displayed(**kwargs)
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479
def _open_communication(self):
"""Opens a communication with the front-end."""
# Create a comm.
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 if self._comm is None:
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479 self._comm = Comm(target_name=self.target_name)
self._comm.on_msg(self._handle_msg)
Jonathan Frederic
Remove redundent _handle_close method
r14480 self._comm.on_close(self._close_communication)
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 # first update
self.send_state()
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479
def _close_communication(self):
"""Closes a communication with the front-end."""
Jason Grout
Intermediate changes to javascript side of backbone widgets
r14486 if self._comm is not None:
Jonathan Frederic
Remove redundent _handle_close method
r14480 try:
self._comm.close()
finally:
self._comm = None
Jonathan Frederic
Decoupled Python Widget from Comm...
r14479
def _send(self, msg):
"""Sends a message to the model in the front-end"""
Jonathan Frederic
Fixed _send so it can open a comm if needed....
r14548 self.comm.send(msg)
Jonathan Frederic
Moved view widget into widget.py
r14516
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 class DOMWidget(Widget):
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 visible = Bool(True, help="Whether or not the widget is visible.")
# Private/protected declarations
_css = Dict() # Internal CSS property dict
Jonathan Frederic
s/Widget/DOMWidget s/BaseWidget/Widget
r14540 keys = ['visible', '_css'] + Widget.keys
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
def get_css(self, key, selector=""):
"""Get a CSS property of the widget. Note, this function does not
actually request the CSS from the front-end; Only properties that have
been set with set_css can be read.
Parameters
----------
key: unicode
CSS key
selector: unicode (optional)
JQuery selector used when the CSS key/value was set.
"""
if selector in self._css and key in self._css[selector]:
return self._css[selector][key]
else:
return None
def set_css(self, *args, **kwargs):
"""Set one or more CSS properties of the widget (shared among all of the
views). This function has two signatures:
Jonathan Frederic
Fixed comments for optional kwargs so they are redundant.
r14551 - set_css(css_dict, selector='')
- set_css(key, value, selector='')
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Parameters
----------
css_dict : dict
CSS key/value pairs to apply
key: unicode
CSS key
value
CSS value
selector: unicode (optional)
JQuery selector to use to apply the CSS key/value.
"""
selector = kwargs.get('selector', '')
Jonathan Frederic
Fixed comments for optional kwargs so they are redundant.
r14551 # Signature 1: set_css(css_dict, selector='')
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 if len(args) == 1:
if isinstance(args[0], dict):
for (key, value) in args[0].items():
Jonathan Frederic
send_state only once for dict signature of set_css
r14552 if not (key in self._css[selector] and value in self._css[selector][key]):
self._css[selector][key] = value
self.send_state('_css')
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 else:
raise Exception('css_dict must be a dict.')
Jonathan Frederic
Fixed comments for optional kwargs so they are redundant.
r14551 # Signature 2: set_css(key, value, selector='')
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 elif len(args) == 2 or len(args) == 3:
# Selector can be a positional arg if it's the 3rd value
if len(args) == 3:
selector = args[2]
if selector not in self._css:
self._css[selector] = {}
# Only update the property if it has changed.
key = args[0]
value = args[1]
if not (key in self._css[selector] and value in self._css[selector][key]):
self._css[selector][key] = value
self.send_state('_css') # Send new state to client.
else:
raise Exception('set_css only accepts 1-3 arguments')
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 def add_class(self, class_names, selector=""):
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 """Add class[es] to a DOM element
Parameters
----------
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 class_names: unicode or list
Class name(s) to add to the DOM element(s).
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 selector: unicode (optional)
JQuery selector to select the DOM element(s) that the class(es) will
be added to.
"""
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 class_list = class_names
if isinstance(list, class_list):
class_list = ' '.join(class_list)
Jason Grout
Fix the python side of the add/remove class functions to send custom messages
r14504 self.send({"msg_type": "add_class",
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 "class_list": class_list,
Jonathan Frederic
Further indentation cleanup
r14514 "selector": selector})
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 def remove_class(self, class_names, selector=""):
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 """Remove class[es] from a DOM element
Parameters
----------
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 class_names: unicode or list
Class name(s) to remove from the DOM element(s).
Jason Grout
Separate the display from the models on the python side, creating a BaseWidget class....
r14485 selector: unicode (optional)
JQuery selector to select the DOM element(s) that the class(es) will
be removed from.
"""
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 class_list = class_names
if isinstance(list, class_list):
class_list = ' '.join(class_list)
Jason Grout
Fix the python side of the add/remove class functions to send custom messages
r14504 self.send({"msg_type": "remove_class",
Jonathan Frederic
add/remove_class now can accept a list of classes
r14539 "class_list": class_list,
Jonathan Frederic
Further indentation cleanup
r14514 "selector": selector})