Escape newline characters

Author: jteppinette

logfmter/formatter.py

@@ -38,12 +38,16 @@ def format_string(cls, value: str) -> str:
         """
         Process the provided string with any necessary quoting and/or escaping.
         """
-        needs_escaping = '"' in value
+        needs_dquote_escaping = '"' in value
+        needs_newline_escaping = "\n" in value
         needs_quoting = " " in value or "=" in value
 
-        if needs_escaping:
+        if needs_dquote_escaping:
             value = value.replace('"', '\\"')
 
+        if needs_newline_escaping:
+            value = value.replace("\n", "\\n")
+
         if needs_quoting:
             value = '"{}"'.format(value)
 

tests/test_formatter.py

@@ -19,6 +19,9 @@
         (' "', '" \\""'),
         # If the string is empty, then it should be quoted.
         ("", '""'),
+        # If the string contains a newline, then it should be escaped.
+        ("\n", "\\n"),
+        ("\n\n", "\\n\\n"),
     ],
 )
 def test_format_string(value, expected):