Retrieve a lazy-loaded dataset when setting one of its paramters

Author: dariosky

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v1.0.34 (2019-11-11)
+Retrieve a lazy-loaded dataset when setting one of its paramters.
+
 ## v1.0.33 (2019-10-17)
 
 * A default timeout of 10" on connection and 60" on silence has been added to all the API calls

ravenpackapi/core.py

@@ -15,7 +15,7 @@
 from ravenpackapi.utils.date_formats import as_datetime_str
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.33'
+VERSION = '1.0.34'
 
 logger = logging.getLogger("ravenpack.core")
 

ravenpackapi/models/dataset.py

@@ -75,6 +75,7 @@ def __setattr__(self, field, value):
         if field == 'id':
             field = 'uuid'
         if field in Dataset._VALID_FIELDS:
+            self._lazyload()
             super(Dataset, self).__setattr__(field, value)
         else:
             object.__setattr__(self, field, value)
@@ -88,6 +89,12 @@ def __delitem__(self, field):
     def id(self):  # an alias for the dataset unique id
         return self.uuid
 
+    def _lazyload(self):
+        if (getattr(self, '_lazy_retrieve_on_get', False)  # dynamic, we check this also during object creation
+            and self.uuid
+        ):
+            self.get_from_server()  # get the missing fields
+
     def __getattribute__(self, field):
         """ Getting attributes we may trigger a data refresh from the server """
         if field == 'id':  # id is an alias for uuid
@@ -99,11 +106,8 @@ def __getattribute__(self, field):
 
         if field in Dataset._VALID_FIELDS and field != 'uuid':
             value = super(Dataset, self).__getattribute__(field)
-            if (value is None
-                and self._lazy_retrieve_on_get
-                and self.uuid
-            ):
-                self.get_from_server()  # get the missing fields
+            if value is None:
+                self._lazyload()
         return super(Dataset, self).__getattribute__(field)
 
     def as_dict(self):
@@ -130,9 +134,9 @@ def get_from_server(self, force=False):
             response = self.api.request(
                 endpoint="/datasets/{dataset_uuid}".format(dataset_uuid=dataset_id),
             )
+            self._lazy_retrieve_on_get = False  # we got everything from the server
             for field, value in response.json().items():
                 setattr(self, field, value)
-            self._lazy_retrieve_on_get = False  # we got everything from the server
         return self.as_dict()
 
     @api_method

ravenpackapi/tests/test_dataset_update.py

@@ -37,3 +37,24 @@ def test_create_and_update(self):
         dataset.delete()
 
         assert delete_all_datasets_by_name(self.api, self.dataset_name) == 0
+
+    def test_simple_update(self):
+        filters = {"rp_entity_id": {"$in": ['D8442A']}}
+        ds = self.api.create_dataset(
+            Dataset(
+                name=self.dataset_name,
+                filters=filters,  # a dataset with a filter
+            )
+        )
+        assert ds._lazy_retrieve_on_get is False
+
+        dataset_id = ds.id
+
+        ds = self.api.get_dataset(dataset_id)  # retrieve the dataset
+        assert ds._lazy_retrieve_on_get is True  # it still have to be lazy loaded here
+        ds.filters = {"rp_entity_id": {"$in": ["228D42"]}}  # update the dataset ***
+        ds.save()
+
+        for r in ds.json('2019-01-01', '2019-01-02'):
+            assert r['rp_entity_id'] == '228D42', "Expecting entity to be 228D42 - got %s" % r['rp_entity_id']
+            break

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '1.0.33'
+VERSION = '1.0.34'
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()