Utility functions update

Author: okorach-sonar

cli/config.py

@@ -125,10 +125,7 @@ def __parse_args(desc: str) -> object:
 def __normalize_json(json_data: dict[str, any], remove_empty: bool = True, remove_none: bool = True) -> dict[str, any]:
     """Sorts a JSON file and optionally remove empty and none values"""
     log.info("Normalizing JSON - remove empty = %s, remove nones = %s", str(remove_empty), str(remove_none))
-    if remove_empty:
-        json_data = utilities.remove_empties(json_data)
-    if remove_none:
-        json_data = utilities.remove_nones(json_data)
+    json_data = utilities.clean_data(json_data, remove_none=remove_none, remove_empty=remove_empty)
     json_data = utilities.order_keys(json_data, *_SECTIONS_ORDER)
     for key in [k for k in _SECTIONS_TO_SORT if k in json_data]:
         json_data[key] = {k: json_data[key][k] for k in sorted(json_data[key])}
@@ -260,7 +257,7 @@ def __prep_json_for_write(json_data: types.ObjectJsonRepr, export_settings: type
         json_data = utilities.remove_nones(json_data)
         if not export_settings.get(EXPORT_EMPTY, False):
             log.debug("Removing empties")
-            json_data = utilities.remove_empties(json_data)
+            json_data = utilities.clean_data(json_data, remove_empty=True)
     if export_settings.get("INLINE_LISTS", True):
         json_data = utilities.inline_lists(json_data, exceptions=("conditions",))
     return json_data

sonar/utilities.py

@@ -723,15 +723,15 @@ def dict_remap_and_stringify(original_dict: dict[str, str], remapping: dict[str,
     return dict_stringify(dict_remap(original_dict, remapping))
 
 
-def list_to_dict(original_list: list[dict[str, any]], key_field: str) -> dict[str, any]:
+def list_to_dict(original_list: list[dict[str, Any]], key_field: str) -> dict[str, any]:
     """Converts a list to dict with list key_field as dict key"""
     converted_dict = {elem[key_field]: elem for elem in original_list}
     for e in converted_dict.values():
         e.pop(key_field)
     return converted_dict
 
 
-def dict_to_list(original_dict: dict[str, any], key_field: str, value_field: Optional[str] = "value") -> list[str, any]:
+def dict_to_list(original_dict: dict[str, Any], key_field: str, value_field: Optional[str] = "value") -> list[str, any]:
     """Converts a dict to list adding dict key in list key_field"""
     if isinstance(original_dict, list):
         return original_dict
@@ -791,20 +791,6 @@ def pretty_print_json(file: str) -> bool:
     return True
 
 
-def order_keys(original_dict: dict[str, any], *keys) -> dict[str, any]:
-    """Orders a dict keys in a chosen order, existings keys not in *keys are pushed to the end
-    :param dict[str, any] original_dict: Dict to order
-    :param str *keys: List of keys in desired order
-    :return: same dict with keys in desired order
-    """
-    ordered_dict = {}
-    for key in [k for k in keys if k in original_dict]:
-        ordered_dict[key] = original_dict[key]
-    for key in [k for k in original_dict if k not in keys]:
-        ordered_dict[key] = original_dict[key]
-    return ordered_dict
-
-
 def flatten(original_dict: dict[str, any]) -> dict[str, any]:
     """Flattens a recursive dict into a flat one"""
     flat_dict = {}
@@ -834,6 +820,20 @@ def sort_list_by_key(list_to_sort: list[dict[str, Any]], key: str, priority_fiel
     return first_elem + list(dict(sorted(tmp_dict.items())).values())
 
 
+def order_keys(original_dict: dict[str, any], *keys) -> dict[str, any]:
+    """Orders a dict keys in a chosen order, existings keys not in *keys are pushed to the end
+    :param dict[str, any] original_dict: Dict to order
+    :param str *keys: List of keys in desired order
+    :return: same dict with keys in desired order
+    """
+    ordered_dict = {}
+    for key in [k for k in keys if k in original_dict]:
+        ordered_dict[key] = original_dict[key]
+    for key in [k for k in original_dict if k not in keys]:
+        ordered_dict[key] = original_dict[key]
+    return ordered_dict
+
+
 def order_dict(d: dict[str, Any], key_order: list[str]) -> dict[str, Any]:
     """Orders keys of a dictionary in a given order"""
     new_d = {k: d[k] for k in key_order if k in d}