fix: serialization of \n, \r and \t to Line Protocol, = is valid sign for measurement name (influxdata#115)

bednar · web-flow · commit 8c167e9a4880 · 2020-06-30T16:49:21.000+02:00
* fix: serialization of `\n`, `\r` and `\t` to Line Protocol

* fix: `=` is valid sign for measurement name
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 
 ### Bug Fixes
 1. [#117](https://github.com/influxdata/influxdb-client-python/pull/117): Fixed appending default tags for single Point 
+1. [#115](https://github.com/influxdata/influxdb-client-python/pull/115): Fixed serialization of `\n`, `\r` and `\t` to Line Protocol, `=` is valid sign for measurement name 
 
 ## 1.8.0 [2020-06-19]
 
diff --git a/influxdb_client/client/write/point.py b/influxdb_client/client/write/point.py
@@ -12,7 +12,8 @@
 
 EPOCH = UTC.localize(datetime.utcfromtimestamp(0))
 DEFAULT_WRITE_PRECISION = WritePrecision.NS
-_ESCAPE_KEY = str.maketrans({'\\': '\\\\', ',': r'\,', ' ': r'\ ', '=': r'\=', '\n': ''})
+_ESCAPE_MEASUREMENT = str.maketrans({'\\': '\\\\', ',': r'\,', ' ': r'\ ', '\n': '\\n', '\t': '\\t', '\r': '\\r'})
+_ESCAPE_KEY = str.maketrans({'\\': '\\\\', ',': r'\,', ' ': r'\ ', '=': r'\=', '\n': '\\n', '\t': '\\t', '\r': '\\r'})
 _ESCAPE_STRING = str.maketrans({'\"': r"\"", "\\": r"\\"})
 
 
@@ -76,7 +77,7 @@ def field(self, field, value):
         return self
 
     def to_line_protocol(self):
-        _measurement = _escape_key(self._name)
+        _measurement = _escape_key(self._name, _ESCAPE_MEASUREMENT)
         _tags = _append_tags(self._tags)
         _fields = _append_fields(self._fields)
         if not _fields:
@@ -134,8 +135,10 @@ def _append_time(time, write_precision):
     return f" {int(_convert_timestamp(time, write_precision))}"
 
 
-def _escape_key(tag):
-    return str(tag).translate(_ESCAPE_KEY)
+def _escape_key(tag, escape_list=None):
+    if escape_list is None:
+        escape_list = _ESCAPE_KEY
+    return str(tag).translate(escape_list)
 
 
 def _escape_tag_value(value):
diff --git a/tests/test_point.py b/tests/test_point.py
@@ -36,6 +36,24 @@ def test_TagEmptyValue(self):
 
         self.assertEqual("h2o,location=europe level=2i", point.to_line_protocol())
 
+    def test_TagEscapingKeyAndValue(self):
+
+        point = Point.measurement("h\n2\ro\t_data") \
+            .tag("new\nline", "new\nline") \
+            .tag("carriage\rreturn", "carriage\nreturn") \
+            .tag("t\tab", "t\tab") \
+            .field("level", 2)
+
+        self.assertEqual("h\\n2\\ro\\t_data,carriage\\rreturn=carriage\\nreturn,new\\nline=new\\nline,t\\tab=t\\tab level=2i", point.to_line_protocol())
+
+    def test_EqualSignEscaping(self):
+
+        point = Point.measurement("h=2o") \
+            .tag("l=ocation", "e=urope") \
+            .field("l=evel", 2)
+
+        self.assertEqual("h=2o,l\\=ocation=e\\=urope l\\=evel=2i", point.to_line_protocol())
+
     def test_OverrideTagField(self):
         point = Point.measurement("h2o") \
             .tag("location", "europe") \
