chore: use InfluxDBError instead ApiException

Author: bednar

README.rst

@@ -1185,17 +1185,18 @@ return underlying exceptions.
 .. code-block:: python
 
     from influxdb_client import InfluxDBClient
+    from influxdb_client.client.exceptions import InfluxDBError
 
 
     class BatchingCallback(object):
 
         def success(self, conf: (str, str, str), data: str):
             print(f"Written batch: {conf}, data: {data}")
 
-        def error(self, conf: (str, str, str), data: str, exception: Exception):
+        def error(self, conf: (str, str, str), data: str, exception: InfluxDBError):
             print(f"Cannot write batch: {conf}, data: {data} due: {exception}")
 
-        def retry(self, conf: (str, str, str), data: str, exception: Exception):
+        def retry(self, conf: (str, str, str), data: str, exception: InfluxDBError):
             print(f"Retryable error occurs for batch: {conf}, data: {data} retry: {exception}")
 
 

examples/README.md

@@ -7,7 +7,7 @@
 - [ingest_large_dataframe.py](ingest_large_dataframe.py) - How to ingest large DataFrame
 - [iot_sensor.py](iot_sensor.py) - How to write sensor data every minute by [RxPY](https://rxpy.readthedocs.io/en/latest/)
 - [import_data_set_sync_batching.py](import_data_set_sync_batching.py) - How to use [RxPY](https://rxpy.readthedocs.io/en/latest/) to prepare batches for synchronous write into InfluxDB
-- [write_api_callbacks.py](write_api_callbacks.py) - How to use `WriteApi`'s callbacks to notify about state of background batches
+- [write_api_callbacks.py](write_api_callbacks.py) - How to handle batch events
 - [write_structured_data.py](write_structured_data.py) - How to write structured data - [NamedTuple](https://docs.python.org/3/library/collections.html#collections.namedtuple), [Data Classes](https://docs.python.org/3/library/dataclasses.html) - (_requires Python v3.8+_)
 
 ## Queries

examples/write_api_callbacks.py

@@ -3,6 +3,7 @@
 """
 
 from influxdb_client import InfluxDBClient, Point
+from influxdb_client.client.exceptions import InfluxDBError
 
 """
 Configuration
@@ -25,11 +26,11 @@ def success(self, conf: (str, str, str), data: str):
         """Successfully writen batch."""
         print(f"Written batch: {conf}, data: {data}")
 
-    def error(self, conf: (str, str, str), data: str, exception: Exception):
+    def error(self, conf: (str, str, str), data: str, exception: InfluxDBError):
         """Unsuccessfully writen batch."""
         print(f"Cannot write batch: {conf}, data: {data} due: {exception}")
 
-    def retry(self, conf: (str, str, str), data: str, exception: Exception):
+    def retry(self, conf: (str, str, str), data: str, exception: InfluxDBError):
         """Retryable error."""
         print(f"Retryable error occurs for batch: {conf}, data: {data} retry: {exception}")
 

influxdb_client/client/influxdb_client.py

@@ -278,17 +278,18 @@ def write_api(self, write_options=WriteOptions(), point_settings=PointSettings()
         .. code-block:: python
 
             from influxdb_client import InfluxDBClient
+            from influxdb_client.client.exceptions import InfluxDBError
 
 
             class BatchingCallback(object):
 
                 def success(self, conf: (str, str, str), data: str):
                     print(f"Written batch: {conf}, data: {data}")
 
-                def error(self, conf: (str, str, str), data: str, exception: Exception):
+                def error(self, conf: (str, str, str), data: str, exception: InfluxDBError):
                     print(f"Cannot write batch: {conf}, data: {data} due: {exception}")
 
-                def retry(self, conf: (str, str, str), data: str, exception: Exception):
+                def retry(self, conf: (str, str, str), data: str, exception: InfluxDBError):
                     print(f"Retryable error occurs for batch: {conf}, data: {data} retry: {exception}")
 
 

tests/test_WriteApiBatching.py

@@ -618,7 +618,7 @@ def __init__(self):
                 self.data = None
                 self.error = None
 
-            def __call__(self, conf: (str, str, str), data: str, error: ApiException):
+            def __call__(self, conf: (str, str, str), data: str, error: InfluxDBError):
                 self.conf = conf
                 self.data = data
                 self.error = error
@@ -645,8 +645,8 @@ def __call__(self, conf: (str, str, str), data: str, error: ApiException):
         self.assertEqual("my-org", callback.conf[1])
         self.assertEqual("ns", callback.conf[2])
         self.assertIsNotNone(callback.error)
-        self.assertEqual(ApiException, type(callback.error))
-        self.assertEqual(400, callback.error.status)
+        self.assertIsInstance(callback.error, InfluxDBError)
+        self.assertEqual(400, callback.error.response.status)
 
     def test_retry_callback(self):
         httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
@@ -689,7 +689,7 @@ def __call__(self, conf: (str, str, str), data: str, error: InfluxDBError):
         self.assertEqual("my-org", callback.conf[1])
         self.assertEqual("ns", callback.conf[2])
         self.assertIsNotNone(callback.error)
-        self.assertEqual(InfluxDBError, type(callback.error))
+        self.assertIsInstance(callback.error, InfluxDBError)
         self.assertEqual(429, callback.error.response.status)