feat: support-basic-env

Author: NguyenHoangSon96

influxdb_client_3/__init__.py

@@ -1,6 +1,7 @@
+import importlib.util
 import urllib.parse
+
 import pyarrow as pa
-import importlib.util
 
 from influxdb_client_3.query.query_api import QueryApi as _QueryApi, QueryApiOptionsBuilder
 from influxdb_client_3.read_file import UploadFile

influxdb_client_3/write_client/client/_base.py

@@ -7,6 +7,8 @@
 import os
 from typing import Iterable
 
+from typing_extensions import deprecated
+
 from influxdb_client_3.write_client.client.write.dataframe_serializer import DataframeSerializer
 from influxdb_client_3.write_client.configuration import Configuration
 from influxdb_client_3.write_client.rest import _UTF_8_encoding
@@ -173,6 +175,7 @@ def _has_section(key: str):
                    profilers=profilers, proxy=proxy, **kwargs)
 
     @classmethod
+    @deprecated('Use _from_env() instead.')
     def _from_env_properties(cls, debug=None, enable_gzip=False, **kwargs):
         url = os.getenv('INFLUXDB_V2_URL', "http://localhost:8086")
         token = os.getenv('INFLUXDB_V2_TOKEN', "my-token")
@@ -203,6 +206,53 @@ def _from_env_properties(cls, debug=None, enable_gzip=False, **kwargs):
                    connection_pool_maxsize=_to_int(connection_pool_maxsize), auth_basic=_to_bool(auth_basic),
                    profilers=profilers, **kwargs)
 
+    @classmethod
+    def _from_env(cls, debug=None, enable_gzip=False, **kwargs):
+        """
+        Creates and configures an instance of the class using environment variable values. The method loads
+        configuration values for connecting to an InfluxDB server instance from preset environment variables.
+        Options include connection details such as host, token, organization, and optional parameters
+        like SSL settings, profiling, and default tags. Non-specified parameters fallback to defaults
+        or None, ensuring a straightforward integration with varied InfluxDB setups.
+
+        :param debug: Determines whether debugging mode is enabled.
+        :type debug: Optional[bool]
+        :param enable_gzip: Indicates whether gzip compression is enabled for requests.
+        :type enable_gzip: bool
+        :param kwargs: Additional keyword arguments to configure the instance.
+        :type kwargs: dict
+        :return: Instance of the class configured using the provided environmental settings.
+        :rtype: cls
+        """
+        url = os.getenv('INFLUX_HOST', "http://localhost:8086")
+        token = os.getenv('INFLUX_TOKEN', "my-token")
+        org = os.getenv('INFLUX_ORG', "my-org")
+        timeout = os.getenv('INFLUX_TIMEOUT', "10000")
+        verify_ssl = os.getenv('INFLUX_VERIFY_SSL', "True")
+        ssl_ca_cert = os.getenv('INFLUX_SSL_CA_CERT', None)
+        cert_file = os.getenv('INFLUX_CERT_FILE', None)
+        cert_key_file = os.getenv('INFLUX_CERT_KEY_FILE', None)
+        cert_key_password = os.getenv('INFLUX_CERT_KEY_PASSWORD', None)
+        connection_pool_maxsize = os.getenv('INFLUX_CONNECTION_POOL_MAXSIZE', None)
+        auth_basic = os.getenv('INFLUX_AUTH_BASIC', "False")
+
+        prof = os.getenv("INFLUX_PROFILERS", None)
+        profilers = None
+        if prof is not None:
+            profilers = [x.strip() for x in prof.split(',')]
+
+        default_tags = dict()
+
+        for key, value in os.environ.items():
+            if key.startswith("INFLUX_TAG_"):
+                default_tags[key[11:].lower()] = value
+
+        return cls(url, token, debug=debug, timeout=_to_int(timeout), org=org, default_tags=default_tags,
+                   enable_gzip=enable_gzip, verify_ssl=_to_bool(verify_ssl), ssl_ca_cert=ssl_ca_cert,
+                   cert_file=cert_file, cert_key_file=cert_key_file, cert_key_password=cert_key_password,
+                   connection_pool_maxsize=_to_int(connection_pool_maxsize), auth_basic=_to_bool(auth_basic),
+                   profilers=profilers, **kwargs)
+
 
 class _BaseWriteApi(object):
     def __init__(self, influxdb_client, point_settings=None):

influxdb_client_3/write_client/client/influxdb_client.py

@@ -4,6 +4,8 @@
 
 import logging
 
+from typing_extensions import deprecated
+
 from influxdb_client_3.write_client.client._base import _BaseClient
 from influxdb_client_3.write_client.client.write_api import WriteApi, WriteOptions, PointSettings
 
@@ -167,6 +169,7 @@ def from_config_file(cls, config_file: str = "config.ini", debug=None, enable_gz
         return InfluxDBClient._from_config_file(config_file=config_file, debug=debug, enable_gzip=enable_gzip, **kwargs)
 
     @classmethod
+    @deprecated('Use InfluxDBClient.from_env() instead.')
     def from_env_properties(cls, debug=None, enable_gzip=False, **kwargs):
         """
         Configure client via environment properties.
@@ -200,6 +203,22 @@ def from_env_properties(cls, debug=None, enable_gzip=False, **kwargs):
         """
         return InfluxDBClient._from_env_properties(debug=debug, enable_gzip=enable_gzip, **kwargs)
 
+    @classmethod
+    def from_env(cls, debug=None, enable_gzip=False, **kwargs):
+        """
+        Creates an instance of the class using environment configuration variables.
+
+        This class method retrieves configuration variables from the system environment
+        and uses them to configure and initialize an instance of the class. This allows
+        for dynamic configuration of the client without the need for hardcoding values
+        or explicitly passing them during instantiation.
+
+        :param debug: Enable verbose logging of http requests
+        :param enable_gzip: Enable Gzip compression for http requests. Currently, only the "Write" and "Query" endpoints
+                            supports the Gzip compression.
+        """
+        return InfluxDBClient._from_env(debug=debug, enable_gzip=enable_gzip, **kwargs)
+
     def write_api(self, write_options=WriteOptions(), point_settings=PointSettings(), **kwargs) -> WriteApi:
         """
         Create Write API instance.

tests/test_influxdb_client.py

@@ -0,0 +1,34 @@
+import unittest
+from unittest.mock import patch
+
+import influxdb_client_3
+from influxdb_client_3 import WritePrecision
+
+
+class TestInfluxDBClient(unittest.TestCase):
+    @patch.dict('os.environ', {'INFLUX_HOST': 'http://localhost:9999', 'INFLUX_TOKEN': 'test_token',
+                               'INFLUX_DATABASE': 'test_db', 'INFLUX_ORG': 'test_org',
+                               'INFLUX_PRECISION': WritePrecision.MS, 'INFLUX_TIMEOUT': '6000',
+                               'INFLUX_VERIFY_SSL': 'False',
+                               'INFLUX_CERT_FILE': 'path_to_cert', 'INFLUX_CERT_KEY_FILE': 'path_to_cert_key',
+                               'INFLUX_CERT_KEY_PASSWORD': 'cert_key_password', 'INFLUX_CONNECTION_POOL_MAXSIZE': '200',
+                               'INFLUX_PROFILERS': 'prof1,prof2,prof3', 'INFLUX_TAG_NAME': 'Tag1'})
+    def test_from_env(self):
+        base = influxdb_client_3._InfluxDBClient.from_env(enable_gzip=True)
+        self.assertEqual(base.url, "http://localhost:9999")
+        self.assertEqual(base.org, "test_org")
+        self.assertEqual(base.default_tags['name'], "Tag1")
+        self.assertEqual(base.profilers, ['prof1', 'prof2', 'prof3'])
+        self.assertEqual(base.conf.enable_gzip, True)
+        self.assertEqual(base.conf.timeout, 6000)
+        self.assertEqual(base.conf.verify_ssl, False)
+        self.assertEqual(base.conf.connection_pool_maxsize, 200)
+        self.assertEqual(base.conf.cert_file, "path_to_cert")
+        self.assertEqual(base.conf.cert_key_file, "path_to_cert_key")
+        self.assertEqual(base.conf.cert_key_password, "cert_key_password")
+        self.assertEqual(base.auth_header_name, "Authorization")
+        self.assertEqual(base.auth_header_value, "Token test_token")
+
+
+if __name__ == '__main__':
+    unittest.main()