registry: Fix some config values being reset when running upkeep

For example, with `supybot.protocols.http.proxy`:

When upkeep is being executed, it runs the flushers:

https://github.com/progval/Limnoria/blob/246f4d3e626cdbb1d744ba9c4e06c704d8c30a95/src/world.py#L148-L150

In the main limnoria script, it registers a flusher that saves the registry to disk:

https://github.com/progval/Limnoria/blob/246f4d3e626cdbb1d744ba9c4e06c704d8c30a95/src/scripts/limnoria.py#L243-L252

When saving the registry to disk, the code instantiates the class with its default value to print it out in the file:

https://github.com/progval/Limnoria/blob/246f4d3e626cdbb1d744ba9c4e06c704d8c30a95/src/registry.py#L149-L159

Instantiating the class calls `setValue()` by default:

https://github.com/progval/Limnoria/blob/246f4d3e626cdbb1d744ba9c4e06c704d8c30a95/src/registry.py#L347-L348

supybot.protocols.http.proxy uses a custom type that changes global state when `setValue()` is called:

https://github.com/progval/Limnoria/blob/246f4d3e626cdbb1d744ba9c4e06c704d8c30a95/src/conf.py#L1416-L1432


Fixed GH-1349.

Author: BlankEclair

src/registry.py

@@ -148,7 +148,12 @@ def close(registry, filename, private=True):
                 if value._showDefault:
                     lines.append('#\n')
                     try:
-                        x = value.__class__(value._default, value._help)
+                        # We set setDefault to False and manually call
+                        # Value._setValue, just in case the class inherits
+                        # Value.setValue to set some global state (#1349)
+                        x = value.__class__(value._default, value._help,
+                            setDefault=False)
+                        x.value = value._default
                     except Exception as e:
                         exception('Exception instantiating default for %s:' %
                                   value._name)

test/test_registry.py

@@ -224,6 +224,24 @@ def testSpacesValues(self):
             registry.open_registry(filename)
             self.assertEqual(conf.supybot.networks.test.password(), ' foo ')
 
+    def testSetValueUncalledOnClose(self):
+        values_set = 0
+        class StringWithSetLogging(registry.String):
+            def setValue(self, v):
+                nonlocal values_set
+                values_set += 1
+
+                super(StringWithSetLogging, self).setValue(v)
+
+        group = registry.Group()
+        group.setName('group')
+        conf.registerGlobalValue(group, 'string', StringWithSetLogging('test', 'help'))
+        group.string.set('mrrp')
+
+        filename = conf.supybot.directories.conf.dirize('setvaluecalls.conf')
+        registry.close(group, filename)
+        self.assertEqual(values_set, 2)
+
     def testReload(self):
         import supybot.world as world
         with conf.supybot.reply.whenAddressedBy.chars.context('@'):