1. show overview

2. fix bugs

Author: seamile

jsonfmt.py

@@ -69,25 +69,21 @@ def parse_to_pyobj(text: str, jpath: Optional[str]) -> tuple[Any, str]:
             return subelements, fmt
 
 
-def output(output_fp: IO, text: str, fmt: str, cp2clip: bool):
-    # copy the result to clipboard
-    if cp2clip:
-        pyperclip.copy(text)
-        print_inf('result copied to clipboard.')
-        return
-    elif stdout.isatty():
-        # highlight the text when output to TTY divice
-        Lexer = {'json': JsonLexer, 'toml': TOMLLexer, 'yaml': YamlLexer}[fmt]
-        colored_text = highlight(text, Lexer(), TerminalFormatter())
-        win_w, win_h = get_terminal_size()
-        # use pager when line-hight > screen hight or
-        if text.count('\n') >= win_h or len(text) > win_w * (win_h - 1):
-            with patch("sys.stdin.isatty", lambda *_: True):
-                pager(colored_text)
+def get_overview(py_obj: Any):
+    def clip_value(value: Any):
+        if isinstance(value, str):
+            return '...'
+        elif isinstance(value, (list, tuple)):
+            return []
+        elif isinstance(value, dict):
+            return {k: clip_value(v) for k, v in value.items()}
         else:
-            output_fp.write(colored_text)
+            return value
+
+    if isinstance(py_obj, list):
+        return [clip_value(py_obj[0])]
     else:
-        output_fp.write(text)
+        return clip_value(py_obj)
 
 
 def format_to_text(py_obj: Any, fmt: str, *,
@@ -104,36 +100,62 @@ def format_to_text(py_obj: Any, fmt: str, *,
     elif fmt == 'toml':
         if not isinstance(py_obj, dict):
             msg = 'the pyobj must be a Mapping when format to toml'
-            print_err(msg)
             raise ParseError(msg)
         return toml.dumps(py_obj)
 
-    elif fmt == 'toml':
+    elif fmt == 'yaml':
         return yaml.safe_dump(py_obj, allow_unicode=not escape, indent=indent,
                               sort_keys=sort_keys)
 
     else:
         raise ParseError('Unknow format')
 
 
-def process(input_fp: IO, jpath: Optional[str], *,
-            overwrite: bool, cp2clip: bool, compact: bool,
-            escape: bool, indent: int, sort_keys: bool):
+def output(output_fp: IO, text: str, fmt: str, cp2clip: bool):
+    # copy the result to clipboard
+    if cp2clip:
+        pyperclip.copy(text)
+        print_inf('result copied to clipboard.')
+        return
+    elif stdout.isatty():
+        # highlight the text when output to TTY divice
+        Lexer = {'json': JsonLexer, 'toml': TOMLLexer, 'yaml': YamlLexer}[fmt]
+        colored_text = highlight(text, Lexer(), TerminalFormatter())
+        win_w, win_h = get_terminal_size()
+        # use pager when line-hight > screen hight or
+        if text.count('\n') >= win_h or len(text) > win_w * (win_h - 1):
+            with patch("sys.stdin.isatty", lambda *_: True):
+                pager(colored_text)
+        else:
+            output_fp.write(colored_text)
+    else:
+        output_fp.seek(0)
+        output_fp.truncate()
+        output_fp.write(text)
+
+
+def process(input_fp: IO, jpath: Optional[str], to_format: Optional[str], *,
+            compact: bool, cp2clip: bool, escape: bool, indent: int,
+            overview: bool, overwrite: bool, sort_keys: bool):
     # parse and format
     input_text = input_fp.read()
     py_obj, fmt = parse_to_pyobj(input_text, jpath)
-    formated_text = format_to_text(py_obj, fmt,
+
+    if overview:
+        py_obj = get_overview(py_obj)
+
+    to_format = to_format or fmt
+    formated_text = format_to_text(py_obj, to_format,
                                    compact=compact, escape=escape,
                                    indent=indent, sort_keys=sort_keys)
 
+    # output the result
     if input_fp.name == '<stdin>' or not overwrite:
         output_fp = stdout
     else:
         # truncate file to zero length before overwrite
-        input_fp.seek(0)
-        input_fp.truncate()
         output_fp = input_fp
-    output(output_fp, formated_text, fmt, cp2clip)
+    output(output_fp, formated_text, to_format, cp2clip)
 
 
 def parse_cmdline_args(args: Optional[Sequence[str]] = None):
@@ -144,11 +166,12 @@ def parse_cmdline_args(args: Optional[Sequence[str]] = None):
                         help='copy the result to clipboard')
     parser.add_argument('-e', dest='escape', action='store_true',
                         help='escape non-ASCII characters')
-    parser.add_argument('-f', dest='format', default='json',
-                        choices=['json', 'toml', 'yaml'],
+    parser.add_argument('-f', dest='format', choices=['json', 'toml', 'yaml'],
                         help='the format to output ''(default: %(default)s)')
     parser.add_argument('-i', dest='indent', type=int, default=2,
                         help='number of spaces for indentation (default: %(default)s)')
+    parser.add_argument('-o', dest='overview', action='store_true',
+                        help='show data structure overview')
     parser.add_argument('-O', dest='overwrite', action='store_true',
                         help='overwrite the formated text to original file')
     parser.add_argument('-p', dest='jsonpath', type=str,
@@ -176,10 +199,16 @@ def main():
         try:
             # read from file
             input_fp = open(file, 'r+') if isinstance(file, str) else file
-            process(input_fp, args.jsonpath,
-                    overwrite=args.overwrite, cp2clip=cp2clip,
-                    compact=args.compact, escape=args.escape,
-                    indent=args.indent, sort_keys=args.sort_keys)
+            process(input_fp,
+                    args.jsonpath,
+                    args.format,
+                    compact=args.compact,
+                    cp2clip=cp2clip,
+                    escape=args.escape,
+                    indent=args.indent,
+                    overview=args.overview,
+                    overwrite=args.overwrite,
+                    sort_keys=args.sort_keys)
         except ParseError as err:
             print_err(err)
         except FileNotFoundError: