feat: support gzip_threshold

Author: NguyenHoangSon96

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 
 1. [#130](https://github.com/InfluxCommunity/influxdb3-python/pull/130): Remove org parameters from the example code because It is not mandatory in Influxdb3
+2. [#139](https://github.com/InfluxCommunity/influxdb3-python/pull/139): Supports environment variables with the same name like other clients   
 
 ## 0.12.0 [2025-03-26] 
 

influxdb_client_3/write_client/_sync/api_client.py

@@ -93,23 +93,38 @@ def set_default_header(self, header_name, header_value):
         self.default_headers[header_name] = header_value
 
     @staticmethod
-    def should_gzip(payload: str, enable_gzip: bool = True, gzip_threshold: int = None) -> bool:
+    def should_gzip(payload: str, enable_gzip: bool = False, gzip_threshold: int = None) -> bool:
         """
-        Determine if the payload should be compressed with gzip.
-
-        Args:
-            payload: The string content to potentially compress
-            enable_gzip: Flag indicating if gzip compression is enabled
-            gzip_threshold: Minimum size in bytes for compression to be applied
-
-        Returns:
-            bool: True if the payload should be compressed, False otherwise
+        Determines whether gzip compression should be applied to the given payload based
+        on the specified conditions. This method evaluates the `enable_gzip` flag and
+        considers the size of the payload in relation to the optional `gzip_threshold`.
+        If `enable_gzip` is set to True and no threshold is provided, gzip compression
+        is advised without any size condition. If a threshold is specified, compression
+        is applied only when the size of the payload meets or exceeds the threshold.
+        By default, no compression is performed if `enable_gzip` is False.
+
+        :param payload: The payload data as a string for which gzip determination is to
+            be made.
+        :type payload: str
+        :param enable_gzip: A flag indicating whether gzip compression is enabled. By
+            default, this flag is False.
+        :type enable_gzip: bool, optional
+        :param gzip_threshold: Optional threshold specifying the minimum size (in bytes)
+            of the payload to trigger gzip compression. Only considered if
+            `enable_gzip` is True.
+        :type gzip_threshold: int, optional
+        :return: A boolean value indicating True if gzip compression should be applied
+            based on the payload size, the enable_gzip flag, and the gzip_threshold.
+        :rtype: bool
         """
-        if not enable_gzip:
-            return False
-
-        payload_size = len(payload.encode('utf-8'))
-        return gzip_threshold is not None and payload_size >= gzip_threshold
+        if enable_gzip is not False:
+            if gzip_threshold is not None:
+                payload_size = len(payload.encode('utf-8'))
+                return payload_size >= gzip_threshold
+            if enable_gzip is True:
+                return True
+
+        return False
 
     def __call_api(
             self, resource_path, method, path_params=None,

tests/test_api_client.py

@@ -142,18 +142,22 @@ def test_api_error_headers(self):
 
     def test_should_gzip(self):
         # Test when gzip is disabled
-        assert not ApiClient.should_gzip("test", enable_gzip=False, gzip_threshold=1)
+        self.assertFalse(ApiClient.should_gzip("test", enable_gzip=False, gzip_threshold=1))
+        self.assertFalse(ApiClient.should_gzip("test", enable_gzip=False, gzip_threshold=10000))
+        self.assertFalse(ApiClient.should_gzip("test", enable_gzip=False, gzip_threshold=None))
 
-        # Test when threshold is None
-        assert not ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=None)
+        # Test when enable_gzip is True
+        self.assertTrue(ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=None))
+        self.assertTrue(ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=1))
+        self.assertFalse(ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=100000))
 
         # Test payload smaller than threshold
-        assert not ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=10000)
+        self.assertFalse(ApiClient.should_gzip("test", enable_gzip=True, gzip_threshold=10000))
 
         # Test payload larger than threshold
         large_payload = "x" * 10000
-        assert ApiClient.should_gzip(large_payload, enable_gzip=True, gzip_threshold=1000)
+        self.assertTrue(ApiClient.should_gzip(large_payload, enable_gzip=True, gzip_threshold=1000))
 
-        # Test exact threshold match
-        exact_payload = "x" * 1000
-        assert ApiClient.should_gzip(exact_payload, enable_gzip=True, gzip_threshold=1000)
+        # Test exact threshold match and less than threshold
+        payload = "x" * 1000
+        self.assertTrue(ApiClient.should_gzip(payload, enable_gzip=True, gzip_threshold=1000))