v0.18.1: bug fix for find_in_array_from_list search key check

array_search name is deprecated
use find_in_array_from_list
- change parameter order
data (search in) comes before search_params list
- created a TypedDict for the array search params dict entry

pyproject.toml

@@ -1,7 +1,7 @@
 # MARK: Project info
 [project]
 name = "corelibs"
-version = "0.15.0"
+version = "0.18.1"
 description = "Collection of utils for Python scripts"
 readme = "README.md"
 requires-python = ">=3.13"

src/corelibs/debug_handling/debug_helpers.py

@@ -6,28 +6,39 @@ import traceback
 import os
 
 
-def traceback_call_str(start: int = 2, depth: int = 1):
+def call_stack(
+    start: int = 0,
+    skip_last: int = -1,
+    separator: str = ' -> ',
+    reset_start_if_empty: bool = False
+) -> str:
     """
     get the trace for the last entry
 
     Keyword Arguments:
-        start {int} -- _description_ (default: {2})
+        start {int} -- start, if too might output will empty until reset_start_if_empty is set (default: {0})
-        depth {int} -- _description_ (default: {1})
+        skip_last {int} -- how many of the last are skipped, defaults to -1 for current method (default: {-1})
+        seperator {str} -- add stack separator, if empty defaults to ' -> ' (default: { -> })
+        reset_start_if_empty {bool} -- if no stack returned because of too high start,
+                                        reset to 0 for full read (default: {False})
 
     Returns:
-        _type_ -- _description_
+        str -- _description_
     """
-    # can't have more than in the stack for depth
+    # stack = traceback.extract_stack()[start:depth]
-    depth = min(depth, start)
+    # how many of the last entries we skip (so we do not get self), default is -1
-    depth = start - depth
+    # start cannot be negative
-    # 0 is full stack length from start
+    if skip_last > 0:
-    if depth == 0:
+        skip_last = skip_last * -1
-        stack = traceback.extract_stack()[-start:]
+    stack = traceback.extract_stack()
-    else:
+    __stack = stack[start:skip_last]
-        stack = traceback.extract_stack()[-start:-depth]
+    # start possible to high, reset start to 0
-    return ' -> '.join(
+    if not __stack and reset_start_if_empty:
-        f"{os.path.basename(f.filename)}:{f.name}:{f.lineno}"
+        start = 0
-        for f in stack
+        __stack = stack[start:skip_last]
-    )
+    if not separator:
+        separator = ' -> '
+    # print(f"* HERE: {dump_data(stack)}")
+    return f"{separator}".join(f"{os.path.basename(f.filename)}:{f.name}:{f.lineno}" for f in __stack)
 
 # __END__

src/corelibs/exceptions/csv_exceptions.py

@@ -0,0 +1,23 @@
+"""
+Exceptions for csv file reading and processing
+"""
+
+
+class NoCsvReader(Exception):
+    """
+    CSV reader is none
+    """
+
+
+class CsvHeaderDataMissing(Exception):
+    """
+    The csv reader returned None as headers, the header column in the csv file is missing
+    """
+
+
+class CompulsoryCsvHeaderCheckFailed(Exception):
+    """
+    raise if the header is not matching to the excpeted values
+    """
+
+# __END__

src/corelibs/iterator_handling/data_search.py

@@ -2,23 +2,40 @@
 wrapper around search path
 """
 
-from typing import Any
+from typing import Any, TypedDict, NotRequired
+from warnings import deprecated
 
 
+class ArraySearchList(TypedDict):
+    """find in array from list search dict"""
+    key: str
+    value: str | bool | int | float | list[str | None]
+    case_sensitive: NotRequired[bool]
+
+
+@deprecated("Use find_in_array_from_list()")
 def array_search(
-    search_params: list[dict[str, str | bool | list[str | None]]],
+    search_params: list[ArraySearchList],
     data: list[dict[str, Any]],
     return_index: bool = False
+) -> list[dict[str, Any]]:
+    """depreacted, old call order"""
+    return find_in_array_from_list(data, search_params, return_index)
+
+def find_in_array_from_list(
+    data: list[dict[str, Any]],
+    search_params: list[ArraySearchList],
+    return_index: bool = False
 ) -> list[dict[str, Any]]:
     """
-    search in an array of dicts with an array of Key/Value set
+    search in an list of dicts with an list of Key/Value set
     all Key/Value sets must match
     Value set can be list for OR match
     option: case_senstive: default True
 
     Args:
-        search_params (list): List of search params in "Key"/"Value" lists with options
         data (list): data to search in, must be a list
+        search_params (list): List of search params in "key"/"value" lists with options
         return_index (bool): return index of list [default False]
 
     Raises:
@@ -32,18 +49,20 @@ def array_search(
     """
     if not isinstance(search_params, list):  # type: ignore
         raise ValueError("search_params must be a list")
-    keys = []
+    keys: list[str] = []
+    # check that key and value exist and are set
     for search in search_params:
-        if not search.get('Key') or not search.get('Value'):
+        if not search.get('key') or not search.get('value'):
             raise KeyError(
-                f"Either Key '{search.get('Key', '')}' or "
+                f"Either Key '{search.get('key', '')}' or "
-                f"Value '{search.get('Value', '')}' is missing or empty"
+                f"Value '{search.get('value', '')}' is missing or empty"
             )
         # if double key -> abort
-        if search.get("Key") in keys:
+        if search.get("key") in keys:
             raise KeyError(
-                f"Key {search.get('Key', '')} already exists in search_params"
+                f"Key {search.get('key', '')} already exists in search_params"
             )
+        keys.append(str(search['key']))
 
     return_items: list[dict[str, Any]] = []
     for si_idx, search_item in enumerate(data):
@@ -55,20 +74,20 @@ def array_search(
             # lower case left side
             # TODO: allow nested Keys. eg "Key: ["Key a", "key b"]" to be ["Key a"]["key b"]
             if search.get("case_sensitive", True) is False:
-                search_value = search_item.get(str(search['Key']), "").lower()
+                search_value = search_item.get(str(search['key']), "").lower()
             else:
-                search_value = search_item.get(str(search['Key']), "")
+                search_value = search_item.get(str(search['key']), "")
             # lower case right side
-            if isinstance(search['Value'], list):
+            if isinstance(search['value'], list):
                 search_in = [
-                        str(k).lower()
+                    str(k).lower()
-                        if search.get("case_sensitive", True) is False else k
+                    if search.get("case_sensitive", True) is False else k
-                        for k in search['Value']
+                    for k in search['value']
-                    ]
+                ]
             elif search.get("case_sensitive", True) is False:
-                search_in = str(search['Value']).lower()
+                search_in = str(search['value']).lower()
             else:
-                search_in = search['Value']
+                search_in = search['value']
             # compare check
             if (
                 (

src/corelibs/logging_handling/log.py

@@ -12,7 +12,7 @@ from pathlib import Path
 from typing import MutableMapping, TextIO, TypedDict, Any, TYPE_CHECKING, cast
 from corelibs.logging_handling.logging_level_handling.logging_level import LoggingLevel
 from corelibs.string_handling.text_colors import Colors
-from corelibs.debug_handling.debug_helpers import traceback_call_str
+from corelibs.debug_handling.debug_helpers import call_stack
 
 if TYPE_CHECKING:
     from multiprocessing import Queue
@@ -76,6 +76,7 @@ class CustomConsoleFormatter(logging.Formatter):
 
 # TODO: add custom handlers for stack_trace, if not set fill with %(filename)s:%(funcName)s:%(lineno)d
 # hasattr(record, 'stack_trace')
+# also for something like "context" where we add an array of anything to a message
 
 
 class CustomHandlerFilter(logging.Filter):
@@ -130,7 +131,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.log(level, msg, *args, extra=extra, stacklevel=2)
 
     # MARK: DEBUG 10
@@ -140,7 +141,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.debug(msg, *args, extra=extra, stacklevel=2)
 
     # MARK: INFO 20
@@ -150,7 +151,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.info(msg, *args, extra=extra, stacklevel=2)
 
     # MARK: WARNING 30
@@ -160,7 +161,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.warning(msg, *args, extra=extra, stacklevel=2)
 
     # MARK: ERROR 40
@@ -170,7 +171,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.error(msg, *args, extra=extra, stacklevel=2)
 
     # MARK: CRITICAL 50
@@ -180,7 +181,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.critical(msg, *args, extra=extra, stacklevel=2)
 
     # MARK: ALERT 55
@@ -191,7 +192,7 @@ class LogParent:
         # extra_dict = dict(extra)
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.log(LoggingLevel.ALERT.value, msg, *args, extra=extra, stacklevel=2)
 
     # MARK: EMERGECNY: 60
@@ -201,7 +202,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         self.logger.log(LoggingLevel.EMERGENCY.value, msg, *args, extra=extra, stacklevel=2)
 
     # MARK: EXCEPTION: 70
@@ -223,7 +224,7 @@ class LogParent:
             raise ValueError('Logger is not yet initialized')
         if extra is None:
             extra = {}
-        extra['stack_trace'] = traceback_call_str(start=3)
+        extra['stack_trace'] = call_stack(skip_last=2)
         # write to console first with extra flag for filtering in file
         if log_error:
             self.logger.log(

test-run/iterator_handling/data_search.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+
+"""
+Search data tests
+iterator_handling.data_search
+"""
+
+from corelibs.debug_handling.dump_data import dump_data
+from corelibs.iterator_handling.data_search import find_in_array_from_list, ArraySearchList
+
+
+def main() -> None:
+    """
+    Comment
+    """
+    data = [
+        {
+            "lookup_value_p": "A01",
+            "lookup_value_c": "B01",
+            "replace_value": "R01",
+        },
+        {
+            "lookup_value_p": "A02",
+            "lookup_value_c": "B02",
+            "replace_value": "R02",
+        },
+    ]
+    test_foo = ArraySearchList(
+        key = "lookup_value_p",
+        value = "A01"
+    )
+    print(test_foo)
+    search: list[ArraySearchList] = [
+        {
+            "key": "lookup_value_p",
+            "value": "A01"
+        },
+        {
+            "key": "lookup_value_c",
+            "value": "B01"
+        }
+    ]
+
+    result = find_in_array_from_list(data, search)
+
+    print(f"Search {dump_data(search)} -> {dump_data(result)}")
+
+
+if __name__ == "__main__":
+    main()
+
+# __END__

uv.lock

@@ -44,7 +44,7 @@ wheels = [
 
 [[package]]
 name = "corelibs"
-version = "0.14.1"
+version = "0.18.0"
 source = { editable = "." }
 dependencies = [
     { name = "jmespath" },