polars.testing.assert_series_equal

polars.testing.assert_series_equal(
    left: Series,
    right: Series,
    *,
    check_dtypes: bool = True,
    check_names: bool = True,
    check_order: bool = True,
    check_exact: bool = False,
    rel_tol: float = 1e-05,
    abs_tol: float = 1e-08,
    categorical_as_str: bool = False,
) → None

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

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

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

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

Параметры:

left

Первая Series для сравнения.

right

Вторая Series для сравнения.

check_dtypes

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

check_names

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

check_order

Требует одинакового порядка элементов.

check_exact

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

rel_tol

Относительная погрешность при проверке с допуском, задаётся как доля значений в right.

abs_tol

Абсолютная погрешность при проверке с допуском.

categorical_as_str

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

См. также

assert_frame_equal

assert_series_not_equal

Примечания

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

Примеры

>>> from polars.testing import assert_series_equal
>>> s1 = pl.Series([1, 2, 3])
>>> s2 = pl.Series([1, 5, 3])
>>> assert_series_equal(s1, s2)
Traceback (most recent call last):
...
AssertionError: Series are different (exact value mismatch)
[left]: shape: (3,)
Series: '' [i64]
[
    1
    2
    3
]
[right]: shape: (3,)
Series: '' [i64]
[
    1
    5
    3
]