Added yaml 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_yaml(s, **kwargs):
+        return IODict.from_yaml(s, **kwargs)
+
     @benediction
     def __getitem__(self, key):
         return super(benedict, self).__getitem__(key)

benedict/dicts/io.py

@@ -13,7 +13,7 @@ def __init__(self, *args, **kwargs):
         # if first argument is string,
         # try to decode it using all decoders.
         if len(args) and isinstance(args[0], string_types):
-            d = IODict._from_string(args[0])
+            d = IODict._from_any_string(args[0])
             if d and isinstance(d, dict):
                 args = list(args)
                 args[0] = d
@@ -32,7 +32,16 @@ def _load_and_decode(s, decoder, **kwargs):
                 content = io_util.read_file(s)
             else:
                 content = s
-            d = decoder(content, **kwargs)
+            # decode content using the given decoder
+            data = decoder(content, **kwargs)
+            if isinstance(data, dict):
+                d = data
+            elif isinstance(data, list):
+                # force list to dict
+                d = { 'values':data }
+            else:
+                raise ValueError(
+                    'Invalid data type: {}, expected dict or list.'.format(type(data)))
         except Exception as e:
             raise ValueError(
                 'Invalid data or url or filepath input argument: {}\n{}'.format(s, text_type(e)))
@@ -46,20 +55,33 @@ def _encode_and_save(d, encoder, filepath=None, **kwargs):
         return s
 
     @staticmethod
-    def _from_string(s, **kwargs):
+    def _from_any_string(s, **kwargs):
         d = None
         try:
             d = IODict.from_json(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_yaml(s, **kwargs):
+        return IODict._load_and_decode(s,
+            io_util.decode_yaml, **kwargs)
+
     def to_json(self, filepath=None, **kwargs):
         return IODict._encode_and_save(self,
             encoder=io_util.encode_json,
             filepath=filepath, **kwargs)
+
+    def to_yaml(self, filepath=None, **kwargs):
+        return IODict._encode_and_save(self,
+            encoder=io_util.encode_yaml,
+            filepath=filepath, **kwargs)

benedict/utils/io_util.py

@@ -4,15 +4,28 @@
 import json
 import os
 import requests
+import yaml
 
 
 def decode_json(s, **kwargs):
     data = json.loads(s, **kwargs)
-    return { 'values':data } if isinstance(data, list) else data
+    return data
+
+
+def decode_yaml(s, **kwargs):
+    kwargs.setdefault('Loader', yaml.Loader)
+    data = yaml.load(s, **kwargs)
+    return data
 
 
 def encode_json(d, **kwargs):
-    return json.dumps(d, **kwargs)
+    data = json.dumps(d, **kwargs)
+    return data
+
+
+def encode_yaml(d, **kwargs):
+    data = yaml.dump(d, **kwargs)
+    return data
 
 
 def read_file(filepath):

tests/input/invalid-content.yml

@@ -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.yml

@@ -0,0 +1,28 @@
+invoice: 34843
+date   : 2001-01-23
+bill-to: &id001
+    given  : Chris
+    family : Dumars
+    address:
+        lines: |
+            458 Walkman Dr.
+            Suite #292
+        city    : Royal Oak
+        state   : MI
+        postal  : 48046
+ship-to: *id001
+product:
+    - sku         : BL394D
+      quantity    : 4
+      description : Basketball
+      price       : 450.00
+    - sku         : BL4438H
+      quantity    : 1
+      description : Super Hoop
+      price       : 2392.00
+tax  : 251.42
+total: 4443.52
+comments: >
+    Late afternoon is best.
+    Backup contact is Nancy
+    Billsmer @ 338-4338.

tests/test_benedict.py

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

tests/test_io_dict.py

@@ -122,70 +122,112 @@ def test_to_json_file(self):
         })
         filepath = self.output_path('test_to_json_file.json')
         s = d.to_json(filepath=filepath, sort_keys=True)
+        self.assertTrue(d, os.path.isfile(filepath))
         self.assertEqual(d, IODict.from_json(filepath))
 
-    # def test_from_query_string(self):
-    #     pass
+    # YAML
 
-    # def test_from_query_string_file(self):
-    #     pass
-
-    # def test_from_query_string_url(self):
-    #     pass
-
-    # def test_from_toml_string(self):
-    #     pass
-
-    # def test_from_toml_file(self):
-    #     pass
-
-    # def test_from_toml_url(self):
-    #     pass
-
-    # def test_from_xml_string(self):
-    #     pass
-
-    # def test_from_xml_file(self):
-    #     pass
-
-    # def test_from_xml_url(self):
-    #     pass
-
-    # def test_from_yaml_string(self):
-    #     pass
-
-    # def test_from_yaml_file(self):
-    #     pass
-
-    # def test_from_yaml_url(self):
-    #     pass
-
-    # def test_to_base64(self):
-    #     pass
+    def test_from_yaml_with_valid_data(self):
+        j = """
+            a: 1
+            b:
+              c: 3
+              d: 4
+        """
+        # static method
+        d = IODict.from_yaml(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_to_base64_file(self):
-    #     pass
+    def test_from_yaml_with_invalid_data(self):
+        j = 'Lorem ipsum est in ea occaecat nisi officia.'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_yaml(j)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(j)
 
-    # def test_to_query_string(self):
-    #     pass
+    def test_from_yaml_with_valid_file_valid_content(self):
+        filepath = self.input_path('valid-content.yml')
+        # static method
+        d = IODict.from_yaml(filepath)
+        self.assertTrue(isinstance(d, dict))
+        # constructor
+        d = IODict(filepath)
+        self.assertTrue(isinstance(d, dict))
 
-    # def test_to_query_string_file(self):
-    #     pass
+    def test_from_yaml_with_valid_file_invalid_content(self):
+        filepath = self.input_path('invalid-content.yml')
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_yaml(filepath)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(filepath)
 
-    # def test_to_toml(self):
-    #     pass
+    def test_from_yaml_with_invalid_file(self):
+        filepath = self.input_path('invalid-file.yml')
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_yaml(filepath)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(filepath)
 
-    # def test_to_toml_file(self):
-    #     pass
+    # 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_to_xml(self):
-    #     pass
+    def test_from_yaml_with_valid_url_invalid_content(self):
+        url = 'https://github.com/fabiocaccamo/python-benedict'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_yaml(url)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(url)
 
-    # def test_to_xml_file(self):
-    #     pass
+    def test_from_yaml_with_invalid_url(self):
+        url = 'https://github.com/fabiocaccamo/python-benedict-invalid'
+        # static method
+        with self.assertRaises(ValueError):
+            d = IODict.from_yaml(url)
+        # constructor
+        with self.assertRaises(ValueError):
+            d = IODict(url)
 
-    # def test_to_yaml(self):
-    #     pass
+    def test_to_yaml(self):
+        d = IODict({
+            'x': 7,
+            'y': 8,
+            'z': 9,
+            'a': 1,
+            'b': 2,
+            'c': 3,
+        })
+        s = d.to_yaml()
+        self.assertEqual(d, IODict.from_yaml(s))
 
-    # def test_to_yaml_file(self):
-    #     pass
+    def test_to_yaml_file(self):
+        d = IODict({
+            'x': 7,
+            'y': 8,
+            'z': 9,
+            'a': 1,
+            'b': 2,
+            'c': 3,
+        })
+        filepath = self.output_path('test_to_yaml_file.yml')
+        s = d.to_yaml(filepath=filepath)
+        self.assertTrue(d, os.path.isfile(filepath))
+        self.assertEqual(d, IODict.from_yaml(filepath))