API Reference for Enthought Tool Suite 3.2.0

Variables

• baseline_count_table_editor

  baseline_count_table_editor = TableEditor(columns = [ ClassColumn(name = 'name', label = 'Class Name', width = 0.23999999999999999, editable = False), ModuleColumn(name = 'name', label = 'Module Name', width = 0.40000000000000002, editable = False), ObjectColumn(name = 'baseline_count', label = 'Baseline', width = 0.089999999999999997, editable = False, format_func = commatize, horizontal_alignment = 'right'), ObjectColumn(name = 'current_count', label = 'Current', width = 0.089999999999999997, editable = False, format_func = commatize, horizontal_alignment = 'right'), ExpressionColumn(expression = 'object.baseline_count - object.current_count', label = 'Change', width = 0.089999999999999997, format_func = commatize, horizontal_alignment = 'right'), FractionColumn(expression = '(100.0 * (object.baseline_count - object.current_count))/object.baseline_count', label = '% Change', width = 0.089999999999999997, format = '%.2f%%', horizontal_alignment = 'right') ], other_columns = [ ObjectColumn(name = 'name', label = 'Fully Qualified Class Name', width = 0.62, editable = False) ], editable = False, configurable = True, auto_size = False, selection_bg_color = 16503697, selection_color = 'black', selection_mode = 'rows', selected = 'selected_items', dclick = 'filtered_items_dclick', show_toolbar = False)
  
  

• baseline_key_bindings

  baseline_key_bindings = KeyBindings(KeyBinding(binding1 = 'Ctrl-i', method_name = '_show_details_changed', description = 'Shows the instances of the selected baseline classes.'))
  
  

• counts_table_editor

  counts_table_editor = TableEditor(columns = [ ClassColumn(name = 'name', label = 'Class Name', width = 0.25, editable = False), ModuleColumn(name = 'name', label = 'Module Name', width = 0.45000000000000001, editable = False), ObjectColumn(name = 'instances', label = '# Instances', width = 0.14999999999999999, editable = False, format_func = commatize, horizontal_alignment = 'right'), ObjectColumn(name = 'change', label = 'Change', width = 0.14999999999999999, editable = False, format_func = commatize, horizontal_alignment = 'right') ], other_columns = [ ObjectColumn(name = 'name', label = 'Fully Qualified Class Name', width = 0.69999999999999996, editable = False) ], editable = False, configurable = True, auto_size = False, selection_bg_color = 16503697, selection_color = 'black', selection_mode = 'rows', selected = 'selected_counts', dclick = 'counts_dclick', show_toolbar = False)
  
  

• detail_key_bindings

  detail_key_bindings = KeyBindings(KeyBinding(binding1 = 'Ctrl-u', method_name = '_show_referrers_changed', description = 'Shows the hierarchy of objects that refer to the selected instance objects.'))
  
  

• detail_table_editor

  detail_table_editor = TableEditor(columns = [ ObjectColumn(name = 'object_id', label = 'Id', width = 0.5, editable = False, horizontal_alignment = 'right'), ObjectColumn(name = 'ref_count', label = 'Ref Count', width = 0.5, editable = False, horizontal_alignment = 'right') ], other_columns = [ ClassColumn(name = 'name', label = 'Class Name', width = 0.25, editable = False), ModuleColumn(name = 'name', label = 'Module Name', width = 0.45000000000000001, editable = False), ObjectColumn(name = 'name', label = 'Fully Qualified Class Name', width = 0.69999999999999996, editable = False) ], editable = False, configurable = True, auto_size = False, selection_bg_color = 16503697, selection_color = 'black', selection_mode = 'rows', selected = 'selected_instances', dclick = 'instances_dclick', show_toolbar = False)
  
  

• heap_browser_key_bindings

  heap_browser_key_bindings = KeyBindings(KeyBinding(binding1 = 'Ctrl-b', method_name = '_baseline_changed', description = 'Creates a new baseline set.'), KeyBinding(binding1 = 'Ctrl-d', method_name = '_show_details_changed', description = 'Shows the instances of the selected heap classes.'), KeyBinding(binding1 = 'Ctrl-k', method_name = 'edit_bindings', description = 'Edits the keyboard bindings.'), KeyBinding(binding1 = 'Ctrl-r', method_name = '_refresh_changed', description = 'Refreshes the heap statistics.'), KeyBinding(binding1 = 'Ctrl-c', method_name = '_set_filter_change_1', description = 'Sets the filter change value to 1.'), KeyBinding(binding1 = 'Ctrl-f', method_name = '_clear_filter', description = 'Resets all filter values back to their defaults.'), KeyBinding(binding1 = 'Ctrl-a', method_name = '_select_all', description = 'Selects all currently displayed count entries.'), KeyBinding(binding1 = 'Ctrl-Shift-a', method_name = '_unselect_all', description = 'Unselects all currently selected count entries.'), KeyBinding(binding1 = 'Ctrl-h', method_name = '_hide_selected_changed', description = 'Hides all currently selected count entries.'), KeyBinding(binding1 = 'Ctrl-s', method_name = '_show_selected_changed', description = 'Shows only the currently selected count entries.'), KeyBinding(binding1 = 'Ctrl-Shift-s', method_name = '_show_all_changed', description = 'Shows all count entries.'))
  
  

• ignored_classes

  Classes which should not show up in any of the statistics, since they are part of this tool itself:

  ignored_classes = set([ 'enthought.developer.tools.heap_browser.HB_ClassCount', 'enthought.developer.tools.heap_browser.HB_Referrer', 'enthought.developer.tools.heap_browser.HB_Referrers', 'enthought.developer.tools.heap_browser.HB_ReferrerHandler', 'enthought.developer.tools.heap_browser.HB_Detail', 'enthought.developer.tools.heap_browser.HB_InstanceDetail', 'enthought.developer.tools.heap_browser.HB_Baseline', 'enthought.developer.tools.heap_browser.HB_BaselineCount', 'enthought.developer.tools.heap_browser.HB_HeapBrowser' ])
  
  

• MAX_DETAILS

  The maximum number of detail items to show for a specific class:

  MAX_DETAILS = 16
  
  

• referrers_key_bindings

  referrers_key_bindings = KeyBindings(KeyBinding(binding1 = 'Ctrl-v', method_name = '_view_referrer_changed', description = 'Shows a view of the selected referrer object.'), KeyBinding(binding1 = 'Ctrl-z', method_name = '_zap_changed', description = 'Zaps the link from the selected referrer object to the referred to object.'))
  
  

• SequenceTypes

  The list of types we handle specially:

  SequenceTypes = (list, tuple)
  
  

• tree_editor

  tree_editor = TreeEditor(nodes = [ TreeNode(node_for = [ HB_Referrer ], auto_open = False, children = 'referrers', label = 'name') ], editable = False, selected = 'selected')
  
  

Classes

• ClassColumn
• FractionColumn
• HB_Baseline
• HB_BaselineCount
• HB_ClassCount - Information about a single class of heap instances.
• HB_Detail - Information about a single heap class.
• HB_HeapBrowser
• HB_InstanceDetail
• HB_Referrer - Describes the set of objects which refer to a specific object.
• HB_ReferrerHandler
• HB_Referrers
• ModuleColumn

Function summary

• object_name(object)

Functions

• object_name(object)

  Returns the 'name' of a specified object (based on its class and module name.

Imported Names

© Copyright 2002-2009 Enthought, Inc.