/usr/share/pyshared/traitsui/value_tree.py is in python-traitsui 4.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 | #------------------------------------------------------------------------------
#
# Copyright (c) 2006, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
#
# Author: David C. Morrill
# Date: 01/05/2006
#
#------------------------------------------------------------------------------
""" Defines tree node classes and editors for various types of values.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
import inspect
from types import FunctionType, MethodType
from traits.api import Any, Bool, HasPrivateTraits, HasTraits, Instance, List, Str
from .tree_node import ObjectTreeNode, TreeNode, TreeNodeObject
from .editors.tree_editor import TreeEditor
#-------------------------------------------------------------------------------
# 'SingleValueTreeNodeObject' class:
#-------------------------------------------------------------------------------
class SingleValueTreeNodeObject ( TreeNodeObject ):
""" A tree node for objects of types that have a single value.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# The parent of this node
parent = Instance( TreeNodeObject )
# Name of the value
name = Str
# User-specified override of the default label
label = Str
# The value itself
value = Any
# Is the value readonly?
readonly = Bool( False )
#---------------------------------------------------------------------------
# Returns whether chidren of this object are allowed or not:
#---------------------------------------------------------------------------
def tno_allows_children ( self, node ):
""" Returns whether this object can have children (False for this
class).
"""
return False
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children (False for this class).
"""
return False
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be renamed:
#---------------------------------------------------------------------------
def tno_can_rename ( self, node ):
""" Returns whether the object's children can be renamed (False for
this class).
"""
return False
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be copied:
#---------------------------------------------------------------------------
def tno_can_copy ( self, node ):
""" Returns whether the object's children can be copied (True for this
class).
"""
return True
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be deleted:
#---------------------------------------------------------------------------
def tno_can_delete ( self, node ):
""" Returns whether the object's children can be deleted (False for
this class).
"""
return False
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be inserted (or just
# appended):
#---------------------------------------------------------------------------
def tno_can_insert ( self, node ):
""" Returns whether the object's children can be inserted (False,
meaning children are appended, for this class).
"""
return False
#---------------------------------------------------------------------------
# Returns the icon for a specified object:
#---------------------------------------------------------------------------
def tno_get_icon ( self, node, is_expanded ):
""" Returns the icon for a specified object.
"""
return ('@icons:%s_node' % self.__class__.__name__[ : -4 ].lower())
#---------------------------------------------------------------------------
# Sets the label for a specified node:
#---------------------------------------------------------------------------
def tno_set_label ( self, node, label ):
""" Sets the label for a specified object.
"""
if label == '?':
label = ''
self.label = label
#---------------------------------------------------------------------------
# Gets the label to display for a specified object:
#---------------------------------------------------------------------------
def tno_get_label ( self, node ):
""" Gets the label to display for a specified object.
"""
if self.label != '':
return self.label
if self.name == '':
return self.format_value( self.value )
return '%s: %s' % ( self.name, self.format_value( self.value ) )
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return repr( value )
#---------------------------------------------------------------------------
# Returns the correct node type for a specified value:
#---------------------------------------------------------------------------
def node_for ( self, name, value ):
""" Returns the correct node type for a specified value.
"""
for type, node in basic_types():
if isinstance( value, type ):
break
else:
node = OtherNode
if inspect.isclass( value ):
node = ClassNode
elif hasattr( value, '__class__' ):
node = ObjectNode
return node( parent = self,
name = name,
value = value,
readonly = self.readonly )
#-------------------------------------------------------------------------------
# 'MultiValueTreeNodeObject' class:
#-------------------------------------------------------------------------------
class MultiValueTreeNodeObject ( SingleValueTreeNodeObject ):
""" A tree node for objects of types that have multiple values.
"""
#---------------------------------------------------------------------------
# Returns whether chidren of this object are allowed or not:
#---------------------------------------------------------------------------
def tno_allows_children ( self, node ):
""" Returns whether this object can have children (True for this class).
"""
return True
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children (True for this class).
"""
return True
#-------------------------------------------------------------------------------
# 'StringNode' class:
#-------------------------------------------------------------------------------
class StringNode ( SingleValueTreeNodeObject ):
""" A tree node for strings.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
n = len( value )
if len( value ) > 80:
value = '%s...%s' % ( value[ :42 ], value[ -35: ] )
return '%s [%d]' % ( repr( value ), n )
#-------------------------------------------------------------------------------
# 'NoneNode' class:
#-------------------------------------------------------------------------------
class NoneNode ( SingleValueTreeNodeObject ):
""" A tree node for None values.
"""
pass
#-------------------------------------------------------------------------------
# 'BoolNode' class:
#-------------------------------------------------------------------------------
class BoolNode ( SingleValueTreeNodeObject ):
""" A tree node for Boolean values.
"""
pass
#-------------------------------------------------------------------------------
# 'IntNode' class:
#-------------------------------------------------------------------------------
class IntNode ( SingleValueTreeNodeObject ):
""" A tree node for integer values.
"""
pass
#-------------------------------------------------------------------------------
# 'FloatNode' class:
#-------------------------------------------------------------------------------
class FloatNode ( SingleValueTreeNodeObject ):
""" A tree node for floating point values.
"""
pass
#-------------------------------------------------------------------------------
# 'ComplexNode' class:
#-------------------------------------------------------------------------------
class ComplexNode ( SingleValueTreeNodeObject ):
""" A tree node for complex number values.
"""
pass
#-------------------------------------------------------------------------------
# 'OtherNode' class:
#-------------------------------------------------------------------------------
class OtherNode ( SingleValueTreeNodeObject ):
""" A tree node for single-value types for which there is not another
node type.
"""
pass
#-------------------------------------------------------------------------------
# 'TupleNode' class:
#-------------------------------------------------------------------------------
class TupleNode ( MultiValueTreeNodeObject ):
""" A tree node for tuples.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'Tuple(%d)' % len( value )
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children, based on the length of
the tuple.
"""
return (len( self.value ) > 0)
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
node_for = self.node_for
value = self.value
if len( value ) > 500:
return ([ node_for( '[%d]' % i, x )
for i, x in enumerate( value[ : 250 ] ) ] +
[ StringNode( value = '...', readonly = True ) ] +
[ node_for( '[%d]' % i, x )
for i, x in enumerate( value[ -250: ] ) ])
return [ node_for( '[%d]' % i, x ) for i, x in enumerate( value ) ]
#-------------------------------------------------------------------------------
# 'ListNode' class:
#-------------------------------------------------------------------------------
class ListNode ( TupleNode ):
""" A tree node for lists.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'List(%d)' % len( value )
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be deleted:
#---------------------------------------------------------------------------
def tno_can_delete ( self, node ):
""" Returns whether the object's children can be deleted.
"""
return (not self.readonly)
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be inserted (or just
# appended):
#---------------------------------------------------------------------------
def tno_can_insert ( self, node ):
""" Returns whether the object's children can be inserted (vs.
appended).
"""
return (not self.readonly)
#-------------------------------------------------------------------------------
# 'SetNode' class:
#-------------------------------------------------------------------------------
class SetNode ( ListNode ):
""" A tree node for sets.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'Set(%d)' % len( value )
#-------------------------------------------------------------------------------
# 'ArrayNode' class:
#-------------------------------------------------------------------------------
class ArrayNode ( TupleNode ):
""" A tree node for arrays.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'Array(%s)' % ','.join( [ str( n ) for n in value.shape ] )
#-------------------------------------------------------------------------------
# 'DictNode' class:
#-------------------------------------------------------------------------------
class DictNode ( TupleNode ):
""" A tree node for dictionaries.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'Dict(%d)' % len( value )
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
node_for = self.node_for
items = [ ( repr( k ), v ) for k, v in self.value.items() ]
items.sort( lambda l, r: cmp( l[0], r[0] ) )
if len( items ) > 500:
return ([ node_for( '[%s]' % k, v ) for k, v in items[: 250 ] ] +
[ StringNode( value = '...', readonly = True ) ] +
[ node_for( '[%s]' % k, v ) for k, v in items[ -250: ] ])
return [ node_for( '[%s]' % k, v ) for k, v in items ]
#---------------------------------------------------------------------------
# Returns whether or not the object's children can be deleted:
#---------------------------------------------------------------------------
def tno_can_delete ( self, node ):
""" Returns whether the object's children can be deleted.
"""
return (not self.readonly)
#-------------------------------------------------------------------------------
# 'FunctionNode' class:
#-------------------------------------------------------------------------------
class FunctionNode ( SingleValueTreeNodeObject ):
""" A tree node for functions
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return 'Function %s()' % ( value.func_code.co_name )
#---------------------------------------------------------------------------
# 'MethodNode' class:
#---------------------------------------------------------------------------
class MethodNode ( MultiValueTreeNodeObject ):
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
type = 'B'
if value.im_self is None:
type = 'Unb'
return '%sound method %s.%s()' % (
type,
value.im_class.__name__,
value.im_func.func_code.co_name )
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children.
"""
return (self.value.im_func != None)
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
return [ self.node_for( 'Object', self.value.im_self ) ]
#-------------------------------------------------------------------------------
# 'ObjectNode' class:
#-------------------------------------------------------------------------------
class ObjectNode ( MultiValueTreeNodeObject ):
""" A tree node for objects.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
try:
klass = value.__class__.__name__
except:
klass = '???'
return '%s(0x%08X)' % ( klass, id( value ) )
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children.
"""
try:
return (len( self.value.__dict__ ) > 0)
except:
return False
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
items = [ ( k, v ) for k, v in self.value.__dict__.items() ]
items.sort( lambda l, r: cmp( l[0], r[0] ) )
return [ self.node_for( '.' + k, v ) for k, v in items ]
#-------------------------------------------------------------------------------
# 'ClassNode' class:
#-------------------------------------------------------------------------------
class ClassNode ( ObjectNode ):
""" A tree node for classes.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return value.__name__
#-------------------------------------------------------------------------------
# 'TraitsNode' class:
#-------------------------------------------------------------------------------
class TraitsNode ( ObjectNode ):
""" A tree node for traits.
"""
#---------------------------------------------------------------------------
# Returns whether or not the object has children:
#---------------------------------------------------------------------------
def tno_has_children ( self, node ):
""" Returns whether the object has children.
"""
return (len( self._get_names() ) > 0)
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
names = self._get_names()
names.sort()
value = self.value
node_for = self.node_for
nodes = []
for name in names:
try:
item_value = getattr( value, name, '<unknown>' )
except Exception, excp:
item_value = '<%s>' % excp
nodes.append( node_for( '.' + name, item_value ) )
return nodes
#---------------------------------------------------------------------------
# Gets the names of all defined traits/attributes:
#---------------------------------------------------------------------------
def _get_names ( self ):
""" Gets the names of all defined traits or attributes.
"""
value = self.value
names = {}
for name in value.trait_names( type = lambda x: x != 'event' ):
names[ name ] = None
for name in value.__dict__.keys():
names[ name ] = None
return names.keys()
#---------------------------------------------------------------------------
# Sets up/Tears down a listener for 'children replaced' on a specified
# object:
#---------------------------------------------------------------------------
def tno_when_children_replaced ( self, node, listener, remove ):
""" Sets up or removes a listener for children being replaced on a
specified object.
"""
self._listener = listener
self.value.on_trait_change( self._children_replaced, remove = remove,
dispatch = 'ui' )
def _children_replaced ( self ):
self._listener( self )
#---------------------------------------------------------------------------
# Sets up/Tears down a listener for 'children changed' on a specified
# object:
#---------------------------------------------------------------------------
def tno_when_children_changed ( self, node, listener, remove ):
""" Sets up or removes a listener for children being changed on a
specified object.
"""
pass
#-------------------------------------------------------------------------------
# 'RootNode' class:
#-------------------------------------------------------------------------------
class RootNode ( MultiValueTreeNodeObject ):
""" A root node.
"""
#---------------------------------------------------------------------------
# Returns the formatted version of the value:
#---------------------------------------------------------------------------
def format_value ( self, value ):
""" Returns the formatted version of the value.
"""
return ''
#---------------------------------------------------------------------------
# Gets the object's children:
#---------------------------------------------------------------------------
def tno_get_children ( self, node ):
""" Gets the object's children.
"""
return [ self.node_for( '', self.value ) ]
#-------------------------------------------------------------------------------
# Define the mapping of object types to nodes:
#-------------------------------------------------------------------------------
_basic_types = None
def basic_types ( ):
global _basic_types
if _basic_types is None:
# Create the mapping of object types to nodes:
_basic_types = [
( type( None ), NoneNode ),
( str, StringNode ),
( unicode, StringNode ),
( bool, BoolNode ),
( int, IntNode ),
( float, FloatNode ),
( complex, ComplexNode ),
( tuple, TupleNode ),
( list, ListNode ),
( set, SetNode ),
( dict, DictNode ),
( FunctionType, FunctionNode ),
( MethodType, MethodNode ),
( HasTraits, TraitsNode )
]
try:
from numpy import array
_basic_types.append( ( type( array( [ 1 ] ) ), ArrayNode ) )
except ImportError:
pass
return _basic_types
#-------------------------------------------------------------------------------
# '_ValueTree' class:
#-------------------------------------------------------------------------------
class _ValueTree ( HasPrivateTraits ):
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# List of arbitrary Python values contained in the tree:
values = List( SingleValueTreeNodeObject )
#-------------------------------------------------------------------------------
# Defines the value tree editor(s):
#-------------------------------------------------------------------------------
# Nodes in a value tree:
value_tree_nodes = [
ObjectTreeNode(
node_for = [ NoneNode, StringNode, BoolNode, IntNode, FloatNode,
ComplexNode, OtherNode, TupleNode, ListNode, ArrayNode,
DictNode, SetNode, FunctionNode, MethodNode, ObjectNode,
TraitsNode, RootNode, ClassNode ] )
]
# Editor for a value tree:
value_tree_editor = TreeEditor(
auto_open = 3,
hide_root = True,
editable = False,
nodes = value_tree_nodes
)
# Editor for a value tree with a root:
value_tree_editor_with_root = TreeEditor(
auto_open = 3,
editable = False,
nodes = [
ObjectTreeNode(
node_for = [ NoneNode, StringNode, BoolNode, IntNode, FloatNode,
ComplexNode, OtherNode, TupleNode, ListNode, ArrayNode,
DictNode, SetNode, FunctionNode, MethodNode,
ObjectNode, TraitsNode, RootNode, ClassNode ]
),
TreeNode( node_for = [ _ValueTree ],
auto_open = True,
children = 'values',
move = [ SingleValueTreeNodeObject ],
copy = False,
label = '=Values',
icon_group = 'traits_node',
icon_open = 'traits_node' )
]
)
#-------------------------------------------------------------------------------
# Defines a 'ValueTree' trait:
#-------------------------------------------------------------------------------
# Trait for a value tree:
ValueTree = Instance( _ValueTree, (), editor = value_tree_editor_with_root )
|