API Reference for Enthought Tool Suite 2.7.1

Variables

• BaseTraits

  BaseTraits = '__base_traits__'
  
  

• ClassTraits

  ClassTraits = '__class_traits__'
  
  

• DefaultTraitsView

  The default Traits View name

  DefaultTraitsView = 'traits_view'
  
  

• FunctionTypes

  FunctionTypes = (FunctionType, CTraitMethod)
  
  

• InstanceTraits

  InstanceTraits = '__instance_traits__'
  
  

• MethodTypes

  MethodTypes = (MethodType, CTraitMethod)
  
  

• PrefixTraits

  PrefixTraits = '__prefix_traits__'
  
  

• SubclassTraits

  SubclassTraits = '__subclass_traits__'
  
  

• VetoableEvent

  VetoableEvent = Event(Vetoable)
  
  

• ViewTraits

  ViewTraits = '__view_traits__'
  
  

• WrapperTypes

  WrapperTypes = (StaticAnyTraitChangeNotifyWrapper, StaticTraitChangeNotifyWrapper)
  
  

Classes

• HasPrivateTraits - This class ensures that any public object attribute that does not have an explicit or wildcard trait definition results in an exception, but "private" attributes (whose names start with '_') have an initial value of None, and are not type-checked
• HasStrictTraits - This class guarantees that any object attribute that does not have an explicit or wildcard trait definition results in an exception
• HasTraits - Enables any Python class derived from it to have trait atttributes
• MetaHasTraits
• MetaHasTraitsObject
• PropertyDependency
• SingletonHasPrivateTraits - Singleton class that supports trait attributes, with private attributes being unchecked.
• SingletonHasStrictTraits - Singleton class that supports strict trait attributes
• SingletonHasTraits - Singleton class that support trait attributes.
• traits_super
• Vetoable
• ViewElement

Function summary

• method(return_type = Any, *arg_types, **kwarg_types)
• trait_method(func, return_type, **arg_types)
• ViewElements()

Functions

• method(return_type = Any, *arg_types, **kwarg_types)

  Declares that the method defined immediately following a call to this function is type-checked.

  Parameters

  return_type : type

  The type returned by the type-checked method. Must be either a trait or a value that can be converted to a trait using the Trait() function. The default of Any means that the return value is not type-checked.

  arg_types : zero or more types

  The types of positional parameters of the type-checked method. Each value must either a trait or a value that can be converted to a trait using the Trait() function.

  kwarg_types : zero or more keyword = type pairs

  Type names and types of keyword parameters of the type-checked method. The type portion of the parameter must be either a trait or a value that can be converted to a trait using the Trait() function.

  Description

  Whenever the type-checked method is called, the method() function ensures that each parameter passed to the method of the type specified by arg_types and kwarg_types, and that the return value is of the type specified by return_type. It is an error to specify both positional and keyword definitions for the same method parameter. If a parameter defined by the type-checked method is not referenced in the method() call, the parameter is not type-checked (i.e., its type is implicitly set to Any). If the call to method() signature contains an arg_types or kwarg_types parameter that does not correspond to a parameter in the type-checked method definition, a TraitError exception is raised.

• trait_method(func, return_type, **arg_types)

  Factory function for creating type-checked methods.

  Parameters

  func : function

  The method to be type-checkd

  return_type : trait or a value that can be converted to a trait using Trait()

  The return type of the method

  arg_types : zero or more 'keyword = trait' pairs

  Argument names and types of parameters of the type-checked method. The trait portion of each pair must be a trait or a value that can be converted to a trait using Trait().

• ViewElements()

Imported Names

Copyright © 2002-2008 Enthought, Inc.