lkj 0.1.38__py3-none-any.whl → 0.1.40__py3-none-any.whl

lkj/__init__.py

@@ -30,13 +30,14 @@ from lkj.strings import (
     truncate_string_with_marker,  # Deprecated: Backcompatibility alias
 )
 from lkj.loggers import (
-    print_with_timestamp,
-    print_progress,
-    log_calls,
-    clog,
+    print_with_timestamp,  # Prints with a timestamp and optional refresh.
+    print_progress,  # an alias often used for print_with_timestamp
+    log_calls,  # Decorator that adds logging before and after the function's call.
+    clog,  # Conditional logger
     ErrorInfo,
-    return_error_info_on_error,
-    wrapped_print,
+    return_error_info_on_error,  # Decorator that returns traceback and local variables on error.
+    wrapped_print,  # Prints a string or list ensuring the total line width does not exceed `max_width`.
+    CallOnError,  # Context manager that calls a function on error (subclass of suppress)
 )
 from lkj.importing import import_object, register_namespace_forwarding
 from lkj.chunking import chunk_iterable, chunker

lkj/dicts.py

@@ -111,16 +111,10 @@ from typing import Mapping, Callable, TypeVar, Iterable, Tuple
 KT = TypeVar("KT")  # Key type
 VT = TypeVar("VT")  # Value type
 
+
 # Note: Could have all function parameters (recursive_condition, etc.) also take the
 #       enumerated index of the mapping as an argument. That would give us even more
 #       flexibility, but it might be overkill and make the interface more complex.
-from typing import Mapping, Callable, TypeVar, Iterable, Tuple
-from collections import defaultdict
-
-KT = TypeVar("KT")  # Key type
-VT = TypeVar("VT")  # Value type
-
-
 def merge_dicts(
     *mappings: Mapping[KT, VT],
     recursive_condition: Callable[[VT], bool] = lambda v: isinstance(v, Mapping),
@@ -221,3 +215,62 @@ def merge_dicts(
                 merged[key] = value
 
     return merged
+
+
+import operator
+from typing import Callable, Dict, Any
+
+Comparison = Any
+Comparator = Callable[[dict, dict], Comparison]
+
+
+def compare_dicts(
+    dict1,
+    dict2,
+    *,
+    field_comparators: Dict[KT, Comparator] = {},
+    default_comparator: Comparator = operator.eq,
+    aggregator: Callable[
+        [Dict[KT, Comparison]], Any
+    ] = lambda d: d,  # lambda d: np.mean(list(d.values()))
+):
+    """
+    Compare two dictionaries field by field using specified comparators or a default comparator.
+
+    :param dict1: The first dictionary.
+    :param dict2: The second dictionary.
+    :param field_comparators: A dictionary where keys are field names and values are comparator functions.
+    :param default_comparator: A default comparator function to use if no specific comparator is provided for a field.
+    :param aggregator: A function to aggregate the comparison results into a final score.
+    :return: A final score based on the comparison results.
+
+    >>> dict1 = {"color": "brown", "animal": "dog"}
+    >>> dict2 = {"color": "brown", "animal": "cat"}
+    >>> dict3 = {"color": "brown", "animal": "bird"}
+    >>> field_comparators = {
+    ...     "color": lambda x, y: 1 if x == y else 0,
+    ...     "animal": lambda x, y: 1 if len(x) == len(y) else 0
+    ... }
+    >>> compare_dicts(dict1, dict2, field_comparators=field_comparators)
+    {'color': 1, 'animal': 1}
+    >>> compare_dicts(dict1, dict3, field_comparators=field_comparators)
+    {'color': 1, 'animal': 0}
+    >>> import functools, statistics
+    >>> aggregator = lambda d: statistics.mean(d.values())
+    >>> my_compare_dicts = functools.partial(
+    ...     compare_dicts, field_comparators=field_comparators, aggregator=aggregator
+    ... )
+    >>> my_compare_dicts(dict1, dict2)
+    1
+    >>> my_compare_dicts(dict1, dict3)
+    0.5
+
+    """
+    common_keys = [k for k in dict1.keys() if k in dict2.keys()]
+
+    comparisons = {}
+    for key in common_keys:
+        comparator = field_comparators.get(key, default_comparator)
+        comparisons[key] = comparator(dict1[key], dict2[key])
+
+    return aggregator(comparisons)

{lkj-0.1.38.dist-info → lkj-0.1.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lkj
-Version: 0.1.38
+Version: 0.1.40
 Summary: A dump of homeless useful utils
 Home-page: https://github.com/thorwhalen/lkj
 Author: Thor Whalen

{lkj-0.1.38.dist-info → lkj-0.1.40.dist-info}/RECORD

@@ -1,6 +1,6 @@
-lkj/__init__.py,sha256=4ODMsEY0QFEdRKWfFPY3QptydAOi9Lp8iFHtMJOU1jc,6376
+lkj/__init__.py,sha256=YEPCVj-0EJOfpapgX3Vw07399w13OkCm39KCmCi5AQg,6806
 lkj/chunking.py,sha256=RpNdx5jEuO4mFg2qoTkD47iL35neBneuZ5xgQ_cBkiM,3755
-lkj/dicts.py,sha256=EbTLtYlexCDhDlwKnzflZ5CEU0ql6KgZdu3SvR7bU20,8289
+lkj/dicts.py,sha256=nfciX_h7tplR3cbaDYcQvucb7UWzv8vmvp2NDEiQm-4,10227
 lkj/filesys.py,sha256=NbWDuc848h8O42gwX7d9yNJkrWBgzSFnkoEdSRgvBAg,8883
 lkj/funcs.py,sha256=LXJlj3gMMsbD0t2gn2NZZ6mOqmW5bxM-94uGoYgrhzI,8930
 lkj/importing.py,sha256=_BFBmdaKCBnk5broltWDeAPeEKG1dEkS8DhIdv6UhSI,3809
@@ -8,8 +8,8 @@ lkj/iterables.py,sha256=9jeO36w-IGiZryge7JKgXZOGZAgehUvhwKV3nHPcZWk,2801
 lkj/loggers.py,sha256=ImmBdacz89Lvb3dg_xI5jOct_44rSRv0hNI_CVehy60,13706
 lkj/misc.py,sha256=IZf05tkl0cgiMgBwCMH5cLSC59fRXwnemPRo8G0OxQg,1436
 lkj/strings.py,sha256=3YjlxOWUfzWqwu51uq_pv9XZReLqRFvziGtRsdzEtw8,24662
-lkj-0.1.38.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-lkj-0.1.38.dist-info/METADATA,sha256=hR_dtcWY1IMHrjOuYnr4B0B2-P8TR3Ek5vMkSU_72IM,4684
-lkj-0.1.38.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-lkj-0.1.38.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
-lkj-0.1.38.dist-info/RECORD,,
+lkj-0.1.40.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lkj-0.1.40.dist-info/METADATA,sha256=MQn5N_4SfIm7fUZl9zCTtuSTz94PYPenG7EZd8juq14,4684
+lkj-0.1.40.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+lkj-0.1.40.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
+lkj-0.1.40.dist-info/RECORD,,