feat: add record_measurement_name for static measurement name

Author: bednar

examples/write_structured_data.py

@@ -61,6 +61,6 @@ class Car:
     """
     write_api.write(bucket="my-bucket",
                     record=car,
-                    record_measurement_key="engine",
+                    record_measurement_name="performance",
                     record_tag_keys=["engine", "type"],
                     record_field_keys=["speed"])

influxdb_client/client/write/point.py

@@ -102,15 +102,19 @@ def from_dict(dictionary: dict, write_precision: WritePrecision = DEFAULT_WRITE_
                                         record_tag_keys=["location", "version"],
                                         record_field_keys=["pressure", "temperature"])
 
-        :param dictionary: dictionary for serialize into Point structure
+        :param dictionary: dictionary for serialize into data Point
         :param write_precision: sets the precision for the supplied time values
         :key record_measurement_key: key of dictionary with specified measurement
+        :key record_measurement_name: static measurement name for data Point
         :key record_time_key: key of dictionary with specified timestamp
         :key record_tag_keys: list of dictionary keys to use as a tag
         :key record_field_keys: list of dictionary keys to use as a field
         :return: new data point
         """
-        point = Point(dictionary[kwargs.get('record_measurement_key', 'measurement')])
+        measurement_ = kwargs.get('record_measurement_name', None)
+        if measurement_ is None:
+            measurement_ = dictionary[kwargs.get('record_measurement_key', 'measurement')]
+        point = Point(measurement_)
 
         record_tag_keys = kwargs.get('record_tag_keys', None)
         if record_tag_keys is not None:

influxdb_client/client/write_api.py

@@ -259,6 +259,7 @@ def write(self, bucket: str, org: str = None,
                                      rest columns will be fields - ``DataFrame``
         :key record_measurement_key: key of record with specified measurement -
                                      ``dictionary``, ``NamedTuple``, ``dataclass``
+        :key record_measurement_name: static measurement name - ``dictionary``, ``NamedTuple``, ``dataclass``
         :key record_time_key: key of record with specified timestamp - ``dictionary``, ``NamedTuple``, ``dataclass``
         :key record_tag_keys: list of record keys to use as a tag - ``dictionary``, ``NamedTuple``, ``dataclass``
         :key record_field_keys: list of record keys to use as a field  - ``dictionary``, ``NamedTuple``, ``dataclass``

tests/test_WriteApi.py

@@ -576,13 +576,13 @@ class Car:
         car = Car('12V-BT', 'sport-cars', 125.25)
         self.write_client.write("my-bucket", "my-org",
                                 record=car,
-                                record_measurement_key="engine",
+                                record_measurement_name="performance",
                                 record_tag_keys=["engine", "type"],
                                 record_field_keys=["speed"])
 
         requests = httpretty.httpretty.latest_requests
         self.assertEqual(1, len(requests))
-        self.assertEqual("12V-BT,engine=12V-BT,type=sport-cars speed=125.25", requests[0].parsed_body)
+        self.assertEqual("performance,engine=12V-BT,type=sport-cars speed=125.25", requests[0].parsed_body)
 
 
 class AsynchronousWriteTest(BaseTest):

tests/test_WriteApiBatching.py

@@ -562,7 +562,7 @@ class Car:
         car = Car('12V-BT', 'sport-cars', 125.25)
         self._write_client.write("my-bucket", "my-org",
                                  record=car,
-                                 record_measurement_key="engine",
+                                 record_measurement_name="performance",
                                  record_tag_keys=["engine", "type"],
                                  record_field_keys=["speed"])
 
@@ -571,7 +571,7 @@ class Car:
         _requests = httpretty.httpretty.latest_requests
 
         self.assertEqual(1, len(_requests))
-        self.assertEqual("12V-BT,engine=12V-BT,type=sport-cars speed=125.25", _requests[0].parsed_body)
+        self.assertEqual("performance,engine=12V-BT,type=sport-cars speed=125.25", _requests[0].parsed_body)
 
 
 if __name__ == '__main__':

tests/test_point.py

@@ -472,6 +472,19 @@ def test_from_dictionary_tolerant_to_missing_tags_and_fields(self):
                                 record_field_keys=["pressure", "temperature"])
         self.assertEqual("sensor_pt859,location=warehouse_125 pressure=125i", point.to_line_protocol())
 
+    def test_static_measurement_name(self):
+        dictionary = {
+            "name": "sensor_pt859",
+            "location": "warehouse_125",
+            "pressure": 125
+        }
+        point = Point.from_dict(dictionary,
+                                write_precision=WritePrecision.S,
+                                record_measurement_name="custom_sensor_id",
+                                record_tag_keys=["location", "version"],
+                                record_field_keys=["pressure", "temperature"])
+        self.assertEqual("custom_sensor_id,location=warehouse_125 pressure=125i", point.to_line_protocol())
+
 
 if __name__ == '__main__':
     unittest.main()