def test_about_pack_settings_signal(self):
handler = SettingsHandler()
handler.bind(SimpleWidget)
widget = SimpleWidget()
handler.initialize(widget)
fn = Mock()
widget.settingsAboutToBePacked.connect(fn)
handler.pack_data(widget)
self.assertEqual(1, fn.call_count)
handler.update_defaults(widget)
self.assertEqual(2, fn.call_count)
def test_about_pack_settings_signal(self):
handler = SettingsHandler()
handler.bind(SimpleWidget)
widget = SimpleWidget()
handler.initialize(widget)
fn = Mock()
widget.settingsAboutToBePacked.connect(fn)
handler.pack_data(widget)
self.assertEqual(1, fn.call_count)
handler.update_defaults(widget)
self.assertEqual(2, fn.call_count)
def test_initialize_copies_mutables(self):
handler = SettingsHandler()
handler.bind(SimpleWidget)
handler.defaults = dict(list_setting=[])
widget = SimpleWidget()
handler.initialize(widget)
widget2 = SimpleWidget()
handler.initialize(widget2)
self.assertNotEqual(id(widget.list_setting), id(widget2.list_setting))
def test_initialize_copies_mutables(self):
handler = SettingsHandler()
handler.bind(SimpleWidget)
handler.defaults = dict(list_setting=[])
widget = SimpleWidget()
handler.initialize(widget)
widget2 = SimpleWidget()
handler.initialize(widget2)
self.assertNotEqual(id(widget.list_setting), id(widget2.list_setting))
def test_initialize_with_no_provider(self, SettingProvider):
""":type SettingProvider: unittest.mock.Mock"""
handler = SettingsHandler()
handler.provider = Mock(get_provider=Mock(return_value=None))
provider = Mock()
SettingProvider.return_value = provider
widget = SimpleWidget()
# initializing an undeclared provider should display a warning
with warnings.catch_warnings(record=True) as w:
handler.initialize(widget)
self.assertEqual(1, len(w))
SettingProvider.assert_called_once_with(SimpleWidget)
provider.initialize.assert_called_once_with(widget, None)
def test_initialize_with_no_provider(self, SettingProvider):
""":type SettingProvider: unittest.mock.Mock"""
handler = SettingsHandler()
handler.provider = Mock(get_provider=Mock(return_value=None))
provider = Mock()
SettingProvider.return_value = provider
widget = SimpleWidget()
# initializing an undeclared provider should display a warning
with warnings.catch_warnings(record=True) as w:
handler.initialize(widget)
self.assertEqual(1, len(w))
SettingProvider.assert_called_once_with(SimpleWidget)
provider.initialize.assert_called_once_with(widget, None)
def test_initialize_widget(self):
handler = SettingsHandler()
handler.defaults = {'default': 42, 'setting': 1}
handler.provider = provider = Mock()
handler.widget_class = SimpleWidget
provider.get_provider.return_value = provider
widget = SimpleWidget()
def reset_provider():
provider.get_provider.return_value = None
provider.reset_mock()
provider.get_provider.return_value = provider
# No data
handler.initialize(widget)
provider.initialize.assert_called_once_with(widget, {
'default': 42,
'setting': 1
})
# Dictionary data
reset_provider()
handler.initialize(widget, {'setting': 5})
provider.initialize.assert_called_once_with(widget, {
'default': 42,
'setting': 5
})
# Pickled data
reset_provider()
handler.initialize(widget, pickle.dumps({'setting': 5}))
provider.initialize.assert_called_once_with(widget, {
'default': 42,
'setting': 5
})
def test_initialize_widget(self):
handler = SettingsHandler()
handler.defaults = {'default': 42, 'setting': 1}
handler.provider = provider = Mock()
handler.widget_class = SimpleWidget
provider.get_provider.return_value = provider
widget = SimpleWidget()
def reset_provider():
provider.get_provider.return_value = None
provider.reset_mock()
provider.get_provider.return_value = provider
# No data
handler.initialize(widget)
provider.initialize.assert_called_once_with(widget, {'default': 42,
'setting': 1})
# Dictionary data
reset_provider()
handler.initialize(widget, {'setting': 5})
provider.initialize.assert_called_once_with(widget, {'default': 42,
'setting': 5})
# Pickled data
reset_provider()
handler.initialize(widget, pickle.dumps({'setting': 5}))
provider.initialize.assert_called_once_with(widget, {'default': 42,
'setting': 5})
def test_initialize_migrates_settings(self):
handler = SettingsHandler()
with self.override_default_settings(SimpleWidget):
handler.bind(SimpleWidget)
widget = SimpleWidget()
migrate_settings = Mock()
with patch.object(SimpleWidget, "migrate_settings", migrate_settings):
# Old settings without version
settings = {"value": 5}
handler.initialize(widget, settings)
migrate_settings.assert_called_with(settings, 0)
migrate_settings.reset_mock()
# Settings with version
settings_with_version = dict(settings)
settings_with_version[VERSION_KEY] = 1
handler.initialize(widget, settings_with_version)
migrate_settings.assert_called_with(settings, 1)
def test_initialize_migrates_settings(self):
handler = SettingsHandler()
with self.override_default_settings(SimpleWidget):
handler.bind(SimpleWidget)
widget = SimpleWidget()
migrate_settings = Mock()
with patch.object(SimpleWidget, "migrate_settings", migrate_settings):
# Old settings without version
settings = {"value": 5}
handler.initialize(widget, settings)
migrate_settings.assert_called_with(settings, 0)
migrate_settings.reset_mock()
# Settings with version
settings_with_version = dict(settings)
settings_with_version[VERSION_KEY] = 1
handler.initialize(widget, settings_with_version)
migrate_settings.assert_called_with(settings, 1)
def test_fast_save_siblings_spill(self):
handler_mk1 = SettingsHandler()
with self.override_default_settings(SimpleWidgetMk1):
handler_mk1.bind(SimpleWidgetMk1)
widget_mk1 = SimpleWidgetMk1()
handler_mk1.fast_save(widget_mk1, "setting", -1)
handler_mk1.fast_save(widget_mk1, "component.int_setting", 1)
self.assertEqual(
handler_mk1.known_settings['setting'].default, -1)
self.assertEqual(
handler_mk1.known_settings['component.int_setting'].default, 1)
handler_mk1.initialize(widget_mk1, data=None)
handler_mk1.provider.providers["component"].initialize(
widget_mk1.component, data=None)
self.assertEqual(widget_mk1.setting, -1)
self.assertEqual(widget_mk1.component.int_setting, 1)
handler_mk2 = SettingsHandler()
with self.override_default_settings(SimpleWidgetMk2):
handler_mk2.bind(SimpleWidgetMk2)
widget_mk2 = SimpleWidgetMk2()
handler_mk2.initialize(widget_mk2, data=None)
handler_mk2.provider.providers["component"].initialize(
widget_mk2.component, data=None)
self.assertEqual(widget_mk2.setting, 42,
"spils defaults into sibling classes")
self.assertEqual(Component.int_setting.default, 42)
self.assertEqual(widget_mk2.component.int_setting, 42,
"spils defaults into sibling classes")
def test_fast_save_siblings_spill(self):
handler_mk1 = SettingsHandler()
with self.override_default_settings(SimpleWidgetMk1):
handler_mk1.bind(SimpleWidgetMk1)
widget_mk1 = SimpleWidgetMk1()
handler_mk1.fast_save(widget_mk1, "setting", -1)
handler_mk1.fast_save(widget_mk1, "component.int_setting", 1)
self.assertEqual(
handler_mk1.known_settings['setting'].default, -1)
self.assertEqual(
handler_mk1.known_settings['component.int_setting'].default, 1)
handler_mk1.initialize(widget_mk1, data=None)
handler_mk1.provider.providers["component"].initialize(
widget_mk1.component, data=None)
self.assertEqual(widget_mk1.setting, -1)
self.assertEqual(widget_mk1.component.int_setting, 1)
handler_mk2 = SettingsHandler()
with self.override_default_settings(SimpleWidgetMk2):
handler_mk2.bind(SimpleWidgetMk2)
widget_mk2 = SimpleWidgetMk2()
handler_mk2.initialize(widget_mk2, data=None)
handler_mk2.provider.providers["component"].initialize(
widget_mk2.component, data=None)
self.assertEqual(widget_mk2.setting, 42,
"spils defaults into sibling classes")
self.assertEqual(Component.int_setting.default, 42)
self.assertEqual(widget_mk2.component.int_setting, 42,
"spils defaults into sibling classes")
def test_initialize_component(self):
handler = SettingsHandler()
handler.defaults = {'default': 42}
provider = Mock()
handler.provider = Mock(get_provider=Mock(return_value=provider))
widget = SimpleWidget()
# No data
handler.initialize(widget)
provider.initialize.assert_called_once_with(widget, None)
# Dictionary data
provider.reset_mock()
handler.initialize(widget, {'setting': 5})
provider.initialize.assert_called_once_with(widget, {'setting': 5})
# Pickled data
provider.reset_mock()
handler.initialize(widget, pickle.dumps({'setting': 5}))
provider.initialize.assert_called_once_with(widget, {'setting': 5})
def test_initialize_component(self):
handler = SettingsHandler()
handler.defaults = {'default': 42}
provider = Mock()
handler.provider = Mock(get_provider=Mock(return_value=provider))
widget = SimpleWidget()
# No data
handler.initialize(widget)
provider.initialize.assert_called_once_with(widget, None)
# Dictionary data
provider.reset_mock()
handler.initialize(widget, {'setting': 5})
provider.initialize.assert_called_once_with(widget, {'setting': 5})
# Pickled data
provider.reset_mock()
handler.initialize(widget, pickle.dumps({'setting': 5}))
provider.initialize.assert_called_once_with(widget, {'setting': 5})
