def bind(self, obj, name=None, bind_policy='unique', api=None,
includes=None, excludes=None):
""" Bind obj to name and make (by default) its public methods and
traits (ie. those not beginning with an underscore) scriptable. The
default value of name is the type of obj with the first character
forced to lower case. name may be a dotted name (eg. 'abc.def.xyz').
bind_policy determines what happens if the name is already bound. If
the policy is 'auto' then a numerical suffix will be added to the name,
if necessary, to make it unique. If the policy is 'unique' then an
exception is raised. If the policy is 'rebind' then the previous
binding is discarded. The default is 'unique'
If api is given then it is a class, or a list of classes, that define
the attributes that will be made scriptable.
Otherwise if includes is given it is a list of names of attributes that
will be made scriptable.
Otherwise all the public attributes of scripted_type will be made
scriptable except those in the excludes list.
"""
# Register the object.
self.new_object(obj, obj.__class__, name=name, bind_policy=bind_policy)
# Make it scriptable.
make_object_scriptable(obj, api=api, includes=includes,
excludes=excludes)
def bind(self, obj, name=None, bind_policy='unique', api=None,
includes=None, excludes=None):
""" Bind obj to name and make (by default) its public methods and
traits (ie. those not beginning with an underscore) scriptable. The
default value of name is the type of obj with the first character
forced to lower case. name may be a dotted name (eg. 'abc.def.xyz').
bind_policy determines what happens if the name is already bound. If
the policy is 'auto' then a numerical suffix will be added to the name,
if necessary, to make it unique. If the policy is 'unique' then an
exception is raised. If the policy is 'rebind' then the previous
binding is discarded. The default is 'unique'
If api is given then it is a class, or a list of classes, that define
the attributes that will be made scriptable.
Otherwise if includes is given it is a list of names of attributes that
will be made scriptable.
Otherwise all the public attributes of scripted_type will be made
scriptable except those in the excludes list.
"""
# Register the object.
self.new_object(obj, obj.__class__, name=name, bind_policy=bind_policy)
# Make it scriptable.
make_object_scriptable(obj, api=api, includes=includes,
excludes=excludes)
def create_scriptable_object(self, name):
"""Invoke the factory to create the object then make it scriptable."""
obj = self.factory()
sm = get_script_manager()
sm.bind_event = BindEvent(name=name, obj=obj)
make_object_scriptable(obj, self.api, self.includes, self.excludes)
return obj
