Add DataDict class

Author: seignovert

opus/data.py

@@ -1,16 +1,11 @@
 # -*- coding: utf-8 -*-
 
-class Data(object):
-    def __init__(self, json):
-        self._json = json
+class DataDict(object):
+    def __init__(self):
         self._data = {}
-        for row in json['page']:
-            el = DataElement(self.columns, row)
-            self._data[str(el)] = el
 
     def __repr__(self):
-        return 'OPUS API Data object (with {} elements):\n'.format(len(self)) + \
-               '\n'.join(' - {}'.format(key) for key, _ in self.items())
+        return '<OPUS API generic class for data objects>'
 
     def __len__(self):
         return len(self._data)
@@ -30,6 +25,21 @@ def items(self):
     def values(self):
         return self._data.values()
 
+    def append(self, key, value):
+        self._data[key] = value
+
+class Data(DataDict):
+    def __init__(self, json):
+        DataDict.__init__(self)
+        self._json = json
+        for row in json['page']:
+            el = DataElement(self.columns, row)
+            self._data[str(el)] = el
+
+    def __repr__(self):
+        return 'OPUS API Data object (with {} elements):\n'.format(len(self)) + \
+               '\n'.join(' - {}'.format(key) for key, _ in self.items())
+
     @property
     def count(self):
         return int(self._json['count'])
@@ -54,17 +64,18 @@ def labels(self):
     def columns(self):
         return self._json['columns']
 
-class DataElement(object):
+
+class DataElement(DataDict):
     def __init__(self, columns, row):
+        DataDict.__init__(self)
         self._columns = columns
         self._row = row
         self._id = None
-        self._data = {}
         for column, value in zip(columns, row):
             if 'Ring Observation ID' in column:
                 self._id = value
             else:
-                self._data[column] = value
+                self.append(column, value)
 
         if self._id is None:
             raise KeyError('`Ring Observation ID` key is missing in `cols` query')
@@ -75,21 +86,3 @@ def __repr__(self):
 
     def __str__(self):
         return self._id
-
-    def __len__(self):
-        return len(self._data)
-
-    def __getitem__(self, attr):
-        return self._data[attr]
-
-    def __iter__(self):
-        return iter(self._data)
-
-    def keys(self):
-        return self._data.keys()
-
-    def items(self):
-        return self._data.items()
-
-    def values(self):
-        return self._data.values()

tests/test_data.py

@@ -3,7 +3,12 @@
 
 import json as JSON
 
-from opus.data import Data, DataElement
+from opus.data import DataDict, Data, DataElement
+
+
+@pytest.fixture
+def data_dict():
+    return DataDict()
 
 @pytest.fixture
 def json():
@@ -17,11 +22,35 @@ def data(json):
 def el(data):
     return data['S_IMG_CO_ISS_1508094647_N']
 
+
+def test_data_dict(data_dict):
+    data_dict.append('abc', 'foo')
+    assert repr(data_dict) == '<OPUS API generic class for data objects>'
+    assert len(data_dict) == 1
+    assert data_dict['abc'] == 'foo'
+
+
+def test_data_dict_iter(data_dict):
+    data_dict.append('abc', 'foo')
+
+    for key in data_dict:
+        assert key == 'abc'
+
+    for key in data_dict.keys():
+        assert key == 'abc'
+
+    for key, value in data_dict.items():
+        assert key == 'abc'
+        assert value == 'foo'
+
+    for value in data_dict.values():
+        assert value == 'foo'
+
+
 def test_data_meta(data):
     r = repr(data)
     assert 'OPUS API Data object (with 10 elements)' in r
-    assert '- S_IMG_CO_ISS_1508094647_N' in r
-    assert len(data) == 10
+    assert 'S_IMG_CO_ISS_1508094647_N' in r
     assert data.count == 10
     assert data.limit == 10
     assert data.page_no == 2
@@ -39,32 +68,16 @@ def test_data_labels(data):
     assert labels[6] == 'Observation Stop Time (UTC)'
 
 
-def test_data_iter(data):
-    for key in data:
-        assert key in data.keys()
-        break
-
-    for value in data.values():
-        assert isinstance(value, DataElement)
-        break
-
-
 def test_data_element(el):
+    assert 'Planet' in repr(el)
     assert el['Planet'] == 'SAT'
     assert el['Intended Target Name'] == 'PAN'
     assert el['Observed Phase Angle (Min)'] == 87.786
     assert el['Observed Phase Angle (Max)'] == 88.169
     assert el['Observation Start Time (UTC)'] == '2005-288T18:42:08.622'
     assert el['Observation Stop Time (UTC)'] == '2005-288T18:42:09.302'
     assert len(el) == 6
-    assert 'Planet' in repr(el)
-    assert 'SAT' in el.values()
-
 
-def test_data_element_iter(el):
-    for key in el:
-        assert key in el.keys()
-        break
 
 def test_data_element_err():
     with pytest.raises(KeyError):