Merge pull request #18 from ctomkow/group_param

Group param

Author: ctomkow

README.md

@@ -55,8 +55,8 @@ parser.find_key(data, 'key')
 parser.find_keys(data, ['rope', 'cable'])
 [[5, False], [7, True]]
 
-parser.find_keys(data, ['cable', 'rope'])
-[[5, False], [7, True]]
+parser.find_keys(data, ['rope', 'cable'], group=False)
+[5, False, 7, True]
 
 
 parser.find_key_chain(data, ['my', 'key', 'chain'])
@@ -85,12 +85,14 @@ parser.find_key_value(data, 'chain', 'B')
 
 -  Returns a list of values that match the corresponding key.
 
-`find_keys(data: dict | list, keys: list) -> list`
+`find_keys(data: dict | list, keys: list, group: bool = True) -> list`
 
 -  Provide JSON data as a dictionary or a list. The keys are a list of strings. The order of the keys does not matter.
 
 -  Returns a two dimensional list of values matching the keys. The order of values is returned in the same order as the original data.
 
+-  To return a one dimensional list, pass the keyword parameter group=False
+
 `find_key_chain(data: dict | list, keys: list) -> list`
 
 -  Provide JSON data as a dictionary or a list. The key chain is a list of keys that are all strings. The order of the keys **does** matter.

jsonparse/parser.py

@@ -89,24 +89,33 @@ def find_key(self, data: Union[dict, list], key: str) -> list:
 
         return value_list
 
-    def find_keys(self, data: Union[dict, list], keys: list) -> list:
+    def find_keys(self,
+                  data: Union[dict, list],
+                  keys: list,
+                  group: bool = True) -> list:
         """
         Search JSON data that consists of key:value pairs for all instances of
         provided keys. The data can have complex nested dictionaries and lists.
         If duplicate keys exist in the data (at any layer) all matching key
         values will be returned. Each instance of matching keys within a
         dictionary will be returned as a list. The final return value is a
-        two dimensional list.
+        two dimensional list. If a one dimensional list is needed where
+        matched key values of the same dictionaries are not returned as a
+        list, pass the group=False keyword parameter.
 
         Keyword arguments:
 
         data -- The python object representing JSON data with key:value pairs.
                 This could be a dictionary or a list.
         keys  -- The keys that will be searched for in the JSON data.
                 The keys argument is a list of dictionary keys.
+        group -- Determines whether the found values of the same dictionary
+                 will be returned as a list or not. Default is True which
+                 results in a two dimensional list. Pass False to return
+                 a one dimensional list.
         """
 
-        if not self._valid_keys_input(data, keys):
+        if not self._valid_keys_input(data, keys, group):
             raise
 
         self.stack_ref = self._stack_init()  # init a new stack every request
@@ -123,8 +132,11 @@ def find_keys(self, data: Union[dict, list], keys: list) -> list:
                 self._stack_push_list_elem(elem)
             elif type(elem) is dict:
                 value = self._stack_all_keys_values_in_dict(keys, elem)
-                if value:
+                if value and group:
                     value_list.insert(0, value)
+                elif value and not group:
+                    for e in reversed(value):
+                        value_list.insert(0, e)
             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
@@ -441,14 +453,17 @@ def _valid_key_input(
     def _valid_keys_input(
             self,
             data: Union[dict, list],
-            keys: list) -> bool:
+            keys: list,
+            group: bool) -> bool:
 
         if not isinstance(data, (dict, list)):
             raise TypeError
         elif not isinstance(keys, list):
             raise TypeError
         elif not keys:  # if keys is an empty list
             raise ValueError
+        elif not isinstance(group, bool):
+            raise TypeError
         return True
 
     def _valid_key_chain_input(

jsonparse/webapi.py

@@ -29,14 +29,16 @@ def _find_key(key: str):
 
 
 # query parameters of keys
-# /v1/keys?key=first&key=second&key=third
+# /v1/keys?key=first&key=second&key=third&group=False
 @app.post('/v1/keys')
 def _find_keys():
 
     # validate parameter keys
     param_keys = request.args.keys()
+    if not param_keys:
+        return (jsonify(error="parameter key incorrect"), 400)
     for k in param_keys:
-        if k != 'key':
+        if (k != 'key') and (k != 'group'):
             return (jsonify(error="parameter key incorrect"), 400)
 
     keys = request.args.getlist('key')
@@ -46,7 +48,15 @@ def _find_keys():
         elif not key:
             return (jsonify(error="key must not be empty"), 400)
 
-    return Parser().find_keys(request.json, keys)
+    group = request.args.get('group')
+    if not group:
+        group_status = True
+    elif group.lower() == 'false':
+        group_status = False
+    else:
+        group_status = True
+
+    return Parser().find_keys(request.json, keys, group_status)
 
 
 # query parameters of keys

tests/test_parser.py

@@ -275,6 +275,16 @@ def test_find_keys(self, parser, complex_json):
 
         assert result == [[5, 8], [22, 99], [1, 9], [4, 7]]
 
+    def test_find_keys_no_group(self, parser, complex_json):
+
+        result = parser.find_keys(
+            complex_json,
+            ['start', 'end'],
+            group=False
+        )
+
+        assert result == [5, 8, 22, 99, 1, 9, 4, 7]
+
     def test_find_keys_not_found(self, parser, complex_json):
 
         result = parser.find_keys(

tests/test_webapi.py

@@ -50,6 +50,14 @@ def test_keys(client, data):
     assert response.status_code == 200
 
 
+def test_keys_with_group(client, data):
+
+    response = client.post(
+        "/v1/keys?key=exists&key=ppu&group=False",
+        json=data)
+    assert response.status_code == 200
+
+
 def test_keys_empty_param_key(client, data):
 
     response = client.post("/v1/keys?key=", json=data)
@@ -62,6 +70,12 @@ def test_keys_bad_params_key(client, data):
     assert response.status_code == 400
 
 
+def test_keys_no_params(client, data):
+
+    response = client.post("/v1/keys?", json=data)
+    assert response.status_code == 400
+
+
 def test_keychain(client, data):
 
     response = client.post("/v1/keychain?key=a&key=b", json=data)