polars.testing.assert_frame_equal

polars.testing.assert_frame_equal(
    left: DataFrame | LazyFrame,
    right: DataFrame | LazyFrame,
    *,
    check_row_order: bool = True,
    check_column_order: bool = True,
    check_dtypes: bool = True,
    check_exact: bool = False,
    rel_tol: float = 1e-05,
    abs_tol: float = 1e-08,
    categorical_as_str: bool = False,
) → None

Проверяет, что левый и правый фреймы равны.

Вызывает подробное AssertionError, если фреймы различаются. Эта функция предназначена для использования в модульных тестах.

Изменено в версии 0.20.31: Параметр check_dtype был переименован в check_dtypes.

Изменено в версии 1.32.3: Параметры rtol и atol были переименованы соответственно в rel_tol и abs_tol.

Параметры:

left

Первый DataFrame или LazyFrame для сравнения.

right

Второй DataFrame или LazyFrame для сравнения.

check_row_order

Требует совпадения порядка строк.

check_column_order

Требует совпадения порядка столбцов.

check_dtypes

Требует совпадения типов данных.

check_exact

Требует точного совпадения значений с плавающей точкой. Если задано False, значения считаются равными, когда их разница не превышает допустимое отклонение (см. rel_tol и abs_tol). Применяется только к столбцам с типом данных Float.

rel_tol

Относительное допустимое отклонение при проверке с неточным сравнением. Доля значений в right.

abs_tol

Абсолютное допустимое отклонение при проверке с неточным сравнением.

categorical_as_str

Преобразует категориальные столбцы в строки перед сравнением. Это позволяет сравнивать столбцы, категории которых различаются.

См. также

assert_series_equal

assert_frame_not_equal

Примечания

При использовании pytest может быть полезно сократить вывод трассировки Python, передав --tb=short. Режим по умолчанию обычно выводит излишне подробную информацию. Дополнительные сведения приведены в документации pytest.

Примеры

>>> from polars.testing import assert_frame_equal
>>> df1 = pl.DataFrame({"a": [1, 2, 3]})
>>> df2 = pl.DataFrame({"a": [1, 5, 3]})
>>> assert_frame_equal(df1, df2)
Traceback (most recent call last):
...
AssertionError: DataFrames are different (value mismatch for column "a")
[left]: shape: (3,)
Series: 'a' [i64]
[
    1
    2
    3
]
[right]: shape: (3,)
Series: 'a' [i64]
[
    1
    5
    3
]