pandas.testing.assert_index_equal

pandas.testing.assert_index_equal(left, right, exact='equiv', check_names=True, check_exact=True, check_categorical=True, check_order=True, rtol=1e-05, atol=1e-08, obj='Index')[source]

Check that left and right Index are equal.

Parameters:

left:Index

right:Index

exact:bool or {‘equiv’}, default ‘equiv’

Whether to check the Index class, dtype and inferred_type are identical. If ‘equiv’, then RangeIndex can be substituted for Index with an int64 dtype as well.

check_names:bool, default True

Whether to check the names attribute.

check_exact:bool, default True

Whether to compare number exactly.

check_categorical:bool, default True

Whether to compare internal Categorical exactly.

check_order:bool, default True

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.

rtol:float, default 1e-5

Relative tolerance. Only used when check_exact is False.

atol:float, default 1e-8

Absolute tolerance. Only used when check_exact is False.

obj:str, default ‘Index’

Specify object name being compared, internally used to show appropriate assertion message.

Examples

>>> from pandas import testing as tm
>>> a = pd.Index([1, 2, 3])
>>> b = pd.Index([1, 2, 3])
>>> tm.assert_index_equal(a, b)