Add DataDict to Fields and add find feature on DataDict

Author: seignovert

opus/data.py

@@ -31,6 +31,17 @@ def append(self, key, value):
     def load(self, dict):
         self._data = dict
 
+    def find(self, keyword):
+        keyword = keyword.lower()
+        keys = []
+        for key in self.keys():
+            if keyword in key.lower():
+                keys.append(key)
+        if len(keys) == 0:
+            return None
+        return keys
+
+
 class Data(DataDict):
     def __init__(self, json):
         DataDict.__init__(self)

opus/fields.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 import re
 
+from .data import DataDict
+
 def splitKey(key):
     '''Split from first uppercase word (ie., `body`)'''
     body = re.findall('[^a-z]+', key)[0]
@@ -16,12 +18,15 @@ def __init__(self, field, json):
         self._json = json
         self.field = field
         self.label = json['label']
-                
+
     def __repr__(self):
         if self.desc is not None:
-            return '`{}` -> {}\n{}\n_More info_: {}'.format(self.field, self.label, self.desc, self.url)
+            return '{} ({}):\n => {}\n {}'.format(self.label, self.field, self.desc, self.url)
         else:
-            return '`{}` -> {}'.format(self.field, self.label)
+            return '{}: ({})'.format(self.label, self.field)
+
+    def __str__(self):
+        return self.label
 
     @property
     def desc(self):
@@ -45,85 +50,35 @@ def url(self):
             return url
 
 
-class Fields(object):
+class Fields(DataDict):
     def __init__(self, json):
+        DataDict.__init__(self)
         self._json = json
-        self._data = {'GLOBAL': GlobalField()}
+        self.append('GLOBAL', GlobalField())
         for key, value in json.items():
-
             if 'surfacegeometry' in key:
                 try:
                     body, field = splitKey(key)
-                    if body not in self._data:
-                        self._data[body] = SurfaceGeometry(body)
-                    self._data[body].add(field, Field(key, value))
+                    if body not in self.keys():
+                        self.append(body, SurfaceGeometry(body))
+                    self[body].append(field, Field(key, value))
                 except IndexError:
-                    self._data['GLOBAL'].add(key.lower(), Field(key, value))
+                    self['GLOBAL'].append(key.lower(), Field(key, value))
             else:
-                self._data['GLOBAL'].add(key.lower(), Field(key, value))
+                self['GLOBAL'].append(key.lower(), Field(key, value))
 
     def __repr__(self):
-        return 'OPUS API list of all fields ({})'.format(len(self))
-
-    def __len__(self):
-        return len(self._json)
-
-    def __getitem__(self, attr):
-        return self._data[attr.upper()]
-
-    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()
+        return 'OPUS API list of all fields available ({}):\n'.format(len(self)) + \
+               '\n'.join(' - {}'.format(key) for key in self)
 
 
-class GlobalField(object):
+class GlobalField(DataDict):
     def __init__(self):
-        self._fields = {}
+        DataDict.__init__(self)
 
     def __repr__(self):
         return 'OPUS API Global fields ({}):\n'.format(len(self)) + \
-                '\n'.join(
-                    ' - {} ({})'.format(value.label, key) for key, value in self.items()
-                )
-
-    def __len__(self):
-        return len(self._fields)
-
-    def __getitem__(self, attr):
-        return self._fields[attr]
-
-    def __iter__(self):
-        return iter(self._fields)
-
-    def keys(self):
-        return self._fields.keys()
-
-    def items(self):
-        return self._fields.items()
-
-    def values(self):
-        return self._fields.values()
-
-    def add(self, name, field):
-        self._fields[name] = field
-
-    def find(self, keyword):
-        keyword = keyword.lower()
-        keys = []
-        for key, value in self.items():
-            if keyword in value.label.lower():
-                keys.append(key)
-        if len(keys) == 0:
-            return None
-        return keys
+                '\n'.join(' - {} ({})'.format(value, key) for key, value in self.items())
 
 
 class SurfaceGeometry(GlobalField):
@@ -133,6 +88,4 @@ def __init__(self, body):
 
     def __repr__(self):
         return 'OPUS API Surface Geometry fields ({}) for `{}`:\n'.format(len(self), self.body.title()) + \
-                '\n'.join(
-                    ' - {} ({})'.format(value.label, key) for key, value in self.items()
-                )
+                '\n'.join(' - {} ({})'.format(value, key) for key, value in self.items())

tests/test_api.py

@@ -309,7 +309,7 @@ def test_api_fields(api):
     assert responses.calls[0].request.url == 'http://localhost/fields.json'
     assert responses.calls[0].response.text == fields
 
-    assert len(resp) == 3971
+    assert len(resp) == 304
 
 
 @responses.activate

tests/test_data.py

@@ -30,6 +30,10 @@ def test_data_dict(data_dict):
     assert data_dict['abc'] == 'foo'
     assert data_dict['def'] == 'bar'
 
+def test_data_dict_find(data_dict):
+    data_dict.load({'abc': 'foo', 'def': 'bar'})
+    assert 'abc' in data_dict.find('AB')
+    assert data_dict.find('ac') is None
 
 def test_data_dict_iter(data_dict):
     data_dict.append('abc', 'foo')

tests/test_fields.py

@@ -21,100 +21,36 @@ def fields():
 def field_empty():
     return Field('empty', {'label': 'Empty', 'more_info': {'def': False, 'more_info': False}})
 
+def test_split_key():
+    assert splitKey('surfacegeometryTITANIAsubobserverIAUlongitude') == ('TITANIA', 'subobserverIAUlongitude')
+
 def test_field_repr(field):
-    assert repr(field) == \
-        '`target` -> Intended Target Name\n' + \
-        'The target_name element identifies a target. The target may be a planet, ' + \
-        'satellite,ring,region, feature, asteroid or comet. See target_type.\n' + \
-        '_More info_: http://pds-rings.seti.org/dictionary/index.php?term=TARGET_NAME&context=PSDD'
+    assert repr(field) == 'Intended Target Name (target):\n' + \
+        ' => The target_name element identifies a target. The target may be a planet, satellite,ring,region, feature, asteroid or comet. See target_type.\n' + \
+        ' http://pds-rings.seti.org/dictionary/index.php?term=TARGET_NAME&context=PSDD'
+    assert str(field) == 'Intended Target Name'
 
 def test_field_empty(field_empty):
-    assert repr(field_empty) == '`empty` -> Empty'
+    assert repr(field_empty) == 'Empty: (empty)'
     assert field_empty.url == None
 
 def test_field_err(field):
     with pytest.raises(KeyError):
         Field('abc', {})
 
-def test_split_key():
-    assert splitKey('surfacegeometryTITANIAsubobserverIAUlongitude') == ('TITANIA', 'subobserverIAUlongitude')
-
 def test_fields_repr(fields):
-    assert repr(fields) == 'OPUS API list of all fields (3971)'
+    r = repr(fields)
+    assert 'OPUS API list of all fields available (304)' in r
+    assert 'GLOBAL' in r
 
-def test_fields_iter(fields):
-    assert 'GLOBAL' in fields
-    
-    for key, value in fields.items():
-        assert fields[key] == value
-        break
-
-def test_fields_keys_values(fields):
-    keys = fields.keys()
-    values = fields.values()
-    assert len(keys) == 304
-    assert len(values) == 304
-    assert 'GLOBAL' in keys
-    assert 'JUPITER' in keys
-
-
 def test_global_field_repr(fields):
-    assert isinstance(repr(fields['global']), str)
-    assert len(fields['global'].values()) == 234
+    r = repr(fields['GLOBAL'])
+    assert 'OPUS API Global fields (234)' in r
+    assert 'Lesser Size in Pixels' in r
 
-def test_global_field_iter(fields):
-    assert 'line1' in fields['global']
-    assert repr(fields['global']['line1']) == '`LINE1` -> Line'
 
 def test_surface_geometry_repr(fields):
-    if six.PY3:
-        assert repr(fields['jupiter']) == \
-            'OPUS API Surface Geometry fields (31) for `Jupiter`:\n' + \
-            ' - Solar Hour Angle (solarhourangle)\n' + \
-            ' - Body Center Resolution (centerresolution)\n' + \
-            ' - Observed Phase Angle 2 (phase2)\n' + \
-            ' - Observed Phase Angle (phase1)\n' + \
-            ' - Coarsest Observed Resolution (coarsestresolution1)\n' + \
-            ' - Sub-Solar IAU West Longitude (subsolarIAUlongitude)\n' + \
-            ' - Observed Incidence Angle (incidence1)\n' + \
-            ' - D Solar Hour Angle (dsolarhourangle)\n' + \
-            ' - Observed Planetocentric Latitude 2 (planetocentriclatitude2)\n' + \
-            ' - Body Center Distance (centerdistance)\n' + \
-            ' - D Observer Longitude (dObserverlongitude)\n' + \
-            ' - Sub-Solar Planetographic Latitude (subsolarplanetographiclatitude)\n' + \
-            ' - Sub-Observer Planetocentric Latitude (subobserverplanetocentriclatitude)\n' + \
-            ' - Observed Planetographic Latitude (planetographiclatitude1)\n' + \
-            ' - Observed Planetographic Latitude 2 (planetographiclatitude2)\n' + \
-            ' - Sub-Solar Planetocentric Latitude (subsolarplanetocentriclatitude)\n' + \
-            ' - Observed Emission Angle (emission1)\n' + \
-            ' - Observed Emission Angle 2 (emission2)\n' + \
-            ' - Observed Incidence Angle 2 (incidence2)\n' + \
-            ' - Sub-Observer Planetographic Latitude (subobserverplanetographiclatitude)\n' + \
-            ' - Coarsest Observed Resolution 2 (coarsestresolution2)\n' + \
-            ' - Sub-Observer IAU West Longitude (subobserverIAUlongitude)\n' + \
-            ' - Observed Distance to Surface 2 (rangetobody2)\n' + \
-            ' - Observed Distance to Surface (rangetobody1)\n' + \
-            ' - Observed Local Time 2 (solarhourangle2)\n' + \
-            ' - Observed Local Time (solarhourangle1)\n' + \
-            ' - Phase Angle at Body Center (centerphaseangle)\n' + \
-            ' - Observed Planetocentric Latitude (planetocentriclatitude1)\n' + \
-            ' - D Iau West Longitude (dIAUwestlongitude)\n' + \
-            ' - Finest Observed Resolution 2 (finestresolution2)\n' + \
-            ' - Finest Observed Resolution (finestresolution1)'
-    else:
-        assert isinstance(repr(fields['jupiter']), str)
-
-def test_surface_geometry_keys(fields):
-    keys = fields['jupiter'].keys()
-    assert len(keys) == 31
-    assert 'solarhourangle' in keys
-
-
-def test_surface_geometry_find(fields):
-    found = fields['jupiter'].find('phase')
-    assert len(found) == 3
-    assert 'phase1' in found
-    assert 'phase2' in found
-    assert 'centerphaseangle' in found
-
-    assert fields['jupiter'].find('target') == None
+    r = repr(fields['TITAN'])
+    assert 'OPUS API Surface Geometry fields (31) for `Titan`' in r
+    assert 'Sub-Solar IAU West Longitude' in r
+