feat: improve error handling

Author: NguyenHoangSon96

Examples/handle_query_error.py

@@ -0,0 +1,33 @@
+"""
+Demonstrates handling error when querying InfluxDB.
+"""
+import logging
+from config import Config
+from influxdb_client_3.influxdb_client_error import InfluxdbClientQueryError
+
+import influxdb_client_3 as InfluxDBClient3
+
+
+def main() -> None:
+    """
+    Main function
+    :return:
+    """
+    config = Config()
+    logging.basicConfig(format='%(asctime)s %(message)s', level=logging.INFO)
+
+    client = InfluxDBClient3.InfluxDBClient3(
+        host=config.host,
+        token=config.token,
+        database=config.database
+    )
+
+    try:
+        # Select from a bucket that doesn't exist
+        client.query("Select a from cpu11")
+    except InfluxdbClientQueryError as e:
+        logging.log(logging.ERROR, e.message)
+
+
+if __name__ == "__main__":
+    main()

influxdb_client_3/influxdb_client_error.py

@@ -1,12 +1,28 @@
 class InfluxDBClientError(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
 
 
 class InfluxdbClientQueryError(InfluxDBClientError):
+    """
+    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
-
-
-class InfluxdbClientWriteError(InfluxDBClientError):
-    pass