Class enthought.traits.trait_handlers.TraitString

API Reference for Enthought Tool Suite 3.2.0

Ensures that a trait attribute value is a string that satisfied some additional, optional constraints.

The optional constraints include minimum and maximum lengths, and a regular expression that the string must match.

If the value assigned to the trait attribute is a Python numeric type, the TraitString handler first coerces the value to a string. Values of other non-string types result in a TraitError being raised. The handler then makes sure that the resulting string is within the specified length range and that it matches the regular expression.

Example

class Person(HasTraits):
    name = Trait('', TraitString(maxlen=50, regex=r'^[A-Za-z]*$'))

This example defines a Person class with a name attribute, which must be a string of between 0 and 50 characters that consist of only upper and lower case letters.

Base classes
Attributes
Methods

Inherits from

TraitHandler: enthought.traits.trait_handlers.TraitHandler

Attributes

Inherited from base classes

Method summary

__getstate__(self)
__init__(self, minlen = 0, maxlen = sys.maxint, regex = '')
__setstate__(self, state)
info(self)
validate(self, object, name, value)
validate_len(self, object, name, value)
validate_regex(self, object, name, value)
validate_str(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)
full_info(self, object, name, value)
get_editor(self, trait = None)
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

__getstate__(self)
__init__(self, minlen = 0, maxlen = sys.maxint, regex = '')

Creates a TraitString handler.

Parameters

minlen : integer

The minimum length allowed for the string

maxlen : integer

The maximum length allowed for the string

regex : string

A Python regular expression that the string must match
__setstate__(self, state)
info(self)
validate(self, object, name, value)
validate_len(self, object, name, value)
validate_regex(self, object, name, value)
validate_str(self, object, name, value)

© Copyright 2002-2009 Enthought, Inc.