MadButterfly: pyink/trait.py comparison

More doc

author	Thinker K.F. Li <thinker@codemud.net>
date	Sat, 12 Feb 2011 19:46:58 +0800
parents	22a79dcbaec6
children	1a4d15fe2c62

comparison

equal deleted inserted replaced

-:22a79dcbaec6
+:b0e54ae756f8
 # in an attribute, named 'provide_traits', defined in composition
 # class.  The attribute provide_traits of a composition class is a
 # dictionary mapping from require attributes of used traits to names
 # of attributes of the composition class.
 #
+# \verbatim
+# @composite
+# class foo(object):
+#     use_trait = (trait_a, trait_b)
+#     provide_traits = {trait_a.var_a: 'var_foo'}
+#
+#     var_foo = 'value of var_foo'
+#     pass
+# \endverbatim
+#
+# Like mapping require attributes of used traits, there is a map,
+# named method_map_traits, for methods of used traits.
+#
+# \verbatim
+# @composite
+# class foo(object):
+#     use_trait = (trait_a, trait_b)
+#     provide_traits = {trait_a.var_a: 'var_foo'}
+#     method_map_traits = {trait_a.xxx: 'hello')
+#
+#     var_foo = 'value of var_foo'
+#     pass
+# \endverbatim
+#
+# Previous example maps trait_a.xxx method to foo.hello method.
+# composite does not include methods that has a name prefixed by a '_'
+# charater.  But, you can still force it, by an explicity mapping in
+# method_map_traits, to include a method prefixed by a '_' character.
+#
 def composite(clazz):
 if not hasattr(clazz, 'use_traits'):
 raise KeyError, \
 '%s has no use_trait: it must be a list of traits' % (repr(clazz))
 traits = clazz.use_traits

Mercurial > MadButterfly