Skip to content

gh-90087: extend json.tool --json-lines to ignore empty rows #29858

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
ZeeD wants to merge 9 commits into
base: main
Choose a base branch
from
Open

gh-90087: extend json.tool --json-lines to ignore empty rows #29858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
147f4ee
ignore empty lines for json_lines files
ZeeD Nov 29, 2021
b8401b7
add test_jsonlines_emptylines
ZeeD Nov 29, 2021
1538452
add test_jsonlines_emptylines
ZeeD Nov 29, 2021
59dd6ae
fix typo
ZeeD Nov 30, 2021
dac0309
Merge branch 'python:main' into master
ZeeD Nov 30, 2021
fde59f3
📜🤖 Added by blurb_it.
blurb-it[bot] Nov 30, 2021
b022195
Merge branch 'python:main' into master
ZeeD Mar 5, 2022
e9238d1
add newline at end of file
ZeeD Mar 5, 2022
c8ebbd8
Merge branch 'python:main' into master
ZeeD Mar 13, 2023
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
6 changes: 4 additions & 2 deletions Lib/json/tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import sys
from pathlib import Path

_SENTINEL = object()
Comment thread
ZeeD marked this conversation as resolved.

def main():
prog = 'python -m json.tool'
Expand Down Expand Up @@ -62,7 +63,7 @@ def main():
with options.infile as infile:
try:
if options.json_lines:
objs = (json.loads(line) for line in infile)
objs = (json.loads(line) if line.strip() else _SENTINEL for line in infile)
else:
objs = (json.load(infile),)

Expand All @@ -72,7 +73,8 @@ def main():
out = options.outfile.open('w', encoding='utf-8')
with out as outfile:
for obj in objs:
json.dump(obj, outfile, **dump_args)
if obj is not _SENTINEL:
json.dump(obj, outfile, **dump_args)
outfile.write('\n')
except ValueError as e:
raise SystemExit(e)
Expand Down
24 changes: 24 additions & 0 deletions Lib/test/test_json/test_tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,24 @@ class TestTool(unittest.TestCase):
}
""")

jsonlines_emptylines_raw = textwrap.dedent("""\
{"foo":1}

{"bar":2}

""")

jsonlines_emptylines_expect = textwrap.dedent("""\
{
"foo": 1
}

{
"bar": 2
}

""")

def test_stdin_stdout(self):
args = sys.executable, '-m', 'json.tool'
process = subprocess.run(args, input=self.data, capture_output=True, text=True, check=True)
Expand Down Expand Up @@ -147,6 +165,12 @@ def test_jsonlines(self):
self.assertEqual(process.stdout, self.jsonlines_expect)
self.assertEqual(process.stderr, '')

def test_jsonlines_emptylines(self):
args = sys.executable, '-m', 'json.tool', '--json-lines'
process = subprocess.run(args, input=self.jsonlines_emptylines_raw, capture_output=True, text=True, check=True)
self.assertEqual(process.stdout, self.jsonlines_emptylines_expect)
self.assertEqual(process.stderr, '')

def test_help_flag(self):
rc, out, err = assert_python_ok('-m', 'json.tool', '-h')
self.assertEqual(rc, 0)
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2021-11-30-07-15-32.bpo-45929.EeKtTK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Let json.tool --json-lines handle empty rows