Function assert_equal

greykite/common/python_utils.py:209–414

Generic equality function that raises an ``AssertionError`` if the objects are not equal. Notes ----- Works with pandas.DataFrame, pandas.Series, numpy.ndarray, str, int, float, bool, None, or a dictionary or list of such items, with arbitrary nesting of dictionaries and lists.

(
        actual,
        expected,
        ignore_list_order=False,
        rel=1e-5,
        dict_path="",
        ignore_keys=None,
        **kwargs)

def assert_equal(
        actual,
        expected,
        ignore_list_order=False,
        rel=1e-5,
        dict_path="",
        ignore_keys=None,
        **kwargs):
    """Generic equality function that raises an ``AssertionError`` if the objects are not equal.

    Notes
    -----
    Works with pandas.DataFrame, pandas.Series, numpy.ndarray, str, int, float,
    bool, None, or a dictionary or list of such items, with arbitrary nesting
    of dictionaries and lists.

    Does not check equivalence of functions, or work with nested numpy arrays.

    Parameters
    ----------
    actual : `pandas.DataFrame`, `pandas.Series`, `numpy.array`, `str`, `int`,
     `float`, `bool`, `None`, or a dictionary or list of such items
        Actual value.
    expected : `pandas.DataFrame`, `pandas.Series`, `numpy.array`, `str`, `int`,
     `float`, `bool`, `None`, or a dictionary or list of such items
        Expected value to compare against.
    ignore_list_order : `bool`, optional, default False
        If True, lists are considered equal if they contain the same elements. This option is valid
        only if the list can be sorted (all elements can be compared to each other).
        If False, lists are considered equal if they contain the same elements in the same order.
    rel : `float`, optional, default 1e-5
        To check int and float, passed to ``rel`` argument of `pytest.approx`.
        To check numpy arrays, passed to ``rtol`` argument of
        `numpy.testing.assert_allclose`.
        To check pandas dataframe, series, and index, passed to ``rtol`` argument of
        `pandas.testing.assert_frame_equal`, `pandas.testing.assert_series_equal`,
        `pandas.testing.assert_index_equal`.
    dict_path : `str`, optional, default ""
        Location within nested dictionary of the original call to this function.
        User should not set this parameter.
    ignore_keys : `dict`, optional, default None
        Keys to ignore in equality comparison. This only applies if
        `expected` is a dictionary.
        Does not compare the values of these keys. However,
        still returns false if the key is not present.

        Can be a nested dictionary. Terminal keys are those whose values should
        not be compared.


        If the expected value is an nested dictionary, this dictionary can
        also be nested, with the same structure.
        For example, if expected:
        expected = {
            "k1": {
                "k1": 1,
                "k2": [1, 2, 3],
            }