Added toml io support.

Author: fabiocaccamo

benedict/dicts/__init__.py

@@ -55,6 +55,11 @@ def fromkeys(cls, sequence, value=None):
     def from_json(s, **kwargs):
         return IODict.from_json(s, **kwargs)
 
+    @staticmethod
+    @benediction
+    def from_toml(s, **kwargs):
+        return IODict.from_toml(s, **kwargs)
+
     @staticmethod
     @benediction
     def from_yaml(s, **kwargs):

benedict/dicts/io.py

@@ -61,16 +61,24 @@ def _from_any_string(s, **kwargs):
             d = IODict.from_json(s, **kwargs)
         except ValueError:
             try:
-                d = IODict.from_yaml(s, **kwargs)
+                d = IODict.from_toml(s, **kwargs)
             except ValueError:
-                d = None
+                try:
+                    d = IODict.from_yaml(s, **kwargs)
+                except ValueError:
+                    d = None
         return d
 
     @staticmethod
     def from_json(s, **kwargs):
         return IODict._load_and_decode(s,
             io_util.decode_json, **kwargs)
 
+    @staticmethod
+    def from_toml(s, **kwargs):
+        return IODict._load_and_decode(s,
+            io_util.decode_toml, **kwargs)
+
     @staticmethod
     def from_yaml(s, **kwargs):
         return IODict._load_and_decode(s,
@@ -81,6 +89,11 @@ def to_json(self, filepath=None, **kwargs):
             encoder=io_util.encode_json,
             filepath=filepath, **kwargs)
 
+    def to_toml(self, filepath=None, **kwargs):
+        return IODict._encode_and_save(self,
+            encoder=io_util.encode_toml,
+            filepath=filepath, **kwargs)
+
     def to_yaml(self, filepath=None, **kwargs):
         return IODict._encode_and_save(self,
             encoder=io_util.encode_yaml,

benedict/utils/io_util.py

@@ -4,6 +4,7 @@
 import json
 import os
 import requests
+import toml
 import yaml
 
 
@@ -12,6 +13,11 @@ def decode_json(s, **kwargs):
     return data
 
 
+def decode_toml(s, **kwargs):
+    data = toml.loads(s, **kwargs)
+    return data
+
+
 def decode_yaml(s, **kwargs):
     kwargs.setdefault('Loader', yaml.Loader)
     data = yaml.load(s, **kwargs)
@@ -23,6 +29,11 @@ def encode_json(d, **kwargs):
     return data
 
 
+def encode_toml(d, **kwargs):
+    data = toml.dumps(d, **kwargs)
+    return data
+
+
 def encode_yaml(d, **kwargs):
     data = yaml.dump(d, **kwargs)
     return data

tests/input/invalid-content.toml

@@ -0,0 +1,2 @@
+Lorem ipsum consectetur sint id aute officia sed excepteur consectetur labore laboris dolore in labore consequat ut in eu ut deserunt.
+Elit aliqua velit aliquip voluptate consequat reprehenderit occaecat dolor ut esse aute laboris cillum fugiat esse est laborum.

tests/input/valid-content.toml

@@ -0,0 +1,34 @@
+# This is a TOML document.
+# https://pypi.org/project/toml/
+
+title = "TOML Example"
+
+[owner]
+name = "Tom Preston-Werner"
+dob = 1979-05-27T07:32:00-08:00 # First class dates
+
+[database]
+server = "192.168.1.1"
+ports = [ 8001, 8001, 8002 ]
+connection_max = 5000
+enabled = true
+
+[servers]
+
+    # Indentation (tabs and/or spaces) is allowed but not required
+    [servers.alpha]
+    ip = "10.0.0.1"
+    dc = "eqdc10"
+
+    [servers.beta]
+    ip = "10.0.0.2"
+    dc = "eqdc10"
+
+[clients]
+data = [ ["gamma", "delta"], [1, 2] ]
+
+# Line breaks are OK when inside arrays
+hosts = [
+    "alpha",
+    "omega"
+]

tests/test_benedict.py

@@ -230,6 +230,23 @@ def test_from_json(self):
         self.assertTrue(isinstance(d, benedict))
         self.assertEqual(d, { 'a': 1, 'b': 2, 'c': 3, })
 
+    def test_from_toml(self):
+        j = """
+            a = 1
+
+            [b]
+            c = 3
+            d = 4
+        """
+        # static method
+        d = benedict.from_toml(j)
+        self.assertTrue(isinstance(d, dict))
+        self.assertEqual(d, { 'a':1, 'b':{ 'c':3, 'd':4 },})
+        # constructor
+        d = benedict(j)
+        self.assertTrue(isinstance(d, dict))
+        self.assertEqual(d, { 'a':1, 'b':{ 'c':3, 'd':4 },})
+
     def test_from_yaml(self):
         j = """
             a: 1

tests/test_io_dict.py

@@ -73,7 +73,7 @@ def test_from_json_with_invalid_file(self):
             d = IODict(filepath)
 
     def test_from_json_with_valid_url_valid_content(self):
-        url = 'https://jsonplaceholder.typicode.com/users'
+        url = 'https://raw.githubusercontent.com/fabiocaccamo/python-benedict/master/tests/input/valid-content.json'
         # static method
         d = IODict.from_json(url)
         self.assertTrue(isinstance(d, dict))
@@ -127,6 +127,113 @@ def test_to_json_file(self):
 
     # YAML
 
+    def test_from_toml_with_valid_data(self):
+        j = """
+            a = 1
+
+            [b]
+            c = 3
+            d = 4
+        """
+        # static method
+        d = IODict.from_toml(j)
+        self.assertTrue(isinstance(d, dict))
+        self.assertEqual(d, { 'a':1, 'b':{ 'c':3, 'd':4 },})
+        # constructor
+        d = IODict(j)
+        self.assertTrue(isinstance(d, dict))
+        self.assertEqual(d, { 'a':1, 'b':{ 'c':3, 'd':4 },})
+
+    def test_from_toml_with_invalid_data(self):
+        j = 'Lorem ipsum est in ea occaecat nisi officia.'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_toml(j)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(j)
+
+    def test_from_toml_with_valid_file_valid_content(self):
+        filepath = self.input_path('valid-content.toml')
+        # static method
+        d = IODict.from_toml(filepath)
+        self.assertTrue(isinstance(d, dict))
+        # constructor
+        d = IODict(filepath)
+        self.assertTrue(isinstance(d, dict))
+
+    def test_from_toml_with_valid_file_invalid_content(self):
+        filepath = self.input_path('invalid-content.toml')
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_toml(filepath)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(filepath)
+
+    def test_from_toml_with_invalid_file(self):
+        filepath = self.input_path('invalid-file.toml')
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_toml(filepath)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(filepath)
+
+    # def test_from_toml_with_valid_url_valid_content(self):
+    #     url = 'https://raw.githubusercontent.com/fabiocaccamo/python-benedict/master/tests/input/valid-content.toml'
+    #     # static method
+    #     d = IODict.from_toml(url)
+    #     self.assertTrue(isinstance(d, dict))
+    #     # constructor
+    #     d = IODict(url)
+    #     self.assertTrue(isinstance(d, dict))
+
+    def test_from_toml_with_valid_url_invalid_content(self):
+        url = 'https://github.com/fabiocaccamo/python-benedict'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_toml(url)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(url)
+
+    def test_from_toml_with_invalid_url(self):
+        url = 'https://github.com/fabiocaccamo/python-benedict-invalid'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_toml(url)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(url)
+
+    def test_to_toml(self):
+        d = IODict({
+            'x': 7,
+            'y': 8,
+            'z': 9,
+            'a': 1,
+            'b': 2,
+            'c': 3,
+        })
+        s = d.to_toml()
+        self.assertEqual(d, IODict.from_toml(s))
+
+    def test_to_toml_file(self):
+        d = IODict({
+            'x': 7,
+            'y': 8,
+            'z': 9,
+            'a': 1,
+            'b': 2,
+            'c': 3,
+        })
+        filepath = self.output_path('test_to_toml_file.toml')
+        s = d.to_toml(filepath=filepath)
+        self.assertTrue(d, os.path.isfile(filepath))
+        self.assertEqual(d, IODict.from_toml(filepath))
+
+
     def test_from_yaml_with_valid_data(self):
         j = """
             a: 1
@@ -179,14 +286,14 @@ def test_from_yaml_with_invalid_file(self):
         with self.assertRaises(ValueError):
             d = IODict(filepath)
 
-    # def test_from_yaml_with_valid_url_valid_content(self):
-    #     url = 'https://github.com/fabiocaccamo/python-benedict/tests/input/valid-content.yml'
-    #     # static method
-    #     d = IODict.from_yaml(url)
-    #     self.assertTrue(isinstance(d, dict))
-    #     # constructor
-    #     d = IODict(url)
-    #     self.assertTrue(isinstance(d, dict))
+    def test_from_yaml_with_valid_url_valid_content(self):
+        url = 'https://raw.githubusercontent.com/fabiocaccamo/python-benedict/master/tests/input/valid-content.yml'
+        # static method
+        d = IODict.from_yaml(url)
+        self.assertTrue(isinstance(d, dict))
+        # constructor
+        d = IODict(url)
+        self.assertTrue(isinstance(d, dict))
 
     def test_from_yaml_with_valid_url_invalid_content(self):
         url = 'https://github.com/fabiocaccamo/python-benedict'