Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(python): Add check_order parameter to assert_series_equal #16778

Merged
merged 2 commits into from
Jun 6, 2024
Merged

feat(python): Add check_order parameter to assert_series_equal #16778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0de0670
Add check_order param to assert_series_equal
stinodego Jun 6, 2024
932720f
Add parametric test
stinodego Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions py-polars/polars/testing/asserts/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ def assert_frame_equal(
The second DataFrame or LazyFrame to compare.
check_row_order
Require row order to match.

.. note::
Setting this to `False` requires sorting the data, which will fail on
frames that contain unsortable columns.
check_column_order
Require column order to match.
check_dtypes
Expand Down Expand Up @@ -118,6 +114,7 @@ def assert_frame_equal(
_assert_series_values_equal(
s_left,
s_right,
check_order=True,
check_exact=check_exact,
rtol=rtol,
atol=atol,
Expand Down Expand Up @@ -227,10 +224,6 @@ def assert_frame_not_equal(
The second DataFrame or LazyFrame to compare.
check_row_order
Require row order to match.

.. note::
Setting this to `False` requires sorting the data, which will fail on
frames that contain unsortable columns.
check_column_order
Require column order to match.
check_dtypes
Expand Down
15 changes: 15 additions & 0 deletions py-polars/polars/testing/asserts/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ def assert_series_equal(
*,
check_dtypes: bool = True,
check_names: bool = True,
check_order: bool = True,
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
Expand All @@ -48,6 +49,8 @@ def assert_series_equal(
Require data types to match.
check_names
Require names to match.
check_order
Require elements to appear in the same order.
check_exact
Require float values to match exactly. If set to `False`, values are considered
equal when within tolerance of each other (see `rtol` and `atol`).
Expand Down Expand Up @@ -107,6 +110,7 @@ def assert_series_equal(
_assert_series_values_equal(
left,
right,
check_order=check_order,
check_exact=check_exact,
rtol=rtol,
atol=atol,
Expand All @@ -118,6 +122,7 @@ def _assert_series_values_equal(
left: Series,
right: Series,
*,
check_order: bool,
check_exact: bool,
rtol: float,
atol: float,
Expand All @@ -131,6 +136,10 @@ def _assert_series_values_equal(
left = _categorical_series_to_string(left)
right = _categorical_series_to_string(right)

if not check_order:
left = left.sort()
right = right.sort()

# Determine unequal elements
try:
unequal = left.ne_missing(right)
Expand Down Expand Up @@ -206,6 +215,7 @@ def _assert_series_nested_values_equal(
_assert_series_values_equal(
s1,
s2,
check_order=True,
check_exact=check_exact,
rtol=rtol,
atol=atol,
Expand All @@ -219,6 +229,7 @@ def _assert_series_nested_values_equal(
_assert_series_values_equal(
s1,
s2,
check_order=True,
check_exact=check_exact,
rtol=rtol,
atol=atol,
Expand Down Expand Up @@ -331,6 +342,7 @@ def assert_series_not_equal(
*,
check_dtypes: bool = True,
check_names: bool = True,
check_order: bool = True,
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
Expand All @@ -351,6 +363,8 @@ def assert_series_not_equal(
Require data types to match.
check_names
Require names to match.
check_order
Require elements to appear in the same order.
check_exact
Require float values to match exactly. If set to `False`, values are considered
equal when within tolerance of each other (see `rtol` and `atol`).
Expand Down Expand Up @@ -387,6 +401,7 @@ def assert_series_not_equal(
right=right,
check_dtypes=check_dtypes,
check_names=check_names,
check_order=check_order,
check_exact=check_exact,
rtol=rtol,
atol=atol,
Expand Down
16 changes: 16 additions & 0 deletions py-polars/tests/unit/testing/test_assert_series_equal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,21 @@
from typing import Any

import pytest
from hypothesis import given

import polars as pl
from polars.testing import assert_series_equal, assert_series_not_equal
from polars.testing.parametric import series

nan = float("nan")
pytest_plugins = ["pytester"]


@given(s=series())
def test_assert_series_equal_parametric(s: pl.Series) -> None:
assert_series_equal(s, s)


def test_compare_series_value_mismatch() -> None:
srs1 = pl.Series([1, 2, 3])
srs2 = pl.Series([2, 3, 4])
Expand All @@ -34,6 +41,15 @@ def test_compare_series_empty_equal() -> None:
assert_series_not_equal(srs1, srs2)


def test_assert_series_equal_check_order() -> None:
srs1 = pl.Series([1, 2, 3, None])
srs2 = pl.Series([2, None, 3, 1])

assert_series_equal(srs1, srs2, check_order=False)
with pytest.raises(AssertionError):
assert_series_not_equal(srs1, srs2, check_order=False)


def test_compare_series_nans_assert_equal() -> None:
srs1 = pl.Series([1.0, 2.0, nan, 4.0, None, 6.0])
srs2 = pl.Series([1.0, nan, 3.0, 4.0, None, 6.0])
Expand Down