Skip to content
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

Add gap_size option to dump/dumps #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add gap_size option to dump/dumps #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions tests/test_vdf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ def test_dump_params_invalid(self):
vdf.dump({'a': 1}, StringIO(), escaped=1)
with self.assertRaises(TypeError):
vdf.dumps({'a': 1}, escaped=1)
with self.assertRaises(TypeError):
vdf.dumps({'a': 1}, gap_size=0)

def test_routine_dumps_asserts(self):
for x in [5, 5.5, 1.0j, True, None, (), {}, lambda: 0, sys.stdin, self.f]:
Expand Down Expand Up @@ -523,6 +525,16 @@ def test_dumps_pretty_output(self):
for test, expected in tests:
self.assertEqual(vdf.dumps(test, pretty=True), expected)

def test_dumps_gap_size_output(self):
d = {'1': '1'}
tests = [
[ 1, '"1" "1"\n'],
[ 4, '"1" "1"\n'],
[ 8, '"1" "1"\n'],
]
for gap_size, expected in tests:
self.assertEqual(vdf.dumps(d, gap_size=gap_size), expected)

def test_parse_exceptions(self):
tests = [

Expand Down
19 changes: 12 additions & 7 deletions vdf/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ def load(fp, **kwargs):
return parse(fp, **kwargs)


def dumps(obj, pretty=False, escaped=True):
def dumps(obj, pretty=False, escaped=True, gap_size=1):
"""
Serialize ``obj`` to a VDF formatted ``str``.
"""
Expand All @@ -221,11 +221,13 @@ def dumps(obj, pretty=False, escaped=True):
raise TypeError("Expected pretty to be of type bool")
if not isinstance(escaped, bool):
raise TypeError("Expected escaped to be of type bool")
if gap_size < 1:
raise TypeError("Expected gap_size to be 1 or more")

return ''.join(_dump_gen(obj, pretty, escaped))
return ''.join(_dump_gen(obj, pretty, escaped, gap_size))


def dump(obj, fp, pretty=False, escaped=True):
def dump(obj, fp, pretty=False, escaped=True, gap_size=1):
"""
Serialize ``obj`` as a VDF formatted stream to ``fp`` (a
``.write()``-supporting file-like object).
Expand All @@ -238,14 +240,17 @@ def dump(obj, fp, pretty=False, escaped=True):
raise TypeError("Expected pretty to be of type bool")
if not isinstance(escaped, bool):
raise TypeError("Expected escaped to be of type bool")
if gap_size < 1:
raise TypeError("Expected gap_size to be 1 or more")

for chunk in _dump_gen(obj, pretty, escaped):
for chunk in _dump_gen(obj, pretty, escaped, gap_size):
fp.write(chunk)


def _dump_gen(data, pretty=False, escaped=True, level=0):
def _dump_gen(data, pretty=False, escaped=True, gap_size=1, level=0):
indent = "\t"
line_indent = ""
gap = " " * gap_size

if pretty:
line_indent = indent * level
Expand All @@ -256,14 +261,14 @@ def _dump_gen(data, pretty=False, escaped=True, level=0):

if isinstance(value, Mapping):
yield '%s"%s"\n%s{\n' % (line_indent, key, line_indent)
for chunk in _dump_gen(value, pretty, escaped, level+1):
for chunk in _dump_gen(value, pretty, escaped, gap_size, level+1):
yield chunk
yield "%s}\n" % line_indent
else:
if escaped and isinstance(value, string_type):
value = _escape(value)

yield '%s"%s" "%s"\n' % (line_indent, key, value)
yield '%s"%s"%s"%s"\n' % (line_indent, key, gap, value)


# binary VDF
Expand Down