Skip to content

bpo-31553: Add --jsonlines option to json.tool. #3846

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

Closed
jeffreyrack wants to merge 10 commits into from
Closed

bpo-31553: Add --jsonlines option to json.tool. #3846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
99a3c89
Adding the hide_console param to Popen for Windows
jeffreyrack Aug 7, 2017
4ac37f6
Reverting changes to wininst-14.0-amd64.exe
jeffreyrack Aug 7, 2017
c8c5c50
Merge branch 'master' of https://github.com/python/cpython
jeffreyrack Sep 30, 2017
e9808f0
Revert "Adding the hide_console param to Popen for Windows"
jeffreyrack Sep 30, 2017
3720c65
Revert "Reverting changes to wininst-14.0-amd64.exe"
jeffreyrack Sep 30, 2017
4cd2378
Adding the --jsonfiles option to json.tool
jeffreyrack Oct 1, 2017
aadf4b6
Revert "Revert "Reverting changes to wininst-14.0-amd64.exe""
jeffreyrack Oct 1, 2017
72c0f02
Fixing whitespace issues in tool.py and test_tool.py
jeffreyrack Oct 1, 2017
ca00950
Adding news file for --jsonlines addition to json.tools
jeffreyrack Oct 1, 2017
b9a162b
Update wording for --jsonlines help message.
jeffreyrack Oct 4, 2017
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
46 changes: 35 additions & 11 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,25 @@
import json
import sys

def parse_json_from_filehandle(infile, sort_keys):
Copy link
Copy Markdown
Contributor

@lisroach lisroach Oct 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These functions are a bit repetitive and add a lot of unnecessary lines of code. I think they could be avoided by keeping the functionality in the original location. The code could become more like:

sort_keys = options.sort_keys
jsonlines = options.jsonlines
with infile:
    if jsonlines:
        if sort_keys:
            objs = [json.loads(line) for line in infile]
        else:
           ...
    else:
        if sort_keys:
            objs = [json.load(infile)]
        else:
            ...

This keeps the code more concise.

try:
if sort_keys:
return json.load(infile)
else:
return json.load(infile,
object_pairs_hook=collections.OrderedDict)
except ValueError as e:
raise SystemExit(e)

def parse_json_from_string(input, sort_keys):
try:
if sort_keys:
return json.loads(input)
else:
return json.loads(input,
object_pairs_hook=collections.OrderedDict)
except ValueError as e:
raise SystemExit(e)

def main():
prog = 'python -m json.tool'
Expand All @@ -27,23 +46,28 @@ def main():
help='write the output of infile to outfile')
parser.add_argument('--sort-keys', action='store_true', default=False,
help='sort the output of dictionaries alphabetically by key')
parser.add_argument('--jsonlines', action='store_true', default=False,
help='parse input using the jsonlines format')
options = parser.parse_args()

infile = options.infile or sys.stdin
outfile = options.outfile or sys.stdout
sort_keys = options.sort_keys
with infile:
try:
if sort_keys:
obj = json.load(infile)
else:
obj = json.load(infile,
object_pairs_hook=collections.OrderedDict)
except ValueError as e:
raise SystemExit(e)
jsonlines = options.jsonlines
objs = []

if jsonlines:
with infile:
for line in infile:
objs.append(parse_json_from_string(line, sort_keys))
else:
with infile:
objs = [parse_json_from_filehandle(infile, sort_keys)]

with outfile:
json.dump(obj, outfile, sort_keys=sort_keys, indent=4)
outfile.write('\n')
for obj in objs:
json.dump(obj, outfile, sort_keys=sort_keys, indent=4)
outfile.write('\n')


if __name__ == '__main__':
Expand Down
28 changes: 28 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 @@ -60,6 +60,27 @@ class TestTool(unittest.TestCase):
]
""")

jsonlines_data = """\
{"ingredients":["frog", "water", "chocolate", "glucose"]}
{"ingredients":["chocolate","steel bolts"]}\
"""

jsonlines_expect = textwrap.dedent("""\
{
"ingredients": [
"frog",
"water",
"chocolate",
"glucose"
]
}
{
"ingredients": [
"chocolate",
"steel bolts"
]
}""")

def test_stdin_stdout(self):
args = sys.executable, '-m', 'json.tool'
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE) as proc:
Expand Down Expand Up @@ -92,6 +113,13 @@ def test_infile_outfile(self):
self.assertEqual(out, b'')
self.assertEqual(err, b'')

def test_jsonlines(self):
args = sys.executable, '-m', 'json.tool', '--jsonlines'
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE) as proc:
out, err = proc.communicate(self.jsonlines_data.encode())
self.assertEqual(out.splitlines(), self.jsonlines_expect.encode().splitlines())
self.assertEqual(err, b'')

def test_help_flag(self):
rc, out, err = assert_python_ok('-m', 'json.tool', '-h')
self.assertEqual(rc, 0)
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2017-10-01-09-15-12.bpo-31553.0EubUh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add the --jsonlines option to json.tool in order to be able to parse input
sent using the jsonlines format.