""" A view containing the contents of a Python shell namespace. """ # Enthought library imports. from envisage.plugins.python_shell.api import IPythonShell from envisage.plugins.ipython_shell.api import INamespaceView from pyface.workbench.api import View from traits.api import Property, implements, Instance, \ Str, HasTraits from traitsui.api import Item, TreeEditor, Group from traitsui.api import View as TraitsView from traitsui.value_tree import DictNode, StringNode, \ value_tree_nodes from pyface.timer.api import Timer from pyface.api import GUI def search_namespace(namespace, string, depth=3): """ Iterator on a dictionnary-like object. Given a namespace, search recursively for a name containing the string in the enclosed modules and classes. """ if depth==0: raise StopIteration for child_name in namespace: child = namespace[child_name] if string in child_name: yield child_name, child if hasattr(child, '__dict__'): for suitable_child_name, suitable_child in \ search_namespace(child.__dict__, string, depth=depth-1): yield ('%s.%s' % (child_name, suitable_child_name), suitable_child) def filter_namespace(namespace, string, depth=3): """ Return a flattened dictionnary to the depth given, with only the keys matching the given name. """ out_dict = dict() for key, item in search_namespace(namespace, string, depth=depth): out_dict[key] = item return out_dict def explore(node): """ Small helper function to graphically edit an object. """ # FIXME: This is really very dumb. The view used should be made # better. The logics should probably be put in the nodes themselves, # subclassing them. name = node.name obj = node.value class MyClass(HasTraits): the_object = obj view = TraitsView(Item('the_object', style='custom', show_label=False), resizable=True, title=name, width=600, ) return MyClass().edit_traits() class NamespaceNode(DictNode): """ Subclass of the DictNode for the namespace purposes. """ def tno_get_icon ( self, node, is_expanded ): """ Returns the icon for a specified object. We overwrite this method because we don't have a default icon for this object. """ return ('@icons:dict_node') def tno_get_children ( self, node ): """ Gets the object's children. We overwrite this method for a nicer label on the objects. """ node_for = self.node_for items = self.value.items() items.sort( lambda l, r: cmp( l[0], r[0] ) ) if len( items ) > 500: return ([ self.node_for( k, v ) for k, v in items[: 250 ] ] + [ StringNode( value = '...', readonly = True ) ] + [ self.node_for( k, v ) for k, v in items[ -250: ] ]) return [ self.node_for( k, v ) for k, v in items ] ################################################################################ class NamespaceView(View): """ A view containing the contents of the Python shell namespace. """ implements(INamespaceView) #### 'IView' interface #################################################### # The part's globally unique identifier. id = 'envisage.plugins.ipython_shell.namespace_view' # The view's name. name = 'Namespace' # The default position of the view relative to the item specified in the # 'relative_to' trait. position = 'left' #### 'NamespaceView' interface ############################################ # The different tree nodes tree_nodes = Property(depends_on='search_text') # Search text search_text = Str tree_editor = Property(depends_on="ui") # The timer used to refresh the ui _refresh_tree_nodes_timer = Instance(Timer) def __refresh_tree_nodes_timer_default(self): return Timer(100, self._refresh_tree_nodes) ########################################################################### # 'View' interface. ########################################################################### traits_view = TraitsView( Group(Item('search_text', label='Search')), Item( 'tree_nodes', id = 'table', editor = TreeEditor( auto_open=1, hide_root=True, editable=False, nodes=value_tree_nodes, on_dclick='object._explore', ), springy = True, resizable = True, show_label = False ), resizable = True, ) def create_control(self, parent): """ Creates the toolkit-specific control that represents the view. 'parent' is the toolkit-specific control that is the view's parent. """ self.ui = self.edit_traits(parent=parent, kind='subpanel') # Register the view as a service. self.window.application.register_service(INamespaceView, self) shell = self.window.application.get_service(IPythonShell) if shell is not None: shell.on_trait_change(self._on_names_changed, 'names') self._on_names_changed(shell.names) return self.ui.control def destroy_control(self): """ Destroys the toolkit-specific control that represents the view. """ super(NamespaceView, self).destroy_control() # Remove the namespace change handler shell= self.window.application.get_service(IPythonShell) if shell is not None: shell.on_trait_change( self._on_names_changed, 'names', remove=True ) ########################################################################### # 'NamespaceView' interface. ########################################################################### #### Properties ########################################################### def _get_tree_nodes(self): """ Property getter. """ shell = self.window.application.get_service(IPythonShell) # Cater for an un-initialized python shell view if shell is None: return NamespaceNode(value={}, readonly=True) filtered_namespace = dict() for name in shell.names: filtered_namespace[name] = shell.lookup(name) if not self.search_text == '': filtered_namespace = filter_namespace(filtered_namespace, self.search_text) return NamespaceNode(value=filtered_namespace, readonly=True) def _get_tree_editor(self): """ Walk the editor list to retrieve the instance of the tree editor currently used. """ for editor in self.ui._editors: print editor return self.ui._editors[-1] def _refresh_tree_nodes(self): """ Callback called by a timer to refresh the UI. The UI is refreshed by a timer to buffer the refreshes, in order not to slow down the execution engine. """ self.trait_property_changed('tree_nodes', None) self._refresh_tree_nodes_timer.Stop() ########################################################################### # Private interface. ########################################################################### #### Trait change handlers ################################################ def _on_names_changed(self, new): """ Dynamic trait change handler. """ if not self._refresh_tree_nodes_timer.IsRunning(): GUI.invoke_later(self._refresh_tree_nodes_timer.Start) def _explore(self, object): """ Displays a view of the object. """ explore(object) #### EOF ######################################################################