Add DataDict and Downloadable class to Files

Author: seignovert

opus/data.py

@@ -28,6 +28,9 @@ def values(self):
     def append(self, key, value):
         self._data[key] = value
 
+    def load(self, dict):
+        self._data = dict
+
 class Data(DataDict):
     def __init__(self, json):
         DataDict.__init__(self)

opus/files.py

@@ -1,43 +1,48 @@
 # -*- coding: utf-8 -*-
 
-class File(object):
+from .data import DataDict
+from .wget import Downloadable
+
+
+class File(DataDict):
     '''Files for a single observation'''
     def __init__(self, ring_obs_id, data):
+        DataDict.__init__(self)
         self.ring_obs_id = ring_obs_id
-        self._data = data
 
-        for label, files in self._data.items():
+        for label, files in data.items():
             if label == 'preview_image':
-                key = 'previews'
+                key = 'PREVIEWS'
                 value = Preview(files)
             else:
-                key = label.lower()
+                key = label.upper()
                 value = FileList(files)
 
-            setattr(self, key, value)
+            self.append(key, value)
 
     def __repr__(self):
-        return 'OPUS API Files for observation: {}'.format(self.ring_obs_id)
+        return 'OPUS API Files for observation: {}\n'.format(self.ring_obs_id) + \
+               '\n'.join('\n=> {}\n{}'.format(key, value) for key, value in self.items())
 
     def __str__(self):
         return self.ring_obs_id
 
-class Preview(object):
+
+class Preview(DataDict):
     '''Previews for a single observation'''
     def __init__(self, previews=[]):
+        DataDict.__init__(self)
         for preview in previews:
-            key = preview.split('_')[-1].replace('.jpg', '').replace('.png','')
-            setattr(self, key, preview)
+            key = preview.split('_')[-1].split('.')[0]
+            self.append(key, Downloadable(preview))
 
     def __repr__(self):
-        return '\n'.join(
-            ['{} -> {}'.format(key.title(), value)
-            for key, value in self.__dict__.items()]
-        )
+        return '\n'.join(' - {}: {}'.format(key, value) for key, value in self.items())
 
-class FileList(object):
+class FileList(DataDict):
     '''Files list for a single observation'''
     def __init__(self, files=[]):
+        DataDict.__init__(self)
         for f in files:
             if f.endswith('.LBL'):
                 key = 'LBL'
@@ -52,47 +57,19 @@ def __init__(self, files=[]):
             else:
                 raise ValueError('Unknown file format `{}`'.format(f.lower().split('/')[-1]))
 
-            setattr(self, key, f)
+            self.append(key, Downloadable(f))
 
     def __repr__(self):
-        return '\n'.join(
-            ['{} -> {}'.format(key, value)
-            for key, value in self.__dict__.items()]
-        )
+        return '\n'.join(' - {}: {}'.format(key, value) for key, value in self.items())
 
 
-class Files(object):
+class Files(DataDict):
     def __init__(self, json):
-        self.json = json
-        self.imgs = list(self.json['data'].keys())
-        self.index = 0
+        DataDict.__init__(self)
+        self._json = json
+        for key, value in json['data'].items():
+            self.append(key, File(key, value))
 
     def __repr__(self):
-        return 'OPUS API Files object (with {} files)'.format(self.count)
-
-    def __len__(self):
-        return self.count
-
-    def __getitem__(self, index):
-        ring_obs_id = self.imgs[index]
-        data = self.json['data'][ring_obs_id]
-        return File(ring_obs_id, data)
-
-    def __iter__(self):
-        return self
-
-    def __next__(self):
-        try:
-            result = self.__getitem__(self.index)
-        except IndexError:
-            self.index = 0
-            raise StopIteration
-        self.index += 1
-        return result
-
-    def next(self):
-        return self.__next__()
-
-    @property
-    def count(self):
-        return len(self.json['data'])
+        return 'OPUS API Files object (with {} files):\n'.format(len(self)) + \
+               '\n'.join(' - {}'.format(key) for key in self.keys())

opus/wget.py

@@ -8,6 +8,12 @@ class Downloadable(object):
     def __init__(self, url):
         self.url = url
 
+    def __repr__(self):
+        return 'OPUS API downloadable file:\n -> {}'.format(str(self))
+
+    def __str__(self):
+        return self.url
+
     def download(self, out=None):
         outdir = None
         if out and os.path.isdir(out):

tests/test_data.py

@@ -24,10 +24,11 @@ def el(data):
 
 
 def test_data_dict(data_dict):
-    data_dict.append('abc', 'foo')
+    data_dict.load({'abc': 'foo', 'def': 'bar'})
     assert repr(data_dict) == '<OPUS API generic class for data objects>'
-    assert len(data_dict) == 1
+    assert len(data_dict) == 2
     assert data_dict['abc'] == 'foo'
+    assert data_dict['def'] == 'bar'
 
 
 def test_data_dict_iter(data_dict):

tests/test_files.py

@@ -22,45 +22,49 @@ def file_vims(files):
     return File('S_CUBE_CO_VIMS_1558621524_VIS', json['data']['S_CUBE_CO_VIMS_1558621524_VIS'])
 
 
-def test_files_meta(files):
-    assert repr(files) == 'OPUS API Files object (with 10 files)'
-    assert len(files) == 10
-
-def test_files_iter(files):
-    files.next() == files[0]
-    for ii, img in enumerate(files):
-        img = files[ii]
-
-def test_file_meta(file_iss):
-    assert repr(file_iss) == 'OPUS API Files for observation: S_IMG_CO_ISS_1459551972_N'
-    assert str(file_iss) == 'S_IMG_CO_ISS_1459551972_N'
-    assert file_iss.ring_obs_id == 'S_IMG_CO_ISS_1459551972_N'
+def test_file_meta(file_vims):
+    assert 'OPUS API Files for observation: S_CUBE_CO_VIMS_1558621524_VIS' in repr(file_vims)
+    assert str(file_vims) == 'S_CUBE_CO_VIMS_1558621524_VIS'
+    assert file_vims.ring_obs_id == 'S_CUBE_CO_VIMS_1558621524_VIS'
 
 def test_file_previews(file_iss):
-    previews = file_iss.previews
-    assert isinstance(repr(previews), str)
-    assert previews.full == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_full.jpg'
-    assert previews.med == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
-    assert previews.small == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_small.jpg'
-    assert previews.thumb == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_thumb.jpg'
+    previews = file_iss['PREVIEWS']
+    assert str(previews['full']) == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_full.jpg'
+    assert str(previews['med']) == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_med.jpg'
+    assert str(previews['small']) == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_small.jpg'
+    assert str(previews['thumb']) == 'https://pds-rings.seti.org/holdings/previews/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_thumb.jpg'
 
 
 def test_file_list_iss(file_iss):
-    raw_image = file_iss.raw_image
-    assert raw_image.LBL == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1.LBL'
-    assert raw_image.IMG == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1.IMG'
-    assert raw_image.tlmtab == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/LABEL/TLMTAB.FMT'
-    assert raw_image.prefix2 == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/LABEL/PREFIX2.FMT'
+    raw_image = file_iss['RAW_IMAGE']
+    assert str(raw_image['LBL']) == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1.LBL'
+    assert str(raw_image['IMG']) == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1.IMG'
+    assert str(raw_image['tlmtab']) == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/LABEL/TLMTAB.FMT'
+    assert str(raw_image['prefix2']) == 'https://pds-rings.seti.org/holdings/volumes/COISS_2xxx/COISS_2001/LABEL/PREFIX2.FMT'
 
-    calibrated = file_iss.calibrated
-    assert calibrated.LBL == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_CALIB.LBL'
-    assert calibrated.IMG == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_CALIB.IMG'
-    assert calibrated.tlmtab == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/LABEL/TLMTAB.FMT'
-    assert calibrated.prefix2 == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/LABEL/PREFIX2.FMT'
+    calibrated = file_iss['CALIBRATED']
+    assert str(calibrated['LBL']) == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_CALIB.LBL'
+    assert str(calibrated['IMG']) == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/data/1459551663_1459568594/N1459551972_1_CALIB.IMG'
+    assert str(calibrated['tlmtab']) == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/LABEL/TLMTAB.FMT'
+    assert str(calibrated['prefix2']) == 'https://pds-rings.seti.org/holdings/calibrated/COISS_2xxx/COISS_2001/LABEL/PREFIX2.FMT'
 
 
 def test_file_list_vims(file_vims):
-    assert isinstance(repr(file_vims.raw_spectral_image_cube), str)
+    raw_spectral_image_cube = file_vims['RAW_SPECTRAL_IMAGE_CUBE']
+    assert str(raw_spectral_image_cube['qub']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/data/2007137T054828_2007143T180509/v1558621524_1.qub'
+    assert str(raw_spectral_image_cube['QUB']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/data/2007137T054828_2007143T180509/v1558621524_1.QUB'
+    assert str(raw_spectral_image_cube['LBL']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/data/2007137T054828_2007143T180509/v1558621524_1.LBL'
+    assert str(raw_spectral_image_cube['suffix_description']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/LABEL/suffix_description.fmt'
+    assert str(raw_spectral_image_cube['core_description']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/LABEL/core_description.fmt'
+    assert str(raw_spectral_image_cube['band_bin_center']) == 'https://pds-rings.seti.org/holdings/volumes/COVIMS_0xxx/COVIMS_0020/LABEL/band_bin_center.fmt'
+    
+
+def test_files_meta(files):
+    r = repr(files)
+    assert 'OPUS API Files object (with 10 files)' in r
+    assert 'S_CUBE_CO_VIMS_1558621524_VIS' in r
+    assert len(files) == 10
+
 
 def test_file_list_err():
     with pytest.raises(ValueError):

tests/test_wget.py

@@ -14,8 +14,12 @@ def url():
 def downloadable(url):
     return Downloadable(url)
 
+
+def test_downloadable(downloadable):
+    assert downloadable.url in repr(downloadable)
+
 @responses.activate
-def test_image_download(downloadable):
+def test_download(downloadable):
     fname = 'N1459551972_1_med.jpg'
     with open('tests/api/image/med/'+fname, 'rb') as img:
         responses.add(responses.GET, downloadable.url,
@@ -34,7 +38,7 @@ def test_image_download(downloadable):
 
 
 @responses.activate
-def test_image_download_output(downloadable):
+def test_download_output(downloadable):
     fname = 'N1459551972_1_med.jpg'
     with open('tests/api/image/med/'+fname, 'rb') as img:
         responses.add(responses.GET, downloadable.url,