Merge pull request #2 from farmersez/to-dict

#1: Added to_dict

.gitignore

@@ -55,3 +55,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# PyCharm files
+.idea

src/basicstruct.py

@@ -4,6 +4,7 @@
 """This is a placeholder."""
 
 import six
+from copy import deepcopy
 from six.moves import zip
 from itertools import chain
 
@@ -24,6 +25,20 @@ def __init__(self, *args, **kwargs):
             if not hasattr(self, key):
                 setattr(self, key, None)
 
+    def to_dict(self, copy=False):
+        """Convert the struct to a dictionary.
+
+        If `copy == True`, returns a deep copy of the values.
+
+        """
+        new_dict = {}
+        for attr, value in self:
+            if copy:
+                value = deepcopy(value)
+            new_dict[attr] = value
+
+        return new_dict
+
     def __repr__(self):
         attrs_str = ', '.join('{0}={1!r}'.format(key, getattr(self, key))
                               for key in self.__slots__)
@@ -62,6 +77,14 @@ def __ne__(self, other):
     def __hash__(self):
         return hash(self._to_tuple())
 
+    def __iter__(self):
+        """Yield pairs of (attrubute_name, value).
+
+        This allows using `dict(my_struct)`.
+
+        """
+        return zip(self.__slots__, self._to_tuple())
+
     def _to_tuple(self):
         return tuple(getattr(self, key) for key in self.__slots__)
 

src/tests.py

@@ -104,6 +104,25 @@ def test_hash(self):
         self.assertNotEqual(hash(medium), hash(large))
         self.assertEqual(hash(medium), hash(another_medium))
 
+    def test_to_dict(self):
+        f = Foo(1, 2)
+        d1 = f.to_dict()
+        d2 = dict(f)
+        expected = {'x': 1, 'y': 2}
+
+        self.assertEqual(d1, expected)
+        self.assertEqual(d2, expected)
+
+    def test_to_dict_copy(self):
+        l = []
+        f = Foo(1, l)
+        d1 = f.to_dict()
+        d2 = f.to_dict(copy=True)
+        l.append(1)
+
+        self.assertEqual(d1, {'x': 1, 'y': [1]})
+        self.assertEqual(d2, {'x': 1, 'y': []})
+
 
 if __name__ == '__main__':
     unittest.main()