wip

NguyenHoangSon96 · NguyenHoangSon96 · commit c7b31016f594 · 2025-04-29T17:04:14.000+07:00
diff --git a/influxdb_client_3/__init__.py b/influxdb_client_3/__init__.py
@@ -32,6 +32,7 @@
 INFLUX_PROFILERS = "INFLUX_PROFILERS"
 INFLUX_TAG = "INFLUX_TAG"
 
+
 def write_client_options(**kwargs):
     """
     Function for providing additional arguments for the WriteApi client.
@@ -104,11 +105,19 @@ def _merge_options(defaults, exclude_keys=None, custom=None):
 
 def _parse_precision(precision):
     """
-    Parse and validate precision value.
-    
-    :param precision: Precision value to validate
-    :return: Validated precision value
-    :raises ValueError: If precision is invalid
+    Parses the precision value and ensures it is valid.
+
+    This function checks that the given `precision` is one of the allowed
+    values defined in `WritePrecision`. If the precision is invalid, it
+    raises a `ValueError`. The function returns the valid precision value
+    if it passes validation.
+
+    :param precision: The precision value to be validated.
+                      Must be one of WritePrecision.NS, WritePrecision.MS,
+                      WritePrecision.S, or WritePrecision.US.
+    :return: The valid precision value.
+    :rtype: WritePrecision
+    :raises ValueError: If the provided precision is not valid.
     """
     if precision not in [WritePrecision.NS, WritePrecision.MS, WritePrecision.S, WritePrecision.US]:
         raise ValueError(f"Invalid precision value: {precision}")
@@ -117,11 +126,18 @@ def _parse_precision(precision):
 
 def _parse_gzip_threshold(threshold):
     """
-    Parse and validate gzip threshold value.
-
-    :param threshold: Threshold value to validate
-    :return: Validated threshold value
-    :raises ValueError: If threshold is invalid
+    Parses and validates the provided threshold value.
+
+    This function ensures that the given threshold is a valid integer value,
+    and it raises an appropriate error if the threshold is not valid. It also
+    enforces that the threshold value is non-negative.
+
+    :param threshold: The input threshold value to be parsed and validated.
+    :type threshold: Any
+    :return: The validated threshold value as an integer.
+    :rtype: int
+    :raises ValueError: If the provided threshold is not an integer or if it is
+        negative.
     """
     try:
         threshold = int(threshold)
@@ -248,30 +264,32 @@ def __init__(
                                     flight_client_options=flight_client_options,
                                     proxy=kwargs.get("proxy", None), options=q_opts_builder.build())
 
-
     @classmethod
     def from_env(cls, **kwargs: Any) -> 'InfluxDBClient3':
 
         """
-        Create an instance of `InfluxDBClient3` using environment variables for configuration.
-
-        This function retrieves and validates the following required environment variables:
-          - `INFLUX_HOST`: The hostname or IP address of the InfluxDB server.
-          - `INFLUX_TOKEN`: The authentication token used for accessing the server.
-          - `INFLUX_DATABASE`: The default database for the client operations.
-        And optional environment variable:
-          - `INFLUX_ORG`: The organization associated with InfluxDB operations.
-                          Defaults to "default" if not set.
-
-        If any of the required environment variables are not set, a ValueError will be
-        raised with details about the missing variables.
-
-        :param kwargs: Additional keyword arguments that will be passed to the
-                       `InfluxDBClient3` constructor for customization. This allows for
-                       configuring specific client behaviors like write_client_options,
-                       flight_client_options, SSL settings, etc.
-        :return: An initialized `InfluxDBClient3` instance.
-        :raises ValueError: If any required environment variables are not set.
+        Creates an instance of InfluxDBClient3 configured by specific environment
+        variables. This method automatically loads configuration settings,
+        such as connection details, security parameters, and performance
+        options, from environment variables and initializes the client
+        accordingly.
+
+        :param cls:
+            The class used to create the client instance.
+        :param kwargs:
+            Additional optional parameters that can be passed to customize the
+            configuration or override specific settings derived from the
+            environment variables.
+
+        :raises ValueError:
+            If any required environment variables are missing or have empty
+            values.
+
+        :return:
+            An initialized instance of the `InfluxDBClient3` class with all the
+            configuration settings applied.
+        :rtype:
+            InfluxDBClient3
         """
 
         required_vars = {
@@ -344,7 +362,6 @@ def from_env(cls, **kwargs: Any) -> 'InfluxDBClient3':
             **kwargs
         )
 
-
     def write(self, record=None, database=None, **kwargs):
         """
         Write data to InfluxDB.
diff --git a/influxdb_client_3/write_client/_sync/api_client.py b/influxdb_client_3/write_client/_sync/api_client.py
@@ -179,6 +179,27 @@ def __call_api(
                     response_data.getheaders())
 
     def check_should_compress(self, body: bytearray, gzip_threshold: int, enable_gzip: bool) -> bool:
+        """
+        Determines whether the given body should be compressed based on its size,
+        a defined threshold for compression, and a flag indicating whether
+        compression is enabled.
+
+        This function evaluates whether the body meets the required criteria for
+        compression. Compression may be enabled explicitly or conditionally
+        based on the body size exceeding the provided threshold.
+
+        :param body: The content to be evaluated for compression.
+        :type body: bytearray
+        :param gzip_threshold: The minimum size threshold for compression to be applied.
+        :type gzip_threshold: int
+        :param enable_gzip: A flag indicating whether gzip compression is enabled.
+            It can explicitly enable or disable compression, or conditionally
+            allow compression if the body size exceeds the threshold.
+        :type enable_gzip: bool
+        :return: Returns True if the body meets the criteria for compression;
+            otherwise, returns False.
+        :rtype: bool
+        """
         body_size = len(body)
         if enable_gzip is True or (enable_gzip is not False and (gzip_threshold and body_size >= gzip_threshold)):
             return True
diff --git a/influxdb_client_3/write_client/client/_base.py b/influxdb_client_3/write_client/client/_base.py
@@ -36,6 +36,50 @@
 class _BaseClient(object):
     def __init__(self, url, token, debug=None, timeout=10_000, enable_gzip=False, gzip_threshold=None, org: str = None,
                  default_tags: dict = None, http_client_logger: str = None, **kwargs) -> None:
+        """
+        Initializes the configuration for an HTTP client with support for customizable settings
+        such as authentication token, debugging, timeout, and gzip compression. This class
+        encapsulates the client configuration, logging setup, and authentication mechanisms
+        to allow seamless interaction with an HTTP backend.
+
+        :param url: The base URL for the HTTP client.
+        :type url: str
+        :param token: The authentication token to be used in requests.
+        :type token: str
+        :param debug: Enables debug mode for logging client operations. Defaults to None.
+        :type debug: bool, optional
+        :param timeout: The timeout duration for HTTP requests in milliseconds. Defaults to 10,000.
+        :type timeout: int
+        :param enable_gzip: Flag to enable or disable gzip compression. Defaults to False.
+        :type enable_gzip: bool
+        :param gzip_threshold: The threshold size for enabling gzip compression, if applicable.
+        :type gzip_threshold: int, optional
+        :param org: The organization identifier to be associated with the client.
+        :type org: str, optional
+        :param default_tags: A dictionary of default tags to add to outgoing requests for metadata purposes.
+        :type default_tags: dict, optional
+        :param http_client_logger: The logger name to use for HTTP client-specific logging.
+        :type http_client_logger: str, optional
+        :param kwargs: Additional optional parameters to customize the HTTP client:
+
+            - verify_ssl: Flag to enable or disable SSL certificate verification. Defaults to True.
+            - ssl_ca_cert: Path to the CA certificate file for verifying SSL. Defaults to None.
+            - cert_file: Path to a client SSL certificate file for authentication. Defaults to None.
+            - cert_key_file: Path to the client’s SSL key file, if separate. Defaults to None.
+            - cert_key_password: Password for the client’s SSL key file, if applicable. Defaults to None.
+            - ssl_context: SSLContext object to configure custom SSL parameters. Defaults to None.
+            - proxy: Proxy server URL, if a proxy is to be used. Defaults to None.
+            - proxy_headers: A dictionary containing custom headers for the proxy server. Defaults to None.
+            - connection_pool_maxsize: Defines the maximum pool size for connections.
+              Default inherits from the configuration.
+            - retries: Determines if request retrying is enabled. Defaults to None.
+            - profilers: Profilers for performance tracking. Defaults to None.
+            - username: Username for basic authentication. Defaults to None.
+            - password: Password for basic authentication. Defaults to None.
+            - auth_scheme: Custom authentication scheme to use with the token. Defaults to "Token".
+            - auth_basic: Boolean flag to enable HTTP Basic Authentication. Defaults to False.
+
+        """
         self.url = url
         self.org = org
 
diff --git a/influxdb_client_3/write_client/client/influxdb_client.py b/influxdb_client_3/write_client/client/influxdb_client.py
@@ -49,7 +49,9 @@ def __init__(self, url, token: str = None,
                                                except batching writes. As a default there is no one retry strategy.
         :key bool auth_basic: Set this to true to enable basic authentication when talking to a InfluxDB 1.8.x that
                               does not use auth-enabled but is protected by a reverse proxy with basic authentication.
-                              (defaults to false, don't set to true when talking to InfluxDB 2)
+                              (defaults to false, don't set to true when talking to InfluxDB 2).
+        :key int gzip_threshold: If the payload size is larger than this gzip_threshold, then
+                                 the payload will be zipped.
         :key str username: ``username`` to authenticate via username and password credentials to the InfluxDB 2.x
         :key str password: ``password`` to authenticate via username and password credentials to the InfluxDB 2.x
         :key list[str] profilers: list of enabled Flux profilers
diff --git a/influxdb_client_3/write_client/client/write_api.py b/influxdb_client_3/write_client/client/write_api.py
@@ -80,6 +80,8 @@ def __init__(self, write_type: WriteType = WriteType.batching,
         :param max_close_wait: the maximum time to wait for writes to be flushed if close() is called
         :param write_precision: the time precision for the data written to InfluxDB.
         :param write_scheduler:
+        :param gzip_threshold: if the payload size is larger than the gzip_threshold, the payload will be zipped.
+        :param enable_gzip: set true to enable to zip the payload.
         """
         self.write_type = write_type
         self.batch_size = batch_size
