API Reference for Enthought Tool Suite 3.0.1

Variables

• INVALID_TRAIT_TYPE

  Exception message template.

  INVALID_TRAIT_TYPE = 'extension points must be "List"s e.g. List, List(Int) but a value of %s was specified.'
  
  

Classes

• ExtensionPoint - A trait type used to declare and access extension points

Function summary

• contributes_to(id)

Functions

• contributes_to(id)

  A factory for extension point decorators!

  As an alternative to making contributions via traits, you can use this decorator to mark any method on a 'Plugin' as contributing to an extension point (note this is only used on 'Plugin' instances!).

  e.g. Using a trait you might have something like:

  class MyPlugin(Plugin):
      messages = List(contributes_to='acme.messages')
  
      def _messages_default(self):
          return ['Hello', 'Hola']
  

  whereas, using the decorator, it would be:

  class MyPlugin(Plugin):
      @contributes_to('acme.messages')
      def _get_messages(self):
          return ['Hello', 'Hola']
  

  There is not much in it really, but the decorator version looks a little less like 'magic' since it doesn't require the developer to know about Traits default initializers. However, if you know that you will want to dynamically change your contributions then use the trait version because all you have to do is change the value of the trait and the framework will react accordingly.

Imported Names

© Copyright 2002-2008 Enthought, Inc.