feat: improve error handling

Author: NguyenHoangSon96

Examples/handle_query_error.py

@@ -3,7 +3,7 @@
 """
 import logging
 from config import Config
-from influxdb_client_3.influxdb_client_error import InfluxdbClientQueryError
+from influxdb_client_3.exceptions.exceptions import InfluxDB3ClientQueryError
 
 import influxdb_client_3 as InfluxDBClient3
 
@@ -25,7 +25,7 @@ def main() -> None:
     try:
         # Select from a bucket that doesn't exist
         client.query("Select a from cpu11")
-    except InfluxdbClientQueryError as e:
+    except InfluxDB3ClientQueryError as e:
         logging.log(logging.ERROR, e.message)
 
 

influxdb_client_3/__init__.py

@@ -6,11 +6,11 @@
 import pyarrow as pa
 from pyarrow import ArrowException
 
-from influxdb_client_3.influxdb_client_error import InfluxdbClientQueryError
+from influxdb_client_3.exceptions.exceptions import InfluxDB3ClientQueryError
 from influxdb_client_3.query.query_api import QueryApi as _QueryApi, QueryApiOptionsBuilder
 from influxdb_client_3.read_file import UploadFile
 from influxdb_client_3.write_client import InfluxDBClient as _InfluxDBClient, WriteOptions, Point
-from influxdb_client_3.write_client.client.exceptions import InfluxDBError
+from influxdb_client_3.exceptions.exceptions import InfluxDBError
 from influxdb_client_3.write_client.client.write_api import WriteApi as _WriteApi, SYNCHRONOUS, ASYNCHRONOUS, \
     PointSettings, DefaultWriteOptions, WriteType
 from influxdb_client_3.write_client.domain.write_precision import WritePrecision
@@ -403,7 +403,7 @@ def query(self, query: str, language: str = "sql", mode: str = "all", database:
         try:
             return self._query_api.query(query=query, language=language, mode=mode, database=database, **kwargs)
         except ArrowException as e:
-            raise InfluxdbClientQueryError(f"Error while executing query: {e}")
+            raise InfluxDB3ClientQueryError(f"Error while executing query: {e}")
 
     async def query_async(self, query: str, language: str = "sql", mode: str = "all", database: str = None, **kwargs):
         """Query data from InfluxDB asynchronously.
@@ -436,7 +436,7 @@ async def query_async(self, query: str, language: str = "sql", mode: str = "all"
                                                      database=database,
                                                      **kwargs)
         except ArrowException as e:
-            raise InfluxdbClientQueryError(f"Error while executing query: {e}")
+            raise InfluxDB3ClientQueryError(f"Error while executing query: {e}")
 
     def close(self):
         """Close the client and clean up resources."""

influxdb_client_3/exceptions/__init__.py

@@ -4,10 +4,43 @@
 
 from urllib3 import HTTPResponse
 
-logger = logging.getLogger('influxdb_client_3.write_client.client.exceptions')
+logger = logging.getLogger('influxdb_client_3.exceptions.exceptions')
 
 
-class InfluxDBError(Exception):
+class InfluxDB3ClientError(Exception):
+    """
+    Exception raised for errors in the InfluxDB client operations.
+
+    Represents errors that occur during interactions with the InfluxDB
+    database client. This exception is a general base class for more
+    specific client-related failures and is typically used to signal issues
+    such as invalid queries, connection failures, or API misusage.
+    """
+    pass
+
+
+# This error is for all query operations
+class InfluxDB3ClientQueryError(InfluxDB3ClientError):
+    """
+    Represents an error that occurs when querying an InfluxDB client.
+
+    This class is specifically designed to handle errors originating from
+    client queries to an InfluxDB database. It extends the general
+    `InfluxDBClientError`, allowing more precise identification and
+    handling of query-related issues.
+
+    :ivar message: Contains the specific error message describing the
+        query error.
+    :type message: str
+    """
+
+    def __init__(self, error_message, *args, **kwargs):
+        super().__init__(error_message, *args, **kwargs)
+        self.message = error_message
+
+
+# This error is for all write operations
+class InfluxDBError(InfluxDB3ClientError):
     """Raised when a server error occurs."""
 
     def __init__(self, response: HTTPResponse = None, message: str = None):

…ient_3/write_client/client/exceptions.py …fluxdb_client_3/exceptions/exceptions.pyinfluxdb_client_3/write_client/client/exceptions.py renamed to influxdb_client_3/exceptions/exceptions.py influxdb_client_3/write_client/client/exceptions.py renamed to influxdb_client_3/exceptions/exceptions.py

@@ -8,7 +8,7 @@
 import multiprocessing
 
 from influxdb_client_3.write_client import InfluxDBClient, WriteOptions
-from influxdb_client_3.write_client.client.exceptions import InfluxDBError
+from influxdb_client_3.exceptions.exceptions import InfluxDBError
 
 logger = logging.getLogger('influxdb_client.client.util.multiprocessing_helper')
 

influxdb_client_3/influxdb_client_error.py

@@ -9,7 +9,7 @@
 from urllib3 import Retry
 from urllib3.exceptions import MaxRetryError, ResponseError
 
-from influxdb_client_3.write_client.client.exceptions import InfluxDBError
+from influxdb_client_3.exceptions.exceptions import InfluxDBError
 
 logger = logging.getLogger('influxdb_client.client.write.retry')
 

influxdb_client_3/write_client/client/util/multiprocessing_helper.py

@@ -5,7 +5,7 @@
 import logging
 from typing import Dict
 
-from influxdb_client_3.write_client.client.exceptions import InfluxDBError
+from influxdb_client_3.exceptions.exceptions import InfluxDBError
 from influxdb_client_3.write_client.configuration import Configuration
 
 _UTF_8_encoding = 'utf-8'

influxdb_client_3/write_client/client/write/retry.py

@@ -6,7 +6,7 @@
 
 from influxdb_client_3.write_client._sync.api_client import ApiClient
 from influxdb_client_3.write_client.configuration import Configuration
-from influxdb_client_3.write_client.client.exceptions import InfluxDBError
+from influxdb_client_3.exceptions.exceptions import InfluxDBError
 from influxdb_client_3.write_client.service import WriteService
 from influxdb_client_3.version import VERSION
 

influxdb_client_3/write_client/rest.py

@@ -2,7 +2,7 @@
 from unittest.mock import patch
 
 from influxdb_client_3 import InfluxDBClient3, WritePrecision, DefaultWriteOptions, Point, WriteOptions, WriteType
-from influxdb_client_3.influxdb_client_error import InfluxdbClientQueryError
+from influxdb_client_3.exceptions.exceptions import InfluxDB3ClientQueryError
 from tests.util import asyncio_run
 from tests.util.mocks import ConstantFlightServer, ConstantData, ErrorFlightServer
 
@@ -162,15 +162,15 @@ def test_parse_invalid_write_precision(self):
     def test_query_with_arrow_error(self):
         f = ErrorFlightServer()
         with InfluxDBClient3(f"http://localhost:{f.port}", "my_org", "my_db", "my_token") as c:
-            with self.assertRaises(InfluxdbClientQueryError) as err:
+            with self.assertRaises(InfluxDB3ClientQueryError) as err:
                 c.query("SELECT * FROM my_data")
             self.assertIn("Error while executing query", str(err.exception))
 
     @asyncio_run
     async def test_async_query_with_arrow_error(self):
         f = ErrorFlightServer()
         with InfluxDBClient3(f"http://localhost:{f.port}", "my_org", "my_db", "my_token") as c:
-            with self.assertRaises(InfluxdbClientQueryError) as err:
+            with self.assertRaises(InfluxDB3ClientQueryError) as err:
                 await c.query_async("SELECT * FROM my_data")
             self.assertIn("Error while executing query", str(err.exception))