Class enthought.traits.trait_handlers.TraitTuple

API Reference for Enthought Tool Suite 3.2.0

Ensures that values assigned to a trait attribute are tuples of a specified length, with elements that are of specified types.

TraitTuple is the underlying handler for the predefined trait Tuple, and the trait factory Tuple().

For example:

rank = Range(1, 13)
suit = Trait('Hearts', 'Diamonds', 'Spades', 'Clubs')
class Card(HasTraits):
    value = Trait(TraitTuple(rank, suit))

This example defines a Card class, which has a value trait attribute, which must be a tuple of two elments. The first element must be an integer in the range from 1 to 13, and the second element must be one of the four strings, 'Hearts', 'Diamonds', 'Spades', or 'Clubs'.

Base classes
Attributes
Methods

Inherits from

TraitHandler: enthought.traits.trait_handlers.TraitHandler

Attributes

Inherited from base classes

Method summary

__init__(self, *args)
full_info(self, object, name, value)
get_editor(self, trait)
validate(self, object, name, value)

Inherited from base classes

arg_error(self, method, arg_num, object, name, value)
create_editor(self)
dup_arg_error(self, method, arg_num, object, name)
error(self, object, name, value)
info(self)
inner_traits(self)
is_valid(self, object, name, value)
keyword_error(self, method, object, name, value)
missing_arg_error(self, method, arg_num, object, name)
repr(self, value)
return_error(self, method, object, value)

Methods

__init__(self, *args)

Creates a TraitTuple handler.

Parameters

args : list of traits

Each trait_i specifies the type that the ith element of a tuple must be.

Description

Each trait_i must be either a trait, or a value that can be converted to a trait using the Trait() function. The resulting trait handler accepts values that are tuples of the same length as args, and whose ith element is of the type specified by trait_i.
full_info(self, object, name, value)
get_editor(self, trait)
validate(self, object, name, value)

© Copyright 2002-2009 Enthought, Inc.