Merge pull request #27 from ctomkow/cli

ctomkow · web-flow · commit 689a8b4ed8c7 · 2022-11-11T21:31:44.000-08:00
Cli
diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,5 @@ dist
 docs/_build
 docs/_static
 docs/_templates
-docs/make.bat
+docs/make.bat
+test.json
diff --git a/jsonparse/VERSION b/jsonparse/VERSION
@@ -1 +1 @@
-0.11.3
+0.12.0.dev1
diff --git a/jsonparse/cli.py b/jsonparse/cli.py
@@ -0,0 +1,126 @@
+#!/usr/bin/env python3
+# Craig Tomkow
+# 2022-10-03
+
+# local imports
+from .parser import Parser
+
+# python imports
+from typing import Any
+import sys
+import argparse
+import io
+import os
+import json
+
+
+def entrypoint():
+
+    version = _read_version()
+    parser = _flags(version)
+    args = parser.parse_args()
+    _parse_input(args)
+
+
+def _read_version() -> str:
+
+    # read from the VERSION file
+    with open(os.path.join(os.path.dirname(__file__), 'VERSION')) as version_file:
+        version = version_file.read().strip()
+    return version
+
+
+def _flags(version: str) -> argparse.ArgumentParser:
+
+    parser = argparse.ArgumentParser(
+        prog='jsonparse',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        description="""
+Parse deeply nested json based on key(s) and value(s)
+
+examples
+
+jsonparse key-chain my key chain --file test.json
+
+jsonparse key-value mykey 42 --file test.json
+jsonparse key-value mykey \"strValue\" --file test.json
+
+echo '{"mykey": 42}' | jsonparse key mykey
+""")
+
+    # all flags here
+    parser.add_argument('-v', '--version', action='version', version=f"%(prog)s {version}")
+
+    sub_parser = parser.add_subparsers()
+
+    key = sub_parser.add_parser('key', description='With no FILE, read standard input.')
+    key.add_argument('KEY', action='store', type=str, nargs=1, help='search for key')
+    key.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin, help="json file as input")
+
+    keys = sub_parser.add_parser('keys', description='With no FILE, read standard input.')
+    keys.add_argument('--ungroup', action='store_false', help='return a one dimensional list')
+    keys.add_argument('KEYS', metavar='KEY', action='store', type=str, nargs='+', help='search for keys')
+    keys.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin, help="json file as input")
+
+    key_chain = sub_parser.add_parser('key-chain', description='With no FILE, read standard input.')
+    key_chain.add_argument('KEYCHAIN', metavar='KEY', action='store', type=str, nargs='+', help='search for key chain')
+    key_chain.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin,
+                           help="json file as input")
+
+    key_value = sub_parser.add_parser('key-value', description='With no FILE, read standard input.')
+    key_value.add_argument('KVKEY', metavar='KEY', action='store', type=str, nargs=1, help='search key part of key:value')
+    key_value.add_argument('KVVALUE', metavar='VALUE', action='store', type=str, nargs=1,
+                           help='must be valid json. String must have escaped double quotes. e.g. \\"asdf\\"')
+    key_value.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin,
+                           help="json file as input")
+
+    return parser
+
+
+def _parse_input(args: argparse.Namespace) -> None:
+
+    try:
+        data = _pythonify(_input(args.file))
+    except json.decoder.JSONDecodeError:
+        print('input json not valid.')
+        raise SystemExit(0)
+
+    if 'KEY' in args:
+        print(_jsonify(Parser().find_key(data, args.KEY[0])))
+    elif 'KEYS' in args:
+        print(_jsonify(Parser().find_keys(data, args.KEYS, group=args.ungroup)))
+    elif 'KEYCHAIN' in args:
+        print(_jsonify(Parser().find_key_chain(data, args.KEYCHAIN)))
+    elif ('KVKEY' in args) and ('KVVALUE' in args):
+        try:
+            value = _pythonify(args.KVVALUE[0])
+        except json.decoder.JSONDecodeError:
+            print('value is not valid json. example valid types: \\"value\\", 5, false, true, null')
+            raise SystemExit(0)
+        print(_jsonify(Parser().find_key_value(data, args.KVKEY[0], value)))
+
+
+def _input(fp: io.TextIOWrapper) -> str:
+
+    data = ''
+    for line in fp:
+        data += line.rstrip()
+    return data
+
+
+def _pythonify(data: json) -> Any:
+
+    try:
+        return json.loads(data)
+    except json.decoder.JSONDecodeError:
+        raise
+
+
+def _jsonify(data: Any) -> json:
+
+    return json.dumps(data)
+
+
+if __name__ == "__main__":
+
+    entrypoint()
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 128
diff --git a/setup.py b/setup.py
@@ -46,6 +46,11 @@
                         'gunicorn>=20.1.0,<21.0.0'
                     ]
         },
+        entry_points={
+            'console_scripts': [
+                'jsonparse=jsonparse.cli:entrypoint',
+            ],
+        },
         packages=find_namespace_packages(where="."),
         package_dir={"": "."},
         package_data={
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -0,0 +1,68 @@
+# Craig Tomkow
+#
+# Tests only public methods
+
+
+# local imports
+from jsonparse import cli
+
+# python imports
+import os
+
+# 3rd part imports
+import pytest
+
+
+class TestCli:
+
+    # set working dir to tests directory to read from json file
+    os.chdir(os.path.dirname(os.path.realpath(__file__)))
+
+    @pytest.fixture
+    def version(self):
+
+        return '0.12.0.dev1'
+
+    def test_read_version(self, version):
+
+        assert cli._read_version() == version
+
+    def test_flags_key(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['key', 'ppu', '--file', 'tests.json'])
+        args = cli._parse_input(args)
+
+        assert True
+
+    def test_flags_keys(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['keys', 'ppu', '--file', 'tests.json'])
+        args = cli._parse_input(args)
+
+        assert True
+
+    def test_flags_keychain(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['key-chain', 'ppu', '--file', 'tests.json'])
+        args = cli._parse_input(args)
+
+        assert True
+
+    def test_flags_keyvalue(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['key-value', 'ppu', '0.55', '--file', 'tests.json'])
+        args = cli._parse_input(args)
+
+        assert True
+
+    def test_flags_keyvalue_invalid_json_input(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['key-value', 'exists', 'False', '--file', 'tests.json'])
+
+        with pytest.raises(SystemExit):
+            args = cli._parse_input(args)
diff --git a/tests/tests.json b/tests/tests.json
@@ -0,0 +1,77 @@
+[
+    {
+        "id": "0001",
+        "type": "donut",
+        "exists": true,
+        "ppu": 0.55,
+        "batters":
+            {
+                "batter":
+                    [
+                        {"id": "1001", "type": "Reg"},
+                        {"id": "1002", "type": "Chocolate"},
+                        {"id": "1003", "type": "Blueberry"},
+                        {"id": "1004", "type": "Devil's Food"},
+                        {"start": 5, "end": 8}
+                    ]
+            },
+        "topping":
+            [
+                {"id": "5001", "type": "None"},
+                {"id": "5002", "type": "Glazed"},
+                {"id": "5003", "type": "Sugar"},
+                {"id": "5004", "type": "Powdered Sugar"},
+                {"id": "5005", "type": "Chocolate with Sprinkles"},
+                {"id": "5006", "type": "Chocolate"},
+                {"id": "5007", "type": "Maple"}
+            ],
+        "start": 22,
+        "end": 99
+    },
+    {
+        "id": "0002",
+        "type": "donut",
+        "exists": false,
+        "ppu": 42,
+        "batters":
+            {
+                "batter":
+                    [
+                        {"id": "1001", "type": "Rul"}
+                    ]
+            },
+        "top_stuff":
+            [
+                {"id": "5001", "type": "None"},
+                {"id": "5002", "type": "Glazed"},
+                {"id": "5003", "type": "Sugar"},
+                {"id": "5004", "type": "Chocolate"},
+                {"id": "5005", "type": "Maple"}
+            ],
+        "start": 1,
+        "end": 9
+    },
+    {
+        "id": "0003",
+        "type": "donut",
+        "exists": null,
+        "ppu": 7,
+        "batters":
+            {
+                "batter":
+                    [
+                        {"id": "1001", "type": "Lar"},
+                        {"id": "1002", "type": "Chocolate"}
+                    ]
+            },
+        "on_top_thing":
+            [
+                {"id": "5001", "type": "None"},
+                {"id": "5002", "type": "Glazed"},
+                {"id": "5003", "type": "Chocolate"},
+                {"id": "5004", "type": "Maple"}
+            ],
+        "start": 4,
+        "end": 7
+    }
+]
