Merge pull request #33 from ctomkow/find_value

Find value

Author: ctomkow

README.md

@@ -9,8 +9,8 @@
 > **jsonparse** is a simple JSON parsing library. Extract what's needed from key:value pairs.
 
 ## What's New
+ - A new function, [find_value](#find_value), has been added. This function will return all keys of the matched value. :grinning:
  - [CLI tool](#CLI-tool). Parse json text files or stdin via the command line :tada:
- - New public (or hostable) [web API](#web-api)
 
 # Python Library
 
@@ -23,7 +23,7 @@ pip install jsonparse
 Here is a quick example of what jsonparse is able to do.
 
 ```python
-from jsonparse import find_key, find_keys, find_key_chain, find_key_value
+from jsonparse import find_key, find_keys, find_key_chain, find_key_value, find_value
 
 data = [{
     "key0":
@@ -69,6 +69,12 @@ Note, `jsonparse` and `jp` are equivalent.
 
 `echo '{"key1": {"key2": 5}}' | jp key key2`
 
+`jp value null --file text.json`
+
+`jp value 42 --file text.json`
+
+`jp value '"strValue"' --file text.json`
+
 
 # API
 
@@ -77,6 +83,7 @@ Note, `jsonparse` and `jp` are equivalent.
     - [find_keys](#find_keys)
     - [find_key_chain](#find_key_chain)
     - [find_key_value](#find_key_value)
+    - [find_value](#find_value)
 
 The API examples using the following test data.
 
@@ -200,6 +207,22 @@ p.find_key_value(data, 'chain', 'B')
 [{'chain': 'B', 'rope': 7, 'string': 0.7, 'cable': True}]
 ```
 
+---
+
+### find_value
+<pre>
+<b>find_value(</b><i>data</i>: dict | list, <i>value</i>: str | int | float | bool | None<b>)</b> -> list
+</pre>
+
+&nbsp;&nbsp;&nbsp;&nbsp;Will return all keys of the matched value.
+
+```python
+p.find_value(data, 'A')
+['chain']
+
+p.find_value(data, False)
+['cable']
+```
 
 # Web API
 
@@ -215,6 +238,7 @@ POST /v1/key/{key}
 POST /v1/keys?key=1&key=2&key=3&key=4...
 POST /v1/keychain?key=1&key=2&key=3&key=4...
 POST /v1/keyvalue?key=a&value=1
+POST /v1/value/{value}
 ```
 
 ## Quickstart

jsonparse/VERSION

@@ -1 +1 @@
-0.13.1
+0.14.0

jsonparse/cli.py

@@ -39,12 +39,18 @@ def _flags(version: str) -> argparse.ArgumentParser:
 Parse deeply nested json based on key(s) and value(s)
 
 examples
-
+--------
 jsonparse key-chain my key chain --file test.json
 jsonparse key-chain my '*' 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
+
+jp value null --file test.json
+jp value 42 --file test.json
+jp value '"strValue"' --file test.json
 """)
 
     # all flags here
@@ -73,6 +79,10 @@ def _flags(version: str) -> argparse.ArgumentParser:
     key_value.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin,
                            help="json file as input")
 
+    value = sub_parser.add_parser('value', description='With no FILE, read standard input.')
+    value.add_argument('VALUE', action='store', type=str, nargs=1, help='Search for value. Must be a valid JSON value. If searching for a string value, ensure it is quoted. Returns all keys with that value')
+    value.add_argument('--file', type=argparse.FileType('r'), nargs='?', default=sys.stdin, help="json file as input")
+
     return parser
 
 
@@ -97,6 +107,13 @@ def _parse_input(args: argparse.Namespace) -> None:
             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)))
+    elif 'VALUE' in args:
+        try:
+            value = _pythonify(args.VALUE[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_value(data, value)))
 
 
 def _input(fp: io.TextIOWrapper) -> str:

jsonparse/functions.py

@@ -22,3 +22,8 @@ def find_key_chain(data: Union[dict, list], keys: list) -> list:
 def find_key_value(data: Union[dict, list], key: str, value: Union[str, int, float, bool, None]) -> list:
 
     return Parser().find_key_value(data, key, value)
+
+
+def find_value(data: Union[dict, list], value: Union[str, int, float, bool, None]) -> list:
+
+    return Parser().find_value(data, value)

jsonparse/parser.py

@@ -26,6 +26,10 @@ class Parser:
 
     find_key_value(data, key, value):
         Returns a list of set(s) that contain the key value pair.
+
+    find_value(data, value):
+        Returns a list of key(s) that have the corresponding value.
+
     """
 
     def __init__(self,
@@ -245,6 +249,47 @@ def find_key_value(self,
 
         return value_list
 
+    def find_value(self, data: Union[dict, list], value: Union[str, int, float, bool, None]) -> list:
+        """
+                Search JSON data that consists of key:value pairs for all instances of
+                provided value, returning the associated key (opposite of find_key). The data can have complex nested dictionaries and lists.
+                If duplicate values exist in the data (at any layer), all associated
+                keys will be returned. Data is parsed using a depth first search
+                with a stack.
+
+                Keyword arguments:
+
+                data -- The python object representing JSON data with key:value pairs.
+                        This could be a dictionary or a list.
+                value  -- The value that will be searched for in the JSON data.
+                        Must be a valid JSON value.
+                """
+        if not self._valid_value_input(data, value):
+            raise
+
+        self.stack_ref = self._stack_init()  # init a new stack every request
+        self._stack_push(data)
+        self._stack_trace()
+
+        key_list = []
+
+        while self._stack_size() >= 1:
+
+            elem = self._stack_pop()
+
+            if type(elem) is list:
+                self._stack_push_list_elem(elem)
+            elif type(elem) is dict:
+                key = self._stack_all_value_in_dict(value, elem)
+                if key:
+                    key_list.insert(0, key)
+            else:  # according to RFC 7159, valid JSON can also contain a
+                # string, number, 'false', 'null', 'true'
+                pass  # discard these other values as they don't have a key
+
+        return key_list
+
+
     # STACK operations
 
     def _stack_init(self) -> list:
@@ -353,6 +398,24 @@ def _stack_all_key_and_value_in_dict(
                     self._stack_trace()
         return False
 
+    def _stack_all_value_in_dict(self, value: Union[str, int, float, bool, None], elem: dict) -> str:
+
+        if type(elem) is not dict:
+            raise TypeError
+        elif not isinstance(value, (str, int, float, bool, type(None))):
+            raise TypeError
+
+        if len(elem) <= 0:  # don't want an empty dict on the stack
+            pass
+        else:
+            for e in elem:
+                if elem[e] == value:
+                    return e
+                else:
+                    self._stack_push(elem[e])
+                    self._stack_trace()
+        return False
+
     def _stack_trace(self) -> None:
 
         if self.stack_trace:
@@ -499,3 +562,11 @@ def _valid_key_value_input(
         elif not isinstance(value, (str, int, float, bool, type(None))):
             raise TypeError
         return True
+
+    def _valid_value_input(self, data: Union[dict, list], value: Union[str, int, float, bool, None]) -> bool:
+
+        if not isinstance(data, (dict, list)):
+            raise TypeError
+        elif not isinstance(value, (str, int, float, bool, type(None))):
+            raise TypeError
+        return True

jsonparse/webapi.py

@@ -115,3 +115,18 @@ def _find_key_value():
         return (jsonify(error="value must be valid json"), 400)
 
     return jsonify(Parser().find_key_value(request.json, key, value))
+
+
+# accept a singular value
+# /v1/value/myvalue
+@app.post('/v1/value/<path:value>')
+def _find_value(value: str):
+
+    if not value:
+        return jsonify(error="value must not be empty"), 400
+    try:
+        value = json.loads(value)
+    except json.JSONDecodeError:
+        return jsonify(error="value must be valid json"), 400
+
+    return jsonify(Parser().find_value(request.json, value))

tests/test_cli.py

@@ -21,7 +21,7 @@ class TestCli:
     @pytest.fixture
     def version(self):
 
-        return '0.13.1'
+        return '0.14.0'
 
     def test_read_version(self, version):
 
@@ -66,3 +66,12 @@ def test_flags_keyvalue_invalid_json_input(self):
 
         with pytest.raises(SystemExit):
             args = cli._parse_input(args)
+
+
+    def test_flags_value(self):
+
+        parser = cli._flags('v0.0.1-test')
+        args = parser.parse_args(['value', '42', '--file', 'tests.json'])
+        args = cli._parse_input(args)
+
+        assert True

tests/test_parser.py

@@ -38,7 +38,7 @@ def complex_json(self):
                     },
                 "topping":
                     [
-                        {"id": "5001", "type": "None"},
+                        {"id": "5001", "ty": "None"},
                         {"id": "5002", "type": "Glazed"},
                         {"id": "5003", "type": "Sugar"},
                         {"id": "5004", "type": "Powdered Sugar"},
@@ -63,7 +63,7 @@ def complex_json(self):
                     },
                 "top_stuff":
                     [
-                        {"id": "5001", "type": "None"},
+                        {"id": "5001", "typ": "None"},
                         {"id": "5002", "type": "Glazed"},
                         {"id": "5003", "type": "Sugar"},
                         {"id": "5004", "type": "Chocolate"},
@@ -302,3 +302,18 @@ def test_find_keys_one_not_found(self, parser, complex_json):
         )
 
         assert result == [[True, 0.55], [False, 42], [None, 7]]
+
+    def test_find_value(self, parser, complex_json):
+
+        result = parser.find_value(complex_json, 42)
+        assert result == ['ppu']
+
+    def test_find_value_not_found(self, parser, complex_json):
+
+        result = parser.find_value(complex_json, 0.0001)
+        assert result == []
+
+    def test_find_value_multiple(self, parser, complex_json):
+
+        result = parser.find_value(complex_json, 'None')
+        assert result == ['ty', 'typ', 'type']

tests/test_webapi.py

@@ -116,3 +116,27 @@ def test_keyvalue_bad_json_value(client, data):
 
     response = client.post('/v1/keyvalue?key=a&value=A', json=data)
     assert response.status_code == 400
+
+
+def test_value(client, data):
+
+    response = client.post('/v1/value/42', json=data)
+    assert response.status_code == 200
+
+
+def test_value_valid_json_str_value(client, data):
+
+    response = client.post('/v1/value/"a"', json=data)
+    assert response.status_code == 200
+
+
+def test_value_no_value(client, data):
+
+    response = client.post('/v1/value/', json=data)
+    assert response.status_code == 404
+
+
+def test_value_bad_json_value(client, data):
+
+    response = client.post('/v1/value/A', json=data)
+    assert response.status_code == 400