added progress callbacks to event_V2 API

Author: tradel

CHANGELOG.md

@@ -1,7 +1,10 @@
 # PyBanyan Change History
 
-## 0.17.2
- * Remove accidentally committed test code
+## 0.18.2
+ * trapped errors in progress callbacks
+
+## 0.18.1
+ * add progress callbacks to new list methods in event_v2
 
 ## 0.18.0 
  * added count method to event_v2 object

banyan/api/__init__.py

@@ -5,6 +5,7 @@
 
 import logging
 import os
+import sys
 from typing import Dict, Any, List, Union, Callable
 
 import requests
@@ -195,6 +196,17 @@ def progress_callback(self) -> ProgressCallback:
     def progress_callback(self, value: ProgressCallback) -> None:
         self._progress_callback = value
 
+    def _do_progress_callback(self, method: str, uri: str, count: int, total: int) -> None:
+        if self._progress_callback:
+            try:
+                self._progress_callback(method, uri, count, total)
+            except Exception as ex:
+                err_msg = f'{ex.__class__.__name__} exception in progress callback: {ex.args[0]}'
+                if self._log:
+                    self._log.error(err_msg)
+                else:
+                    print(err_msg, file=sys.stderr)
+
     def paged_request(self, method: str, uri: str, params: Dict[str, Any] = None, data: Any = None,
                       json: str = None, headers: Dict[str, str] = None, accept: str = None,
                       progress_callback: ProgressCallback = None) -> JsonListOrObj:
@@ -215,8 +227,7 @@ def paged_request(self, method: str, uri: str, params: Dict[str, Any] = None, da
                         return all_results
                     all_results.extend(results[key])
                     logging.debug(f'Found {key}, result count = {len(results[key])}, total count = {len(all_results)}')
-                    if callback:
-                        callback(method, uri, len(all_results), results.get('count', -1))
+                    self._do_progress_callback(method, uri, len(all_results), results.get('count', -1))
                     skip += limit
 
     @property

banyan/api/event_v2.py

@@ -34,6 +34,9 @@ def count(self, before_dt: datetime = None, after_dt: datetime = None, order: st
               container_id: str = None, service_name: str = None, event_id: str = None) -> int:
         params = self._make_params(before_dt, after_dt, order, event_type, subtype, action, email_address,
                                    device_id, device_serial, container_id, service_name, event_id)
+        return self._count(params)
+
+    def _count(self, params: Dict[str, Any]) -> int:
         response_json = self._client.api_request('GET', '/events/count', params=params)
         return response_json['data']
 
@@ -63,12 +66,15 @@ def list(self, before_dt: datetime = None, after_dt: datetime = None, order: str
         else:
             return self._list_paged(params)
 
+    # noinspection PyProtectedMember
     def _list_daterange(self, params: Dict[str, Any]) -> List[Resource]:
         order = params.get('order', 'desc')
         params['order'] = 'asc'
         all_data: List[EventV2] = list()
         event_ids: Set[UUID] = set()
+        count = self._count(params)
         schema = self.Meta.info_class.Schema()
+        self._client._do_progress_callback('GET', self.Meta.list_uri, 0, count)
         while params['after'] < params['before']:
             response_json = self._client.api_request('GET', self.Meta.list_uri, params=params)
             data: List[EventV2] = schema.load(response_json['data'], many=True)
@@ -78,6 +84,7 @@ def _list_daterange(self, params: Dict[str, Any]) -> List[Resource]:
             all_data.extend(data)
             event_ids.update([x.event_id for x in data])
             params['after'] = int(data[-1].created_at.timestamp() * 1000)
+            self._client._do_progress_callback('GET', self.Meta.list_uri, len(all_data), count)
         self._build_cache(all_data)
         return all_data
 

banyan/core/version.py

@@ -1,7 +1,7 @@
 
 from cement.utils.version import get_version as cement_get_version
 
-VERSION = (0, 18, 0, 'final', 1)
+VERSION = (0, 18, 2, 'final', 1)
 
 
 def get_version(version=VERSION):