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

lkj/__init__.py

@@ -13,6 +13,7 @@ from lkj.dicts import (
     inclusive_subdict,  # new dictionary with only the keys in `include`
     exclusive_subdict,  # new dictionary with only the keys not in `exclude`.
     merge_dicts,  # Merge multiple dictionaries recursively
+    compare_field_values,  # Compare two dictionaries' values
 )
 from lkj.filesys import get_app_data_dir, get_watermarked_dir, enable_sourcing_from_file
 from lkj.strings import (

lkj/dicts.py

@@ -224,7 +224,11 @@ Comparison = Any
 Comparator = Callable[[dict, dict], Comparison]
 
 
-def compare_dicts(
+def _common_keys_list(dict1, dict2):
+    return [k for k in dict1.keys() if k in dict2.keys()]
+
+
+def compare_field_values(
     dict1,
     dict2,
     *,
@@ -232,16 +236,17 @@ def compare_dicts(
     default_comparator: Comparator = operator.eq,
     aggregator: Callable[
         [Dict[KT, Comparison]], Any
-    ] = lambda d: d,  # lambda d: np.mean(list(d.values()))
+    ] = lambda d: d,  # lambda d: np.mean(list(d.values())),
+    get_comparison_fields: Callable[[dict], Iterable[KT]] = _common_keys_list,
 ):
     """
-    Compare two dictionaries field by field using specified comparators or a default comparator.
+    Compare two dictionaries' values field by field
 
     :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.
+    :param aggregator: A function to aggregate the comparison results into a final comparison object.
     :return: A final score based on the comparison results.
 
     >>> dict1 = {"color": "brown", "animal": "dog"}
@@ -251,22 +256,22 @@ def compare_dicts(
     ...     "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)
+    >>> compare_field_values(dict1, dict2, field_comparators=field_comparators)
     {'color': 1, 'animal': 1}
-    >>> compare_dicts(dict1, dict3, field_comparators=field_comparators)
+    >>> compare_field_values(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
+    >>> mean_of_values = functools.partial(
+    ...     compare_field_values, field_comparators=field_comparators, aggregator=aggregator
     ... )
-    >>> my_compare_dicts(dict1, dict2)
+    >>> mean_of_values(dict1, dict2)
     1
-    >>> my_compare_dicts(dict1, dict3)
+    >>> mean_of_values(dict1, dict3)
     0.5
 
     """
-    common_keys = [k for k in dict1.keys() if k in dict2.keys()]
+    common_keys = get_comparison_fields(dict1, dict2)
 
     comparisons = {}
     for key in common_keys:

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

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

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

@@ -1,6 +1,6 @@
-lkj/__init__.py,sha256=YEPCVj-0EJOfpapgX3Vw07399w13OkCm39KCmCi5AQg,6806
+lkj/__init__.py,sha256=Vceal0uY2jW1y0sQHOk1WHXc9aTAEXXOJ9vgyOmnrNk,6868
 lkj/chunking.py,sha256=RpNdx5jEuO4mFg2qoTkD47iL35neBneuZ5xgQ_cBkiM,3755
-lkj/dicts.py,sha256=nfciX_h7tplR3cbaDYcQvucb7UWzv8vmvp2NDEiQm-4,10227
+lkj/dicts.py,sha256=z2o7njvLNJkh1ZgSH-SLtz13SdW_YfUsTA1yTY-kVLE,10382
 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.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,,
+lkj-0.1.42.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+lkj-0.1.42.dist-info/METADATA,sha256=vvlxvyZs9Nz9Uk_9l5ZNToXTrViVa4WOKVH5YkDzsHU,4684
+lkj-0.1.42.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+lkj-0.1.42.dist-info/top_level.txt,sha256=3DZOUwYmyurJFBXQCvCmEIVm8z2b42O5Sx3RDQyePfg,4
+lkj-0.1.42.dist-info/RECORD,,