adds support for declaring options in subclasses, with overrides via inheritance

Brian Luft · Brian Luft · commit ef943baa8243 · 2011-02-03T15:04:13.000-08:00
diff --git a/pyflot/__init__.py b/pyflot/__init__.py
@@ -1,7 +1,24 @@
-from functools import partial, wraps
+import collections
+from functools import partial
+import inspect
 import json
 
 
+def update(d, u):
+    """
+    Recursively update nested dicts
+
+    Credit: Alex Martelli
+    """
+    for k, v in u.iteritems():
+        if isinstance(v, collections.Mapping):
+            r = update(d.get(k, {}), v)
+            d[k] = r
+        else:
+            d[k] = u[k]
+    return d
+
+
 class MissingDataException(Exception):
     """Exception raised when a series does not contain
     any data points"""
@@ -29,6 +46,15 @@ def __init__(self):
         self._series = []
         self._options = {}
 
+        #apply any options specified starting with the top
+        #of the inheritance chain
+        bases = list(inspect.getmro(self.__class__))
+        bases.reverse()
+        for base in bases:
+            if hasattr(base, 'options'):
+                update(self._options, base.options)
+
+
     @property
     def series_json(self):
         """
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -10,6 +10,16 @@
 )
 S1, = SERIES
 
+FAKE_NESTED_OPTIONS = {
+    'level1': {
+        'level2': {
+            'a':1, 
+            'level3': {
+                'b':2}}},
+    'c':3}
+
+
+
 class TestFlot(unittest.TestCase):
 
     def setUp(self):
@@ -64,11 +74,40 @@ def test_series_json(self):
         self.assertEqual(json.dumps([series]), self.flot.series_json)
 
     def test_series_with_label_json(self):
-    	"make sure series with label converts to JSON properly"
+        "make sure series with label converts to JSON properly"
         series = {'data': S1, 'label': 'label1'}
         self.flot.add_series(S1, 'label1')
         self.assertEqual(json.dumps([series]), self.flot.series_json)
-    
-    def test_options_json(self):
+
+    def test_empty_options_json(self):
         "make sure conversion to JSON works for default options"
         self.assertEqual("{}", self.flot.options_json)
+
+    def test_options(self):
+        "make sure options are applied correctly for a Flot subclass" 
+        class MyFlot(Flot):
+            options = FAKE_NESTED_OPTIONS
+
+        f = MyFlot()
+        self.assertEqual(f._options, FAKE_NESTED_OPTIONS)
+        self.assertEqual(f.options_json,
+                json.dumps(FAKE_NESTED_OPTIONS))
+
+    def test_options_inheritance(self):
+        "make sure options in an inheritance chain are applied correctly"
+        class MyFlot(Flot):
+            options = FAKE_NESTED_OPTIONS
+
+        class AnotherFlot(MyFlot):
+            options = {
+                'level1': {
+                    'd': 4,
+                    'level2': {
+                        'a': 10}}}
+
+        f = AnotherFlot()
+        self.assertEqual(f._options,
+                {'level1': {'d': 4, 'level2': {'a':10, 'level3': {'b':2}}}, 'c':3})
+        #TODO will the dumped dict string match work across platforms?
+        self.assertEqual(f.options_json,
+                 '{"level1": {"level2": {"a": 10, "level3": {"b": 2}}, "d": 4}, "c": 3}')
