Only use +and in filters when necessary (#695)

Author: lgarber-akamai

linodecli/api_request.py

@@ -162,26 +162,29 @@ def _build_filter_header(
     order_by = parsed_args_dict.pop("order_by")
     order = parsed_args_dict.pop("order") or "asc"
 
-    # The "+and" list to be used in the filter header
-    filter_list = []
+    result = {}
+
+    # A list filter allows a user to filter on multiple values in a list
+    # e.g. --tags foobar --tags foobar2
+    list_filters = []
 
-    for k, v in parsed_args_dict.items():
-        if v is None:
+    for key, value in parsed_args_dict.items():
+        if value is None:
             continue
 
-        # If this is a list, flatten it out
-        new_filters = [{k: j} for j in v] if isinstance(v, list) else [{k: v}]
-        filter_list.extend(new_filters)
+        if not isinstance(value, list):
+            result[key] = value
+            continue
+
+        list_filters.extend(iter({key: entry} for entry in value))
+
+    if len(list_filters) > 0:
+        result["+and"] = list_filters
 
-    result = {}
-    if len(filter_list) > 0:
-        if len(filter_list) == 1:
-            result = filter_list[0]
-        else:
-            result["+and"] = filter_list
     if order_by is not None:
         result["+order_by"] = order_by
         result["+order"] = order
+
     return json.dumps(result) if len(result) > 0 else None
 
 

tests/unit/test_api_request.py

@@ -208,11 +208,11 @@ def test_build_filter_header(self, list_operation):
         assert (
             json.dumps(
                 {
+                    "filterable_result": "bar",
                     "+and": [
-                        {"filterable_result": "bar"},
                         {"filterable_list_result": "foo"},
                         {"filterable_list_result": "bar"},
-                    ]
+                    ],
                 }
             )
             == result
@@ -271,8 +271,8 @@ def test_build_filter_header_order_by(self, list_operation):
         assert (
             json.dumps(
                 {
+                    "filterable_result": "bar",
                     "+and": [
-                        {"filterable_result": "bar"},
                         {"filterable_list_result": "foo"},
                         {"filterable_list_result": "bar"},
                     ],
@@ -297,8 +297,8 @@ def test_build_filter_header_order(self, list_operation):
         assert (
             json.dumps(
                 {
+                    "filterable_result": "bar",
                     "+and": [
-                        {"filterable_result": "bar"},
                         {"filterable_list_result": "foo"},
                         {"filterable_list_result": "bar"},
                     ],
@@ -335,11 +335,11 @@ def validate_http_request(url, headers=None, data=None, **kwargs):
             assert url == "http://localhost/v4/foo/bar?page=1&page_size=100"
             assert headers["X-Filter"] == json.dumps(
                 {
+                    "filterable_result": "cool",
                     "+and": [
-                        {"filterable_result": "cool"},
                         {"filterable_list_result": "foo"},
                         {"filterable_list_result": "bar"},
-                    ]
+                    ],
                 }
             )
             assert headers["User-Agent"] == mock_cli.user_agent