Check that left and right Index are equal.
Whether to check the Index class, dtype and inferred_type
are identical. If ‘equiv’, then RangeIndex can be substituted for
Int64Index as well.
Whether to check the names attribute.
Specify comparison precision. Only used when check_exact is False.
5 digits (False) or 3 digits (True) after decimal points are compared.
If int, then specify the digits to compare.
Deprecated since version 1.1.0: Use rtol and atol instead to define relative/absolute
tolerance, respectively. Similar to math.isclose().
Whether to compare number exactly.
Whether to compare internal Categorical exactly.
Whether to compare the order of index entries as well as their values.
If True, both indexes must contain the same elements, in the same order.
If False, both indexes must contain the same elements, but in any order.
New in version 1.2.0.
Relative tolerance. Only used when check_exact is False.
New in version 1.1.0.
Absolute tolerance. Only used when check_exact is False.
Specify object name being compared, internally used to show appropriate
>>> from pandas.testing import assert_index_equal
>>> a = pd.Index([1, 2, 3])
>>> b = pd.Index([1, 2, 3])
>>> assert_index_equal(a, b)