Issue #21650: Add an `--sort-keys` option to json.tool CLI.
This commit is contained in:
parent
ffd842e1d6
commit
39e4c4d873
|
@ -567,6 +567,7 @@ the last name-value pair for a given name::
|
|||
The *object_pairs_hook* parameter can be used to alter this behavior.
|
||||
|
||||
.. highlight:: bash
|
||||
.. module:: json.tool
|
||||
|
||||
.. _json-commandline:
|
||||
|
||||
|
@ -586,6 +587,10 @@ specified, :attr:`sys.stdin` and :attr:`sys.stdout` will be used respectively::
|
|||
$ echo '{1.2:3.4}' | python -m json.tool
|
||||
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
|
||||
|
||||
.. versionchanged:: 3.5
|
||||
The output is now in the same order as the input. Use the
|
||||
:option:`--sort-keys` option to sort the output of dictionaries
|
||||
alphabetically by key.
|
||||
|
||||
Command line options
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
@ -613,6 +618,12 @@ Command line options
|
|||
Write the output of the *infile* to the given *outfile*. Otherwise, write it
|
||||
to :attr:`sys.stdout`.
|
||||
|
||||
.. cmdoption:: --sort-keys
|
||||
|
||||
Sort the output of dictionaries alphabetically by key.
|
||||
|
||||
.. versionadded:: 3.5
|
||||
|
||||
.. cmdoption:: -h, --help
|
||||
|
||||
Show the help message.
|
||||
|
|
|
@ -211,6 +211,14 @@ ipaddress
|
|||
network objects from existing addresses. (Contributed by Peter Moody
|
||||
and Antoine Pitrou in :issue:`16531`.)
|
||||
|
||||
json
|
||||
----
|
||||
|
||||
* The output of :mod:`json.tool` command line interface is now in the same
|
||||
order as the input. Use the :option:`--sort-keys` option to sort the output
|
||||
of dictionaries alphabetically by key. (Contributed by Berker Peksag in
|
||||
:issue:`21650`.)
|
||||
|
||||
os
|
||||
--
|
||||
|
||||
|
|
|
@ -11,6 +11,7 @@ Usage::
|
|||
|
||||
"""
|
||||
import argparse
|
||||
import collections
|
||||
import json
|
||||
import sys
|
||||
|
||||
|
@ -24,17 +25,24 @@ def main():
|
|||
help='a JSON file to be validated or pretty-printed')
|
||||
parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
|
||||
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')
|
||||
options = parser.parse_args()
|
||||
|
||||
infile = options.infile or sys.stdin
|
||||
outfile = options.outfile or sys.stdout
|
||||
sort_keys = options.sort_keys
|
||||
with infile:
|
||||
try:
|
||||
obj = json.load(infile)
|
||||
if sort_keys:
|
||||
obj = json.load(infile)
|
||||
else:
|
||||
obj = json.load(infile,
|
||||
object_pairs_hook=collections.OrderedDict)
|
||||
except ValueError as e:
|
||||
raise SystemExit(e)
|
||||
with outfile:
|
||||
json.dump(obj, outfile, sort_keys=True, indent=4)
|
||||
json.dump(obj, outfile, sort_keys=sort_keys, indent=4)
|
||||
outfile.write('\n')
|
||||
|
||||
|
||||
|
|
|
@ -6,6 +6,7 @@ import subprocess
|
|||
from test import support
|
||||
from test.script_helper import assert_python_ok
|
||||
|
||||
|
||||
class TestTool(unittest.TestCase):
|
||||
data = """
|
||||
|
||||
|
@ -15,7 +16,7 @@ class TestTool(unittest.TestCase):
|
|||
:"yes"} ]
|
||||
"""
|
||||
|
||||
expect = textwrap.dedent("""\
|
||||
expect_without_sort_keys = textwrap.dedent("""\
|
||||
[
|
||||
[
|
||||
"blorpie"
|
||||
|
@ -37,6 +38,28 @@ class TestTool(unittest.TestCase):
|
|||
]
|
||||
""")
|
||||
|
||||
expect = textwrap.dedent("""\
|
||||
[
|
||||
[
|
||||
"blorpie"
|
||||
],
|
||||
[
|
||||
"whoops"
|
||||
],
|
||||
[],
|
||||
"d-shtaeou",
|
||||
"d-nthiouh",
|
||||
"i-vhbjkhnth",
|
||||
{
|
||||
"nifty": 87
|
||||
},
|
||||
{
|
||||
"morefield": false,
|
||||
"field": "yes"
|
||||
}
|
||||
]
|
||||
""")
|
||||
|
||||
def test_stdin_stdout(self):
|
||||
with subprocess.Popen(
|
||||
(sys.executable, '-m', 'json.tool'),
|
||||
|
@ -75,3 +98,11 @@ class TestTool(unittest.TestCase):
|
|||
self.assertEqual(rc, 0)
|
||||
self.assertTrue(out.startswith(b'usage: '))
|
||||
self.assertEqual(err, b'')
|
||||
|
||||
def test_sort_keys_flag(self):
|
||||
infile = self._create_infile()
|
||||
rc, out, err = assert_python_ok('-m', 'json.tool', '--sort-keys', infile)
|
||||
self.assertEqual(rc, 0)
|
||||
self.assertEqual(out.splitlines(),
|
||||
self.expect_without_sort_keys.encode().splitlines())
|
||||
self.assertEqual(err, b'')
|
||||
|
|
Loading…
Reference in New Issue