allensdk.brain_observatory.comparison_utils module

allensdk.brain_observatory.comparison_utils.compare_fields(x1: Any, x2: Any, err_msg='', ignore_keys: Union[Set[str], NoneType] = None)

Helper function to compare if two fields (attributes) are equal to one another.

Parameters:

x1 : Any

The first field

x2 : Any

The other field

err_msg : str, optional

The error message to display if two compared fields do not equal one another, by default “” (an empty string)

ignore_keys

For dictionary comparison, ignore these keys