influxdb3-python 0.7.0__tar.gz → 0.8.0__tar.gz

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: influxdb3-python
-Version: 0.7.0
+Version: 0.8.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -93,7 +93,7 @@ from influxdb_client_3 import InfluxDBClient3, Point
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
 1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use a bucketname for the database argument.
+2. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/README.md

@@ -58,7 +58,7 @@ from influxdb_client_3 import InfluxDBClient3, Point
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
 1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use a bucketname for the database argument.
+2. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb3_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: influxdb3-python
-Version: 0.7.0
+Version: 0.8.0
 Summary: Community Python client for InfluxDB 3.0
 Home-page: https://github.com/InfluxCommunity/influxdb3-python
 Author: InfluxData
@@ -93,7 +93,7 @@ from influxdb_client_3 import InfluxDBClient3, Point
 ## Initialization
 If you are using InfluxDB Cloud, then you should note that:
 1. You will need to supply your org id, this is not necessary for InfluxDB Dedicated.
-2. Use a bucketname for the database argument.
+2. Use bucket name for the `database` argument.
 
 ```python
 client = InfluxDBClient3(token="your-token",

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb3_python.egg-info/SOURCES.txt

@@ -51,6 +51,6 @@ tests/test_influxdb_client_3.py
 tests/test_influxdb_client_3_integration.py
 tests/test_merge_options.py
 tests/test_point.py
-tests/test_polars_dataframe_serializer.py
+tests/test_polars.py
 tests/test_query.py
 tests/test_write_file.py

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb_client_3/__init__.py

@@ -110,7 +110,28 @@ class InfluxDBClient3:
         :type write_client_options: callable
         :param flight_client_options: Function for providing additional arguments for the FlightClient.
         :type flight_client_options: callable
-        :param kwargs: Additional arguments for the InfluxDB Client.
+        :key auth_scheme: token authentication scheme. Set to "Bearer" for Edge.
+        :key bool verify_ssl: Set this to false to skip verifying SSL certificate when calling API from https server.
+        :key str ssl_ca_cert: Set this to customize the certificate file to verify the peer.
+        :key str cert_file: Path to the certificate that will be used for mTLS authentication.
+        :key str cert_key_file: Path to the file contains private key for mTLS certificate.
+        :key str cert_key_password: String or function which returns password for decrypting the mTLS private key.
+        :key ssl.SSLContext ssl_context: Specify a custom Python SSL Context for the TLS/ mTLS handshake.
+                                         Be aware that only delivered certificate/ key files or an SSL Context are
+                                         possible.
+        :key str proxy: Set this to configure the http proxy to be used (ex. http://localhost:3128)
+        :key str proxy_headers: A dictionary containing headers that will be sent to the proxy. Could be used for proxy
+                                authentication.
+        :key int connection_pool_maxsize: Number of connections to save that can be reused by urllib3.
+                                          Defaults to "multiprocessing.cpu_count() * 5".
+        :key urllib3.util.retry.Retry retries: Set the default retry strategy that is used for all HTTP requests
+                                               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)
+        :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
         """
         self._org = org if org is not None else "default"
         self._database = database

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb_client_3/version.py

@@ -1,4 +1,4 @@
 """Version of the Client that is used in User-Agent header."""
 
-VERSION = '0.7.0'
+VERSION = '0.8.0'
 USER_AGENT = f'influxdb3-python/{VERSION}'

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb_client_3/write_client/client/_base.py

@@ -37,7 +37,6 @@ class _BaseClient(object):
     def __init__(self, url, token, debug=None, timeout=10_000, enable_gzip=False, org: str = None,
                  default_tags: dict = None, http_client_logger: str = None, **kwargs) -> None:
         self.url = url
-        self.token = token
         self.org = org
 
         self.default_tags = default_tags
@@ -70,9 +69,10 @@ class _BaseClient(object):
         self.auth_header_name = None
         self.auth_header_value = None
         # by token
-        if self.token:
+        if token:
+            auth_scheme = kwargs.get('auth_scheme', "Token")
             self.auth_header_name = "Authorization"
-            self.auth_header_value = "Token " + self.token
+            self.auth_header_value = f"{auth_scheme} {token}"
         # by HTTP basic
         auth_basic = kwargs.get('auth_basic', False)
         if auth_basic:
@@ -248,7 +248,8 @@ class _BaseWriteApi(object):
             self._serialize(Point.from_dict(record, write_precision=write_precision, **kwargs),
                             write_precision, payload, **kwargs)
         elif 'polars' in str(type(record)):
-            from influxdb_client_3.write_client.client.write.dataframe_serializer import PolarsDataframeSerializer
+            from influxdb_client_3.write_client.client.write.polars_dataframe_serializer import \
+                PolarsDataframeSerializer
             serializer = PolarsDataframeSerializer(record, self._point_settings, write_precision, **kwargs)
             self._serialize(serializer.serialize(), write_precision, payload, **kwargs)
 

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb_client_3/write_client/client/exceptions.py

@@ -26,8 +26,18 @@ class InfluxDBError(Exception):
         # Body
         if response.data:
             import json
+
+            def get(d, key):
+                if not key or d is None:
+                    return d
+                return get(d.get(key[0]), key[1:])
             try:
-                return json.loads(response.data)["message"]
+                node = json.loads(response.data)
+                for key in [['message'], ['data', 'error_message'], ['error']]:
+                    value = get(node, key)
+                    if value is not None:
+                        return value
+                return response.data
             except Exception as e:
                 logging.debug(f"Cannot parse error response to JSON: {response.data}, {e}")
                 return response.data

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/influxdb_client_3/write_client/client/influxdb_client.py

@@ -27,6 +27,7 @@ class InfluxDBClient(_BaseClient):
         :param enable_gzip: Enable Gzip compression for http requests. Currently, only the "Write" and "Query" endpoints
                             supports the Gzip compression.
         :param org: organization name (used as a default in Query, Write and Delete API)
+        :key auth_scheme: token authentication scheme. Set to "Bearer" for Edge.
         :key bool verify_ssl: Set this to false to skip verifying SSL certificate when calling API from https server.
         :key str ssl_ca_cert: Set this to customize the certificate file to verify the peer.
         :key str cert_file: Path to the certificate that will be used for mTLS authentication.

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/tests/test_api_client.py

@@ -1,12 +1,13 @@
 import unittest
 from unittest import mock
+from urllib3 import response
 
 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.write_client.service import WriteService
 from influxdb_client_3.version import VERSION
 
-
 _package = "influxdb3-python"
 _sentHeaders = {}
 
@@ -69,3 +70,38 @@ class ApiClientTests(unittest.TestCase):
         self.assertEqual("Bearer TEST_TOKEN", _sentHeaders["Authorization"])
         self.assertIsNotNone(_sentHeaders["User-Agent"])
         self.assertEqual(f"{_package}/{VERSION}", _sentHeaders["User-Agent"])
+
+    def _test_api_error(self, body):
+        conf = Configuration()
+        client = ApiClient(conf)
+        client.rest_client.pool_manager.request \
+            = mock.Mock(return_value=response.HTTPResponse(status=400,
+                                                           reason='Bad Request',
+                                                           body=body.encode()))
+        service = WriteService(client)
+        service.post_write("TEST_ORG", "TEST_BUCKET", "data,foo=bar val=3.14")
+
+    def test_api_error_cloud(self):
+        response_body = '{"message": "parsing failed for write_lp endpoint"}'
+        with self.assertRaises(InfluxDBError) as err:
+            self._test_api_error(response_body)
+        self.assertEqual('parsing failed for write_lp endpoint', err.exception.message)
+
+    def test_api_error_oss_without_detail(self):
+        response_body = '{"error": "parsing failed for write_lp endpoint"}'
+        with self.assertRaises(InfluxDBError) as err:
+            self._test_api_error(response_body)
+        self.assertEqual('parsing failed for write_lp endpoint', err.exception.message)
+
+    def test_api_error_oss_with_detail(self):
+        response_body = ('{"error":"parsing failed for write_lp endpoint","data":{"error_message":"invalid field value '
+                         'in line protocol for field \'val\' on line 1"}}')
+        with self.assertRaises(InfluxDBError) as err:
+            self._test_api_error(response_body)
+        self.assertEqual('invalid field value in line protocol for field \'val\' on line 1', err.exception.message)
+
+    def test_api_error_unknown(self):
+        response_body = '{"detail":"no info"}'
+        with self.assertRaises(InfluxDBError) as err:
+            self._test_api_error(response_body)
+        self.assertEqual(response_body, err.exception.message)

{influxdb3_python-0.7.0 → influxdb3_python-0.8.0}/tests/test_influxdb_client_3.py

@@ -27,6 +27,27 @@ class TestInfluxDBClient3(unittest.TestCase):
         self.assertEqual(self.client._write_api, self.mock_write_api.return_value)
         self.assertEqual(self.client._query_api, self.mock_query_api.return_value)
 
+    # test default token auth_scheme
+    def test_token_auth_scheme_default(self):
+        client = InfluxDBClient3(
+            host="localhost",
+            org="my_org",
+            database="my_db",
+            token="my_token",
+        )
+        self.assertEqual(client._client.auth_header_value, "Token my_token")
+
+    # test explicit token auth_scheme
+    def test_token_auth_scheme_explicit(self):
+        client = InfluxDBClient3(
+            host="localhost",
+            org="my_org",
+            database="my_db",
+            token="my_token",
+            auth_scheme="my_scheme"
+        )
+        self.assertEqual(client._client.auth_header_value, "my_scheme my_token")
+
 
 if __name__ == '__main__':
     unittest.main()

influxdb3_python-0.8.0/tests/test_influxdb_client_3_integration.py

@@ -0,0 +1,58 @@
+import os
+import time
+import unittest
+
+import pytest
+
+from influxdb_client_3 import InfluxDBClient3, InfluxDBError
+
+
+@pytest.mark.integration
+@pytest.mark.skipif(
+    not all(
+        [
+            os.getenv('TESTING_INFLUXDB_URL'),
+            os.getenv('TESTING_INFLUXDB_TOKEN'),
+            os.getenv('TESTING_INFLUXDB_DATABASE'),
+        ]
+    ),
+    reason="Integration test environment variables not set.",
+)
+class TestInfluxDBClient3Integration(unittest.TestCase):
+
+    def setUp(self):
+        self.host = os.getenv('TESTING_INFLUXDB_URL')
+        self.token = os.getenv('TESTING_INFLUXDB_TOKEN')
+        self.database = os.getenv('TESTING_INFLUXDB_DATABASE')
+        self.client = InfluxDBClient3(host=self.host, database=self.database, token=self.token)
+
+    def tearDown(self):
+        if self.client:
+            self.client.close()
+
+    def test_write_and_query(self):
+        test_id = time.time_ns()
+        self.client.write(f"integration_test_python,type=used value=123.0,test_id={test_id}i")
+
+        sql = 'SELECT * FROM integration_test_python where type=$type and test_id=$test_id'
+
+        df = self.client.query(sql, mode="pandas", query_parameters={'type': 'used', 'test_id': test_id})
+
+        self.assertIsNotNone(df)
+        self.assertEqual(1, len(df))
+        self.assertEqual(test_id, df['test_id'][0])
+        self.assertEqual(123.0, df['value'][0])
+
+    def test_auth_error_token(self):
+        self.client = InfluxDBClient3(host=self.host, database=self.database, token='fake token')
+        test_id = time.time_ns()
+        with self.assertRaises(InfluxDBError) as err:
+            self.client.write(f"integration_test_python,type=used value=123.0,test_id={test_id}i")
+        self.assertEqual('unauthorized access', err.exception.message)  # Cloud
+
+    def test_auth_error_auth_scheme(self):
+        self.client = InfluxDBClient3(host=self.host, database=self.database, token=self.token, auth_scheme='Any')
+        test_id = time.time_ns()
+        with self.assertRaises(InfluxDBError) as err:
+            self.client.write(f"integration_test_python,type=used value=123.0,test_id={test_id}i")
+        self.assertEqual('unauthorized access', err.exception.message)  # Cloud

influxdb3_python-0.7.0/tests/test_polars_dataframe_serializer.py → influxdb3_python-0.8.0/tests/test_polars.py

@@ -1,7 +1,9 @@
-import unittest
 import importlib.util
+import unittest
+from unittest.mock import Mock
 
-from influxdb_client_3 import PointSettings
+from influxdb_client_3 import PointSettings, InfluxDBClient3
+from influxdb_client_3.write_client import WriteService
 from influxdb_client_3.write_client.client.write.polars_dataframe_serializer import polars_data_frame_to_list_of_points
 
 
@@ -29,3 +31,33 @@ class TestPolarsDataFrameSerializer(unittest.TestCase):
             'iot-devices,building=5a name="iot-devices",temperature=72.2 1664798460000000000'
         ]
         self.assertEqual(expected, actual)
+
+
+@unittest.skipIf(importlib.util.find_spec("polars") is None, 'Polars package not installed')
+class TestWritePolars(unittest.TestCase):
+    def setUp(self):
+        self.client = InfluxDBClient3(
+            host="localhost",
+            org="my_org",
+            database="my_db",
+            token="my_token"
+        )
+
+    def test_write_polars(self):
+        import polars as pl
+        df = pl.DataFrame({
+            "time": pl.Series(["2024-08-01 00:00:00", "2024-08-01 01:00:00"]).str.to_datetime(time_unit='ns'),
+            "temperature": [22.4, 21.8],
+        })
+        self.client._write_api._write_service = Mock(spec=WriteService)
+
+        self.client.write(
+            database="database",
+            record=df,
+            data_frame_measurement_name="measurement",
+            data_frame_timestamp_column="time",
+        )
+
+        actual = self.client._write_api._write_service.post_write.call_args[1]['body']
+        self.assertEqual(b'measurement temperature=22.4 1722470400000000000\n'
+                         b'measurement temperature=21.8 1722474000000000000', actual)

influxdb3_python-0.7.0/tests/test_influxdb_client_3_integration.py

@@ -1,45 +0,0 @@
-import os
-import time
-import unittest
-
-import pytest
-
-from influxdb_client_3 import InfluxDBClient3
-
-
-@pytest.mark.integration
-@pytest.mark.skipif(
-    not all(
-        [
-            os.getenv('TESTING_INFLUXDB_URL'),
-            os.getenv('TESTING_INFLUXDB_TOKEN'),
-            os.getenv('TESTING_INFLUXDB_DATABASE'),
-        ]
-    ),
-    reason="Integration test environment variables not set.",
-)
-class TestInfluxDBClient3Integration(unittest.TestCase):
-
-    def setUp(self):
-        host = os.getenv('TESTING_INFLUXDB_URL')
-        token = os.getenv('TESTING_INFLUXDB_TOKEN')
-        database = os.getenv('TESTING_INFLUXDB_DATABASE')
-
-        self.client = InfluxDBClient3(host=host, database=database, token=token)
-
-    def tearDown(self):
-        if self.client:
-            self.client.close()
-
-    def test_write_and_query(self):
-        test_id = time.time_ns()
-        self.client.write(f"integration_test_python,type=used value=123.0,test_id={test_id}i")
-
-        sql = 'SELECT * FROM integration_test_python where type=$type and test_id=$test_id'
-
-        df = self.client.query(sql, mode="pandas", query_parameters={'type': 'used', 'test_id': test_id})
-
-        self.assertIsNotNone(df)
-        self.assertEqual(1, len(df))
-        self.assertEqual(test_id, df['test_id'][0])
-        self.assertEqual(123.0, df['value'][0])