API Reference for Enthought Tool Suite 2.7.1

Variables

• ClassTypes

  ClassTypes = (ClassType, TypeType)
  
  

• CoercableTypes

  Mapping of coercable types.

  CoercableTypes = { Name('LongType') : Tuple([Const(11), Name('long'), Name('int')]), Name('FloatType') : Tuple([Const(11), Name('float'), Name('int')]), Name('ComplexType') : Tuple([Const(11), Name('complex'), Name('float'), Name('int')]), Name('UnicodeType') : Tuple([Const(11), Name('unicode'), Name('str')]) }
  
  

• ComplexTypes

  ComplexTypes = (float, int)
  
  

• Missing

  Singleton object that indicates that a method argument is missing from a type-checked method signature.

  Missing = _Missing()
  
  

• Self

  Singleton object that references the current 'object'.

  Self = _Self()
  
  

• SequenceTypes

  SequenceTypes = (ListType, TupleType)
  
  

• StringTypes

  StringTypes = (StringType, UnicodeType, IntType, LongType, FloatType, ComplexType)
  
  

• TraitNotifier

  TraitNotifier = '__trait_notifier__'
  
  

• TypeTypes

  TypeTypes = (StringType, UnicodeType, IntType, LongType, FloatType, ComplexType, ListType, TupleType, DictType, BooleanType)
  
  

• Undefined

  Singleton object that indicates that a trait attribute has not yet had a value set (i.e., its value is undefined. This object is used instead of None, because None is often has other meanings, such as that a value is not used. When a trait attribute is first assigned a value, and its associated trait notification handlers are called, Undefined is passed as the old parameter, to indicate that the attribute previously had no value.

  Undefined = _Undefined()
  
  

Function summary

• add_article(name)
• class_of(object)
• get_module_name(level = 2)
• strx(arg)
• traits_home()
• user_name_for(name)

Functions

• add_article(name)

  Returns a string containing the correct indefinite article ('a' or 'an') prefixed to the specified string.

• class_of(object)

  Returns a string containing the class name of an object with the correct indefinite article ('a' or 'an') preceding it (e.g., 'an Image', 'a PlotValue').

• get_module_name(level = 2)
• strx(arg)

  Wraps the built-in str() function to raise a TypeError if the argument is not of a type in StringTypes.

• traits_home()

  Gets the path to the Traits home directory.

• user_name_for(name)

  Returns a "user-friendly" version of a string, with the first letter capitalized and with underscore characters replaced by spaces. For example, user_name_for('user_name_for') returns 'User name for'.

Imported Names

Copyright © 2002-2008 Enthought, Inc.