API Reference for Enthought Tool Suite 3.0.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)
  
  

• python_version

  python_version = (vi[0] + (float(vi[1]) / 10.0))
  
  

• SequenceTypes

  SequenceTypes = (ListType, TupleType)
  
  

• StringTypes

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

• TraitNotifier

  TraitNotifier = '__trait_notifier__'
  
  

• TraitsCache

  The standard Traits property cache prefix:

  TraitsCache = '_traits_cache_'
  
  

• 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 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()
  
  

• vi

  Set the Python version being used:

  vi = sys.version_info
  
  

Traits

• 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()
  
  

• Uninitialized

  When the first reference to a trait is a 'get' reference, the default value of the trait is implicitly assigned and returned as the value of the trait. Because of this implicit assignment, a trait change notification is generated with the Uninitialized object as the 'old' value of the trait, and the default trait value as the 'new' value. This allows other parts of the traits package to recognize the assignment as the implicit default value assignment, and treat it specially.

  Uninitialized = Uninitialized()
  
  

Classes

• Missing
• Self
• Uninitialized - The singleton value of this class represents the uninitialized state of a trait and is specified as the 'old' value in the trait change notification that occurs when the value of a trait is read before being set.

Function summary

• add_article(name)
• class_of(object)
• get_module_name(level = 2)
• get_resource_path(level = 2)
• is_none(value)
• is_str(value)
• not_event(value)
• not_false(value)
• not_none(value)
• strx(arg)
• traits_home()
• user_name_for(name)
• verify_path(path)
• xgetattr(object, xname, default = Undefined)
• xsetattr(object, xname, value)

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)

  Returns the name of the module that the caller's caller is located in.

• get_resource_path(level = 2)

  Returns a resource path calculated from the caller's stack.

• is_none(value)
• is_str(value)
• not_event(value)
• not_false(value)
• not_none(value)
• 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'.

• verify_path(path)

  Verify that a specified path exists, and try to create it if it does not exist.

• xgetattr(object, xname, default = Undefined)

  Returns the value of an extended object attribute name of the form: name[.name2[.name3...]].

• xsetattr(object, xname, value)

  Sets the value of an extended object attribute name of the form: name[.name2[.name3...]].

Imported Names

© Copyright 2002-2008 Enthought, Inc.