egse.dicts

cgse-common

This code is part of the cgse-common package.

egse.dicts ¶

This module provides convenience functions to inspect and compare dictionaries when debugging.

Functions:

Name	Description
`flatten_dict`	Flatten the given dictionary concatenating the keys with a colon '`:`'.
`log_differences`	Takes two flattened dictionaries and compares them. This function only compares those
`log_key_differences`	Takes two dictionaries and compares the top-level keys. The differences are logged in a Rich Table at level=INFO.

flatten_dict ¶

flatten_dict(source_dict)

Flatten the given dictionary concatenating the keys with a colon ':'.

Parameters:

Name	Type	Description	Default
`source_dict`	`dict`	the original dictionary that will be flattened	required

Returns:

Type	Description
`dict`	A new flattened dictionary.

Example

>>> d = {"A": 1, "B": {"E": {"F": 2}}, "C": {"D": 3}}
>>> flatten_dict(d)
{'A': 1, 'B:E:F': 2, 'C:D': 3}

>>> d = {"A": 'a', "B": {"C": {"D": 'd', "E": 'e'}, "F": 'f'}}
>>> flatten_dict(d)
{'A': 'a', 'B:C:D': 'd', 'B:C:E': 'e', 'B:F': 'f'}

log_differences ¶

log_differences(dict_1, dict_2)

Takes two flattened dictionaries and compares them. This function only compares those keys that are common to both dictionaries. The key-value pairs that are unique to one of the dictionaries are ignored. To inspect if there are keys unique to one dictionary, use the log_key_differences() function.

The differences are logged in a Rich Table at level=INFO.

Example

>>> d1 = { "A": 1, "B": 2, "C": 3 }
>>> d2 = { "A": 1, "B": 5, "C": 3 }
>>> log_differences(d1, d2)

2025-02-28 09:20:51,639:         MainProcess:    INFO:   37:__main__            :Value Differences

┏━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓
┃ Name ┃ old value ┃ new value ┃
┡━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩
│ B    │ 2         │ 5         │
└──────┴───────────┴───────────┘

log_key_differences ¶

log_key_differences(dict_1, dict_2)

Takes two dictionaries and compares the top-level keys. The differences are logged in a Rich Table at level=INFO. Keys that are present on both dictionaries are not logged.

Example

>>> d1 = {"A": 1, "B": 2, "C": 3}
>>> d2 = {"B": 2, "C": 3, "D": 4}
>>> log_key_differences(d1, d2)
2025-02-28 09:08:29,916:         MainProcess:    INFO:   60:__main__            :Key differences
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ Dictionary 1 ┃ Dictionary 2 ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩
│ A            │              │
│              │ D            │
└──────────────┴──────────────┘