API Reference for Enthought Tool Suite 3.2.0

Variables

• cb_db_lock

  The lock used to manage access to the class browser data base:

  cb_db_lock = Lock()
  
  

• cb_tree_editor

  Define a tree-only version:

  cb_tree_editor = TreeEditor(editable = False, selected = 'object', nodes = cb_tree_nodes)
  
  

• cb_tree_nodes

  Common tree nodes:

  cb_tree_nodes = [ TreeNode(node_for = [ ClassBrowserPaths ], auto_open = True, auto_close = True, children = 'paths', label = '=Python Path'), ObjectTreeNode(node_for = [ CBPath ], label = 'path', auto_close = True), ObjectTreeNode(node_for = [ CBPackage ], label = 'name', auto_close = True, icon_group = 'package', icon_open = 'package'), ObjectTreeNode(node_for = [ CBModule, CBModuleFile ], label = 'name', children = 'ignore', auto_close = True, icon_group = 'module', icon_open = 'module'), ObjectTreeNode(node_for = [ CBClass ], label = 'name', auto_close = True, icon_group = 'class', icon_open = 'class'), ObjectTreeNode(node_for = [ CBMethod ], label = 'name', icon_group = 'method', icon_open = 'method') ]
  
  

• module_analyzer

  Create a singleton module analyzer:

  module_analyzer = ModuleAnalyzer()
  
  

Classes

• CBClass
• CBMethod
• CBModule
• CBModuleFile
• CBPackage
• CBPackageBase
• CBPath
• CBTreeNodeObject
• ClassBrowser
• ClassBrowserPaths
• ModuleAnalyzer

Function summary

• class_browser_for(paths, show_methods = True)
• get_cb_db(mode = 'r')
• get_pyclbr(file_path, python_path, update_only = False)

Functions

• class_browser_for(paths, show_methods = True)

  Displays a class browser.

• get_cb_db(mode = 'r')

  Gets a reference to the class browser database.

• get_pyclbr(file_path, python_path, update_only = False)

  Returns the 'pyclbr' class browser data for a specified file.

Imported Names

© Copyright 2002-2009 Enthought, Inc.