Add get_config_defaults.

theengineear · theengineear · commit db5fba7c616b · 2015-07-31T10:59:30.000+07:00
diff --git a/plotly/tests/test_core/test_tools/test_configuration.py b/plotly/tests/test_core/test_tools/test_configuration.py
@@ -0,0 +1,15 @@
+from __future__ import absolute_import
+
+from unittest import TestCase
+
+from plotly.tools import get_config_defaults, _FILE_CONTENT, CONFIG_FILE
+
+
+class TestGetConfigDefaults(TestCase):
+
+    def test_config_dict_is_equivalent_copy(self):
+
+        original = _FILE_CONTENT[CONFIG_FILE]
+        copy = get_config_defaults()
+        self.assertIsNot(copy, original)
+        self.assertEqual(copy, original)
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -85,6 +85,19 @@ def warning_on_one_line(message, category, filename, lineno,
     _file_permissions = False
 
 
+def get_config_defaults():
+    """
+    Convenience function to check current settings against defaults.
+
+    Example:
+
+        if plotly_domain != get_config_defaults()['plotly_domain']:
+            # do something
+
+    """
+    return dict(_FILE_CONTENT[CONFIG_FILE])  # performs a shallow copy
+
+
 def check_file_permissions():
     return _file_permissions
 
