| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  | r"""Command-line tool to validate and pretty-print JSON
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Usage:: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2009-05-02 12:36:44 +00:00
										 |  |  |     $ echo '{"json":"obj"}' | python -m json.tool | 
					
						
							| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  |     { | 
					
						
							|  |  |  |         "json": "obj" | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2009-05-02 12:36:44 +00:00
										 |  |  |     $ echo '{ 1.2:3.4}' | python -m json.tool | 
					
						
							| 
									
										
										
										
											2013-02-21 20:19:16 +02:00
										 |  |  |     Expecting property name enclosed in double quotes: line 1 column 3 (char 2) | 
					
						
							| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | """
 | 
					
						
							| 
									
										
										
										
											2014-03-21 23:17:29 -05:00
										 |  |  | import argparse | 
					
						
							| 
									
										
										
										
											2014-11-10 09:56:54 +02:00
										 |  |  | import collections | 
					
						
							| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  | import json | 
					
						
							| 
									
										
										
										
											2014-03-21 23:17:29 -05:00
										 |  |  | import sys | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | def main(): | 
					
						
							| 
									
										
										
										
											2014-03-21 23:17:29 -05:00
										 |  |  |     prog = 'python -m json.tool' | 
					
						
							|  |  |  |     description = ('A simple command line interface for json module ' | 
					
						
							|  |  |  |                    'to validate and pretty-print JSON objects.') | 
					
						
							|  |  |  |     parser = argparse.ArgumentParser(prog=prog, description=description) | 
					
						
							|  |  |  |     parser.add_argument('infile', nargs='?', type=argparse.FileType(), | 
					
						
							|  |  |  |                         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') | 
					
						
							| 
									
										
										
										
											2014-11-10 09:56:54 +02:00
										 |  |  |     parser.add_argument('--sort-keys', action='store_true', default=False, | 
					
						
							|  |  |  |                         help='sort the output of dictionaries alphabetically by key') | 
					
						
							| 
									
										
										
										
											2014-03-21 23:17:29 -05:00
										 |  |  |     options = parser.parse_args() | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     infile = options.infile or sys.stdin | 
					
						
							|  |  |  |     outfile = options.outfile or sys.stdout | 
					
						
							| 
									
										
										
										
											2014-11-10 09:56:54 +02:00
										 |  |  |     sort_keys = options.sort_keys | 
					
						
							| 
									
										
										
										
											2012-11-29 02:15:18 +02:00
										 |  |  |     with infile: | 
					
						
							|  |  |  |         try: | 
					
						
							| 
									
										
										
										
											2014-11-10 09:56:54 +02:00
										 |  |  |             if sort_keys: | 
					
						
							|  |  |  |                 obj = json.load(infile) | 
					
						
							|  |  |  |             else: | 
					
						
							|  |  |  |                 obj = json.load(infile, | 
					
						
							|  |  |  |                                 object_pairs_hook=collections.OrderedDict) | 
					
						
							| 
									
										
										
										
											2012-11-29 02:15:18 +02:00
										 |  |  |         except ValueError as e: | 
					
						
							|  |  |  |             raise SystemExit(e) | 
					
						
							|  |  |  |     with outfile: | 
					
						
							| 
									
										
										
										
											2014-11-10 09:56:54 +02:00
										 |  |  |         json.dump(obj, outfile, sort_keys=sort_keys, indent=4) | 
					
						
							| 
									
										
										
										
											2012-11-29 02:15:18 +02:00
										 |  |  |         outfile.write('\n') | 
					
						
							| 
									
										
										
										
											2008-05-08 14:29:10 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | if __name__ == '__main__': | 
					
						
							|  |  |  |     main() |