def test_trait_name_different_to_preference_name(self):
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The test here is to have a different name for the trait than the
# preference value (which is 'bgcolor').
color = Str
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Make some bindings.
bind_preference(acme_ui, 'color', 'acme.ui.bgcolor')
# Make sure the object was initialized properly.
self.assertEqual('blue', acme_ui.color)
# Change the width via the preferences node.
p.set('acme.ui.bgcolor', 'red')
self.assertEqual('color', listener.trait_name)
self.assertEqual('blue', listener.old)
self.assertEqual('red', listener.new)
return
def test_explicit_preferences(self):
""" explicit preferences """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Create an empty preferences node and use that in some of the
# bindings!
preferences = Preferences()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor', preferences)
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio', preferences)
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(0.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
return
def test_default_values(self):
""" instance scope preferences path """
p = self.preferences
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str('blue')
width = Int(50)
ratio = Float(1.0)
visible = Bool(True)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
return
def test_explicit_preferences(self):
""" explicit preferences """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Create an empty preferences node and use that in some of the
# bindings!
preferences = Preferences()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor', preferences)
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio', preferences)
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(0.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
return
def test_default_values(self):
""" instance scope preferences path """
p = self.preferences
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str('blue')
width = Int(50)
ratio = Float(1.0)
visible = Bool(True)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
return
def test_nested_set_in_trait_change_handler(self):
""" nested set in trait change handler """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
def _width_changed(self, trait_name, old, new):
""" Static trait change handler. """
self.ratio = 3.0
return
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Change the width via the preferences node. This should cause the
# ratio to get set via the static trait change handler on the helper.
p.set('acme.ui.width', 42)
self.assertEqual(42, acme_ui.width)
self.assertEqual('42', p.get('acme.ui.width'))
# Did the ratio get changed?
self.assertEqual(3.0, acme_ui.ratio)
self.assertEqual('3.0', p.get('acme.ui.ratio'))
return
def test_nested_set_in_trait_change_handler(self):
""" nested set in trait change handler """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
def _width_changed(self, trait_name, old, new):
""" Static trait change handler. """
self.ratio = 3.0
return
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Change the width via the preferences node. This should cause the
# ratio to get set via the static trait change handler on the helper.
p.set('acme.ui.width', 42)
self.assertEqual(42, acme_ui.width)
self.assertEqual('42', p.get('acme.ui.width'))
# Did the ratio get changed?
self.assertEqual(3.0, acme_ui.ratio)
self.assertEqual('3.0', p.get('acme.ui.ratio'))
return
def test_preference_binding(self):
""" preference binding """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Make sure we can set the preference via the helper...
acme_ui.bgcolor = 'yellow'
self.assertEqual('yellow', p.get('acme.ui.bgcolor'))
self.assertEqual('yellow', acme_ui.bgcolor)
# ... and that the correct trait change event was fired.
self.assertEqual(acme_ui, listener.obj)
self.assertEqual('bgcolor', listener.trait_name)
self.assertEqual('blue', listener.old)
self.assertEqual('yellow', listener.new)
# Make sure we can set the preference via the preferences node...
p.set('acme.ui.bgcolor', 'red')
self.assertEqual('red', p.get('acme.ui.bgcolor'))
self.assertEqual('red', acme_ui.bgcolor)
# ... and that the correct trait change event was fired.
self.assertEqual(acme_ui, listener.obj)
self.assertEqual('bgcolor', listener.trait_name)
self.assertEqual('yellow', listener.old)
self.assertEqual('red', listener.new)
# Make sure we can set a non-string preference via the helper...
acme_ui.ratio = 0.5
self.assertEqual('0.5', p.get('acme.ui.ratio'))
self.assertEqual(0.5, acme_ui.ratio)
# Make sure we can set a non-string preference via the node...
p.set('acme.ui.ratio', '0.75')
self.assertEqual('0.75', p.get('acme.ui.ratio'))
self.assertEqual(0.75, acme_ui.ratio)
return
def test_load_and_save(self):
""" load and save """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str('red')
width = Int(60)
ratio = Float(2.0)
visible = Bool(False)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly (with the values in
# the loaded .ini file *not* the trait defaults!).
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Make a change to one of the preference values.
p.set('acme.ui.bgcolor', 'yellow')
self.assertEqual('yellow', acme_ui.bgcolor)
self.assertEqual('yellow', p.get('acme.ui.bgcolor'))
# Save the preferences to a different file.
tmpdir = tempfile.mkdtemp()
tmp = join(tmpdir, 'tmp.ini')
p.save(tmp)
# Load the preferences again from that file.
p = set_default_preferences(Preferences())
p.load(tmp)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly (with the values in
# the .ini file *not* the trait defaults!).
self.assertEqual('yellow', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Clean up!
os.remove(tmp)
os.removedirs(tmpdir)
return
def test_preference_binding(self):
""" preference binding """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str
width = Int
ratio = Float
visible = Bool
acme_ui = AcmeUI()
acme_ui.on_trait_change(listener)
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the object was initialized properly.
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Make sure we can set the preference via the helper...
acme_ui.bgcolor = 'yellow'
self.assertEqual('yellow', p.get('acme.ui.bgcolor'))
self.assertEqual('yellow', acme_ui.bgcolor)
# ... and that the correct trait change event was fired.
self.assertEqual(acme_ui, listener.obj)
self.assertEqual('bgcolor', listener.trait_name)
self.assertEqual('blue', listener.old)
self.assertEqual('yellow', listener.new)
# Make sure we can set the preference via the preferences node...
p.set('acme.ui.bgcolor', 'red')
self.assertEqual('red', p.get('acme.ui.bgcolor'))
self.assertEqual('red', acme_ui.bgcolor)
# ... and that the correct trait change event was fired.
self.assertEqual(acme_ui, listener.obj)
self.assertEqual('bgcolor', listener.trait_name)
self.assertEqual('yellow', listener.old)
self.assertEqual('red', listener.new)
# Make sure we can set a non-string preference via the helper...
acme_ui.ratio = 0.5
self.assertEqual('0.5', p.get('acme.ui.ratio'))
self.assertEqual(0.5, acme_ui.ratio)
# Make sure we can set a non-string preference via the node...
p.set('acme.ui.ratio', '0.75')
self.assertEqual('0.75', p.get('acme.ui.ratio'))
self.assertEqual(0.75, acme_ui.ratio)
return
def test_load_and_save(self):
""" load and save """
p = self.preferences
p.load(self.example)
class AcmeUI(HasTraits):
""" The Acme UI class! """
# The traits that we want to initialize from preferences.
bgcolor = Str('red')
width = Int(60)
ratio = Float(2.0)
visible = Bool(False)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly (with the values in
# the loaded .ini file *not* the trait defaults!).
self.assertEqual('blue', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Make a change to one of the preference values.
p.set('acme.ui.bgcolor', 'yellow')
self.assertEqual('yellow', acme_ui.bgcolor)
self.assertEqual('yellow', p.get('acme.ui.bgcolor'))
# Save the preferences to a different file.
tmpdir = tempfile.mkdtemp()
tmp = join(tmpdir, 'tmp.ini')
p.save(tmp)
# Load the preferences again from that file.
p = set_default_preferences(Preferences())
p.load(tmp)
acme_ui = AcmeUI()
# Make some bindings.
bind_preference(acme_ui, 'bgcolor', 'acme.ui.bgcolor')
bind_preference(acme_ui, 'width', 'acme.ui.width')
bind_preference(acme_ui, 'ratio', 'acme.ui.ratio')
bind_preference(acme_ui, 'visible', 'acme.ui.visible')
# Make sure the helper was initialized properly (with the values in
# the .ini file *not* the trait defaults!).
self.assertEqual('yellow', acme_ui.bgcolor)
self.assertEqual(50, acme_ui.width)
self.assertEqual(1.0, acme_ui.ratio)
self.assertEqual(True, acme_ui.visible)
# Clean up!
os.remove(tmp)
os.removedirs(tmpdir)
return