Class enthought.traits.trait_handlers.TraitRange

API Reference for Enthought Tool Suite 2.7.1

Ensures that a trait attribute lies within a specified numeric range.

TraitRange is the underlying handler for the predefined Range() trait factory.

Any value assigned to a trait containing a TraitRange handler must be of the correct type and in the numeric range defined by the TraitRange instance. No automatic coercion takes place. For example:

class Person(HasTraits):
    age = Trait(0, TraitRange(0, 150))
    weight = Trait(0.0, TraitRange(0.0, None))

This example defines a Person class, which has an age trait attribute, which must be an integer/long in the range from 0 to 150, and a weight trait attribute, which must be a non-negative float value.

Base classes
Methods

Inherits from

TraitHandler: enthought.traits.trait_handlers.TraitHandler

Method summary

__init__(self, low = None, high = None, exclude_low = False, exclude_high = False)
float_validate(self, object, name, value)
get_editor(self, trait)
info(self)
int_validate(self, object, name, value)
long_validate(self, object, name, value)

Methods

__init__(self, low = None, high = None, exclude_low = False, exclude_high = False)

Creates a TraitRange handler.

Parameters

low : number

The minimum value that the trait can accept

high : number

The maximum value that the trait can accept

exclude_low : Boolean

Should the low value be exclusive (or inclusive)

exclude_high : Boolean

Should the high value be exclusive (or inclusive)

Description

The low and high values must be of the same Python numeric type, either int, long or float. Alternatively, one of the values may be None, to indicate that that portion of the range is unbounded. The exclude_low and exclude_high values can be used to specify whether the low and high values should be exclusive (or inclusive).
float_validate(self, object, name, value)
get_editor(self, trait)
info(self)
int_validate(self, object, name, value)
long_validate(self, object, name, value)

Copyright © 2002-2008 Enthought, Inc.