Function make_assert_equal_assertion_error

zipline/testing/predicates.py:344–371

Create an assertion error formatted for use in ``assert_equal``. Parameters ---------- assertion_message : str The concrete reason for the failure. path : tuple[str] The path leading up to the failure. msg : str The user supplied message. Returns

(assertion_message, path, msg)

def make_assert_equal_assertion_error(assertion_message, path, msg):
    """Create an assertion error formatted for use in ``assert_equal``.

    Parameters
    ----------
    assertion_message : str
        The concrete reason for the failure.
    path : tuple[str]
        The path leading up to the failure.
    msg : str
        The user supplied message.

    Returns
    -------
    exception_instance : AssertionError
        The new exception instance.

    Notes
    -----
    This doesn't raise the exception, it only returns it.
    """
    return AssertionError(
        '%s%s\n%s' % (
            _fmt_msg(msg),
            assertion_message,
            _fmt_path(path),
        ),
    )


@dispatch(object, object)