Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 1 | r"""Command-line tool to validate and pretty-print JSON |
| 2 | |
| 3 | Usage:: |
| 4 | |
Benjamin Peterson | c6b607d | 2009-05-02 12:36:44 +0000 | [diff] [blame] | 5 | $ echo '{"json":"obj"}' | python -m json.tool |
Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 6 | { |
| 7 | "json": "obj" |
| 8 | } |
Benjamin Peterson | c6b607d | 2009-05-02 12:36:44 +0000 | [diff] [blame] | 9 | $ echo '{ 1.2:3.4}' | python -m json.tool |
Serhiy Storchaka | c510a04 | 2013-02-21 20:19:16 +0200 | [diff] [blame] | 10 | Expecting property name enclosed in double quotes: line 1 column 3 (char 2) |
Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 11 | |
| 12 | """ |
Benjamin Peterson | 940e207 | 2014-03-21 23:17:29 -0500 | [diff] [blame] | 13 | import argparse |
Berker Peksag | 39e4c4d | 2014-11-10 09:56:54 +0200 | [diff] [blame] | 14 | import collections |
Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 15 | import json |
Benjamin Peterson | 940e207 | 2014-03-21 23:17:29 -0500 | [diff] [blame] | 16 | import sys |
| 17 | |
Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 18 | |
| 19 | def main(): |
Benjamin Peterson | 940e207 | 2014-03-21 23:17:29 -0500 | [diff] [blame] | 20 | prog = 'python -m json.tool' |
| 21 | description = ('A simple command line interface for json module ' |
| 22 | 'to validate and pretty-print JSON objects.') |
| 23 | parser = argparse.ArgumentParser(prog=prog, description=description) |
| 24 | parser.add_argument('infile', nargs='?', type=argparse.FileType(), |
| 25 | help='a JSON file to be validated or pretty-printed') |
| 26 | parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'), |
| 27 | help='write the output of infile to outfile') |
Berker Peksag | 39e4c4d | 2014-11-10 09:56:54 +0200 | [diff] [blame] | 28 | parser.add_argument('--sort-keys', action='store_true', default=False, |
| 29 | help='sort the output of dictionaries alphabetically by key') |
Benjamin Peterson | 940e207 | 2014-03-21 23:17:29 -0500 | [diff] [blame] | 30 | options = parser.parse_args() |
| 31 | |
| 32 | infile = options.infile or sys.stdin |
| 33 | outfile = options.outfile or sys.stdout |
Berker Peksag | 39e4c4d | 2014-11-10 09:56:54 +0200 | [diff] [blame] | 34 | sort_keys = options.sort_keys |
Ezio Melotti | 057bcb4 | 2012-11-29 02:15:18 +0200 | [diff] [blame] | 35 | with infile: |
| 36 | try: |
Berker Peksag | 39e4c4d | 2014-11-10 09:56:54 +0200 | [diff] [blame] | 37 | if sort_keys: |
| 38 | obj = json.load(infile) |
| 39 | else: |
| 40 | obj = json.load(infile, |
| 41 | object_pairs_hook=collections.OrderedDict) |
Ezio Melotti | 057bcb4 | 2012-11-29 02:15:18 +0200 | [diff] [blame] | 42 | except ValueError as e: |
| 43 | raise SystemExit(e) |
| 44 | with outfile: |
Berker Peksag | 39e4c4d | 2014-11-10 09:56:54 +0200 | [diff] [blame] | 45 | json.dump(obj, outfile, sort_keys=sort_keys, indent=4) |
Ezio Melotti | 057bcb4 | 2012-11-29 02:15:18 +0200 | [diff] [blame] | 46 | outfile.write('\n') |
Christian Heimes | 9054000 | 2008-05-08 14:29:10 +0000 | [diff] [blame] | 47 | |
| 48 | |
| 49 | if __name__ == '__main__': |
| 50 | main() |