API Reference for Enthought Tool Suite 3.0.1

Classes

• Adapter - The base class for all traits adapters
• DefaultAdapterFactory - An adapter factory for producing cached or categorized adapters.

Function summary

• adapts(from_, to, extra = None, factory = None, cached = False, when = '')

Functions

• adapts(from_, to, extra = None, factory = None, cached = False, when = '')

  A class advisor for declaring adapters.

  Parameters

  from_ : type or interface

  What the adapter adapts from, or a list of such types or interfaces (the '_' suffix is used because 'from' is a Python keyword).

  to : type or interface

  What the adapter adapts to, or a list of such types or interfaces.

  factory : callable

  An (optional) factory for actually creating the adapters. This is any callable that takes a single argument which is the object to be adapted. The factory should return an adapter if it can perform the adaptation and None if it cannot.

  The following arguments are ignored if factory is specified:

  cached : Boolean

  Should the adapters be cached? If an adapter is cached, then the factory will produce at most one adapter per instance.

  when : A Python expression

  Selects which instances of a particular type can be adapted by this factory. The expression is evaluated in a namespace that contains a single name adaptee, which is bound to the object to be adapted (e.g., 'adaptee.is_folder').

Imported Names

© Copyright 2002-2008 Enthought, Inc.