API Reference for Enthought Tool Suite 3.2.0

Variables

• CTRAIT_TYPE

  base type for all traits

  CTRAIT_TYPE = None
  
  

• HAS_TRAITS_BASES

  traits base classes -- constructed later

  HAS_TRAITS_BASES = Set()
  
  

• TRAITS_PRIMITIVES

  traits primitives

  TRAITS_PRIMITIVES = Set([ %s for x in [ 'Trait' ] ])
  
  

• warnings

  warnings = None
  
  

Classes

• Attribute - documentable object definition
• Class - documentable class definition
• DocObject - documentable object parent class

  Notable attributes:

  • name : name of object

  • file : filename (path relative to top of tree) of file in which object

    is defined

  • lineno : line on which object is defined

  • parent_module:

    DocObject for module in which the object is defined

  • docstring:

    documentation for object (Python docstring if available)

  • children:

    DocObject nodes that are "children" of this object

    (e.g

  • Function - documentable function
  • Module - documentable module

  Function summary

  • build_class_hierarchy(module_list)
  • check_has_traits_import(name)
  • check_trait_import(name)
  • import_obj(name)

  Functions

  • build_class_hierarchy(module_list)

    Returns ( [ top_class1, top_class2, ... ],
              { top_class1 : [ subclasses, ... ],
                top_class2 : [ subclasses, ... ],
                ...
              } )
    

  • check_has_traits_import(name)
  • check_trait_import(name)
  • import_obj(name)

  Imported Names

  Local name	Refers to
  alpha_sort	enthought.endo.util.alpha_sort
  ast	compiler.ast
  local_warnings	warnings
  Namespace	enthought.endo.namespace.Namespace
  Set	sets.Set
  sys	sys
  types	types

  © Copyright 2002-2009 Enthought, Inc.