Change Image class to be more explicit

Author: seignovert

opus/data.py

@@ -2,10 +2,9 @@
 
 class Data(object):
     def __init__(self, json):
-        self.json = json
-        self.index = 0
+        self._json = json
         self._data = {}
-        for row in self.json['page']:
+        for row in json['page']:
             el = DataElement(self.columns, row)
             self._data[str(el)] = el
 
@@ -33,27 +32,27 @@ def values(self):
 
     @property
     def count(self):
-        return int(self.json['count'])
+        return int(self._json['count'])
 
     @property
     def limit(self):
-        return int(self.json['limit'])
+        return int(self._json['limit'])
 
     @property
     def order(self):
-        return self.json['order']
+        return self._json['order']
 
     @property
     def page_no(self):
-        return int(self.json['page_no'])
+        return int(self._json['page_no'])
 
     @property
     def labels(self):
-        return self.json['labels']
+        return self._json['labels']
 
     @property
     def columns(self):
-        return self.json['columns']
+        return self._json['columns']
 
 class DataElement(object):
     def __init__(self, columns, row):

opus/images.py

@@ -23,39 +23,36 @@ def download(self, out=None):
 
 class Images(object):
     def __init__(self, json, size):
-        self.json = json
+        self._json = json
         self.size = size
-        self.index = 0
+        self._data = {}
+        for img in json['data']:
+            el = Image(img['ring_obs_id'], img['path'], img['img'])
+            self._data[str(el)] = el
 
     def __repr__(self):
-        return 'OPUS API Images object (with {} images)'.format(self.count)
+        return 'OPUS API Images object (with {} {} images):\n'.format(len(self), self.size) + \
+               '\n'.join(' - {}'.format(key) for key, _ in self.items())
 
     def __len__(self):
-        return self.count
+        return len(self._data)
 
-    def __getitem__(self, index):
-        img = self.json['data'][index]
-        return Image(img['ring_obs_id'], img['path'], img['img'])
+    def __getitem__(self, attr):
+        return self._data[attr]
 
     def __iter__(self):
-        return self
+        return iter(self._data)
 
-    def __next__(self):
-        try:
-            result = self.__getitem__(self.index)
-        except IndexError:
-            self.index = 0
-            raise StopIteration
-        self.index += 1
-        return result
+    def keys(self):
+        return self._data.keys()
 
-    def next(self):
-        return self.__next__()
+    def items(self):
+        return self._data.items()
+
+    def values(self):
+        return self._data.values()
 
-    @property
-    def count(self):
-        return len(self.json['data'])
 
     @property
     def order(self):
-        return self.json['order']
+        return self._json['order']

tests/test_images.py

@@ -4,7 +4,7 @@
 import responses
 import json as JSON
 
-from opus.images import *
+from opus.images import Images, Image
 
 @pytest.fixture
 def size():
@@ -22,26 +22,29 @@ def image(size):
     return Image(ring_obs_id, json['path'], json['data'][0]['img'])
 
 def test_images_meta(images, size):
-    assert repr(images) == 'OPUS API Images object (with 10 images)'
+    r = repr(images)
+    assert 'OPUS API Images object' in r
+    assert 'S_IMG_CO_ISS_1508094647_N' in r
     assert len(images) == 10
     assert images.order == 'obs_general.time1'
     assert images.size == size
+    assert isinstance(images['S_IMG_CO_ISS_1508094647_N'], Image)
 
-
-def test_images_image(images):
-    image = images[0]
-    assert repr(image) == 'OPUS API Image object: S_IMG_CO_ISS_1508094647_N'
-    assert str(image) == 'S_IMG_CO_ISS_1508094647_N'
-    assert image.ring_obs_id == 'S_IMG_CO_ISS_1508094647_N'
-    assert image.path == 'https://pds-rings.seti.org/holdings/previews/'
-    assert image.img == 'COISS_2xxx/COISS_2016/data/1508054834_1508117267/N1508094647_1_med.jpg'
-    assert image.url == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2016/data/1508054834_1508117267/N1508094647_1_med.jpg'
-    
+def test_images_image(image):
+    assert repr(image) == 'OPUS API Image object: S_IMG_CO_ISS_1459551972_N'
+    assert str(image) == 'S_IMG_CO_ISS_1459551972_N'
+    assert image.ring_obs_id == 'S_IMG_CO_ISS_1459551972_N'
+    assert image.path == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/'
+    assert image.img == 'COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
+    assert image.url == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
 
 def test_images_iter(images):
-    images.next() == images[0]
-    for ii, img in enumerate(images):
-        img = images[ii]
+    for key in images:
+        assert key in images.keys()
+        break
+    for value in images.values():
+        assert isinstance(value, Image)
+        break
 
 
 @responses.activate