Skip to content

Fix quoting of strings #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chdsbd wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix quoting of strings #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
19c627b
Fix string quoting to match other implementations
chdsbd Jan 5, 2019
562c408
fix
chdsbd Jan 5, 2019
051c352
fmt
chdsbd Jan 5, 2019
db8ff56
Reduce diff
chdsbd Jan 5, 2019
9a7cc48
Add failing test for empty string
chdsbd Jan 6, 2019
8ea311d
Fix test
chdsbd Jan 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion logfmt/formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,14 @@ def format_line(extra):
else:
if isinstance(v, (dict, object)):
v = str(v)
v = '"%s"' % v.replace('"', '\\"')
needs_quoting = ' ' in v or '=' in v
needs_escaping = '"' in v
if needs_escaping:
v = '%s' % v.replace('"', '\\"')
if needs_quoting:
v = '"%s"' % v
if v == "":
v = '""'
outarr.append("%s=%s" % (k, v))
return " ".join(outarr)

Expand Down
18 changes: 17 additions & 1 deletion tests/test_formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ class FormatterTestCase(TestCase):
def test_empty_log_line(self):
data = format_line({})
self.assertEqual(data, "")

def test_empty_string(self):
data = format_line({'key':''})
self.assertEqual(data, 'key=""')

def test_key_without_value(self):
data = format_line( OrderedDict([("key1", None), ("key2", None)]) )
Expand Down Expand Up @@ -38,7 +42,7 @@ def test_custom_float_format(self):
("key2", "%.7f" % -234234234.2342342)
]))

self.assertEqual(data, "key1=342.23424 key2=\"-234234234.2342342\"")
self.assertEqual(data, "key1=342.23424 key2=-234234234.2342342")

def test_string_value(self):
data = format_line( OrderedDict([
Expand All @@ -48,6 +52,18 @@ def test_string_value(self):
]))

self.assertEqual(data, '''key1="some random !@#$%^\\"&**_+-={}\\|;\':,./<>?)" key2="here\'s a line with\nmore stuff on the next"''')

def test_kr_logfmt(self):
"""
Test using canonical example from https://github.com/kr/logfmt/blob/b84e30acd515aadc4b783ad4ff83aff3299bdfe0/example_test.go#L45
"""
data = format_line(OrderedDict([
("measure.a", "1ms"),
("measure.b", 10),
("measure.c", "100MB"),
("measure.d", "1s"),
]))
self.assertEqual(data, "measure.a=1ms measure.b=10 measure.c=100MB measure.d=1s")