DataFrameComparison.equal

DataFrameComparison.equal(*, check_dtypes: bool = True) → bool

Whether the data frames are equal, independent of row and column order.

Parameters:

check_dtypes – Whether to check that the data types of columns match exactly.

Examples

>>> import polars as pl
>>> from diffly import compare_frames
>>> left = pl.DataFrame({"id": [1, 2], "value": [10, 20]})
>>> right = pl.DataFrame({"id": [1, 2], "value": [10, 20]})
>>> compare_frames(left, right, primary_key="id").equal()
True

When data types differ, equal() returns False but equal(check_dtypes=False) may return True:

>>> right_float = pl.DataFrame({"id": [1, 2], "value": [10.0, 20.0]})
>>> comparison = compare_frames(left, right_float, primary_key="id")
>>> comparison.equal()
False
>>> comparison.equal(check_dtypes=False)
True