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

depr(python): Deprecate nans_compare_equal parameter in assert utils #12019

Merged
merged 2 commits into from
Oct 26, 2023
Merged

depr(python): Deprecate nans_compare_equal parameter in assert utils #12019

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
73bb90f
Update signature
stinodego Oct 25, 2023
46c405a
Update tests
stinodego Oct 25, 2023
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
30 changes: 24 additions & 6 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 @@ -7,6 +7,7 @@
from polars.lazyframe import LazyFrame
from polars.testing.asserts.series import _assert_series_values_equal
from polars.testing.asserts.utils import raise_assertion_error
from polars.utils.deprecation import issue_deprecation_warning


def assert_frame_equal(
Expand All @@ -19,8 +20,8 @@ def assert_frame_equal(
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
nans_compare_equal: bool = True,
categorical_as_str: bool = False,
nans_compare_equal: bool | None = None,
) -> None:
"""
Assert that the left and right frame are equal.
Expand Down Expand Up @@ -52,11 +53,15 @@ def assert_frame_equal(
Relative tolerance for inexact checking. Fraction of values in ``right``.
atol
Absolute tolerance for inexact checking.
nans_compare_equal
Consider NaN values to be equal.
categorical_as_str
Cast categorical columns to string before comparing. Enabling this helps
compare columns that do not share the same string cache.
nans_compare_equal
Consider NaN values to be equal.

.. deprecated: 0.19.12
This parameter will be removed. Default behaviour will remain as though it
were set to ``True``.

See Also
--------
Expand Down Expand Up @@ -89,6 +94,15 @@ def assert_frame_equal(
AssertionError: values for column 'a' are different

"""
if nans_compare_equal is not None:
issue_deprecation_warning(
"The `nans_compare_equal` parameter for `assert_frame_equal` is deprecated."
" Default behaviour will remain as though it were set to `True`.",
version="0.19.12",
)
else:
nans_compare_equal = True

lazy = _assert_correct_input_type(left, right)
objects = "LazyFrames" if lazy else "DataFrames"

Expand Down Expand Up @@ -202,8 +216,8 @@ def assert_frame_not_equal(
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
nans_compare_equal: bool = True,
categorical_as_str: bool = False,
nans_compare_equal: bool | None = None,
) -> None:
"""
Assert that the left and right frame are **not** equal.
Expand Down Expand Up @@ -234,11 +248,15 @@ def assert_frame_not_equal(
Relative tolerance for inexact checking. Fraction of values in ``right``.
atol
Absolute tolerance for inexact checking.
nans_compare_equal
Consider NaN values to be equal.
categorical_as_str
Cast categorical columns to string before comparing. Enabling this helps
compare columns that do not share the same string cache.
nans_compare_equal
Consider NaN values to be equal.

.. deprecated: 0.19.12
This parameter will be removed. Default behaviour will remain as though it
were set to ``True``.

See Also
--------
Expand Down
30 changes: 24 additions & 6 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 @@ -18,6 +18,7 @@
from polars.exceptions import ComputeError
from polars.series import Series
from polars.testing.asserts.utils import raise_assertion_error
from polars.utils.deprecation import issue_deprecation_warning

if TYPE_CHECKING:
from polars.type_aliases import PolarsDataType
Expand All @@ -32,8 +33,8 @@ def assert_series_equal(
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
nans_compare_equal: bool = True,
categorical_as_str: bool = False,
nans_compare_equal: bool | None = None,
) -> None:
"""
Assert that the left and right Series are equal.
Expand All @@ -60,11 +61,15 @@ def assert_series_equal(
``right``.
atol
Absolute tolerance for inexact checking.
nans_compare_equal
Consider NaN values to be equal.
categorical_as_str
Cast categorical columns to string before comparing. Enabling this helps
compare columns that do not share the same string cache.
nans_compare_equal
Consider NaN values to be equal.

.. deprecated: 0.19.12
This parameter will be removed. Default behaviour will remain as though it
were set to ``True``.

See Also
--------
Expand All @@ -91,6 +96,15 @@ def assert_series_equal(
[right]: [1, 5, 3]

"""
if nans_compare_equal is not None:
issue_deprecation_warning(
"The `nans_compare_equal` parameter for `assert_frame_equal` is deprecated."
" Default behaviour will remain as though it were set to `True`.",
version="0.19.12",
)
else:
nans_compare_equal = True

if not (isinstance(left, Series) and isinstance(right, Series)): # type: ignore[redundant-expr]
raise_assertion_error(
"inputs",
Expand Down Expand Up @@ -347,8 +361,8 @@ def assert_series_not_equal(
check_exact: bool = False,
rtol: float = 1e-5,
atol: float = 1e-8,
nans_compare_equal: bool = True,
categorical_as_str: bool = False,
nans_compare_equal: bool | None = None,
) -> None:
"""
Assert that the left and right Series are **not** equal.
Expand All @@ -374,11 +388,15 @@ def assert_series_not_equal(
``right``.
atol
Absolute tolerance for inexact checking.
nans_compare_equal
Consider NaN values to be equal.
categorical_as_str
Cast categorical columns to string before comparing. Enabling this helps
compare columns that do not share the same string cache.
nans_compare_equal
Consider NaN values to be equal.

.. deprecated: 0.19.12
This parameter will be removed. Default behaviour will remain as though it
were set to ``True``.

See Also
--------
Expand Down
4 changes: 2 additions & 2 deletions py-polars/tests/unit/test_constructors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ def test_init_ndarray(monkeypatch: Any) -> None:
data={"x": np.array([1.0, 2.5, np.nan]), "y": np.array([4.0, np.nan, 6.5])},
nan_to_null=True,
)
assert_frame_equal(df0, df1, nans_compare_equal=True)
assert_frame_equal(df0, df1)
assert df2.rows() == [(1.0, 4.0), (2.5, None), (None, 6.5)]


Expand Down Expand Up @@ -714,7 +714,7 @@ def test_init_series() -> None:
s1 = pl.Series("n", np.array([1.0, 2.5, float("nan")]))
s2 = pl.Series("n", np.array([1.0, 2.5, float("nan")]), nan_to_null=True)

assert_series_equal(s0, s1, nans_compare_equal=True)
assert_series_equal(s0, s1)
assert s2.to_list() == [1.0, 2.5, None]


Expand Down
156 changes: 95 additions & 61 deletions py-polars/tests/unit/testing/test_assert_frame_equal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
from polars.exceptions import InvalidAssert
from polars.testing import assert_frame_equal, assert_frame_not_equal

nan = float("NaN")


@pytest.mark.parametrize(
("df1", "df2", "kwargs"),
Expand Down Expand Up @@ -103,23 +105,11 @@
{"rtol": 1},
id="list_of_none_and_float_integer_rtol",
),
pytest.param(
pl.DataFrame({"a": [[None, 1.3]]}),
pl.DataFrame({"a": [[None, 0.9]]}),
{"rtol": 1, "nans_compare_equal": False},
id="list_of_none_and_float_integer_rtol",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, 3.00000001]]]}),
{"atol": 0.1, "nans_compare_equal": True},
id="nested_list_of_float_atol_high_nans_compare_equal_true",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, 3.00000001]]]}),
{"atol": 0.1, "nans_compare_equal": False},
id="nested_list_of_float_atol_high_nans_compare_equal_false",
{"atol": 0.1},
id="nested_list_of_float_atol_high",
),
],
)
Expand Down Expand Up @@ -160,12 +150,6 @@ def test_assert_frame_equal_passes_assertion(
{"atol": -1, "rtol": 0},
id="list_of_float_negative_atol",
),
pytest.param(
pl.DataFrame({"a": [[math.nan, 1.3]]}),
pl.DataFrame({"a": [[math.nan, 0.9]]}),
{"rtol": 1, "nans_compare_equal": False},
id="list_of_nan_and_float_integer_rtol",
),
pytest.param(
pl.DataFrame({"a": [[2.0, 3.0]]}),
pl.DataFrame({"a": [[2, 3]]}),
Expand All @@ -175,50 +159,20 @@ def test_assert_frame_equal_passes_assertion(
pytest.param(
pl.DataFrame({"a": [[[0.2, math.nan, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, math.nan, 3.11]]]}),
{"atol": 0.1, "rtol": 0, "nans_compare_equal": True},
id="nested_list_of_float_and_nan_atol_high_nans_compare_equal_true",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, math.nan, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, math.nan, 3.0]]]}),
{"nans_compare_equal": False},
id="nested_list_of_float_and_nan_atol_high_nans_compare_equal_false",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, 3.11]]]}),
{"atol": 0.1, "nans_compare_equal": False},
id="nested_list_of_float_atol_high_nans_compare_equal_false",
{"atol": 0.1, "rtol": 0},
id="nested_list_of_float_and_nan_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[[0.2, 3.0]]]]}),
pl.DataFrame({"a": [[[[0.2, 3.11]]]]}),
{"atol": 0.1, "rtol": 0, "nans_compare_equal": True},
id="double_nested_list_of_float_atol_high_nans_compare_equal_true",
),
pytest.param(
pl.DataFrame({"a": [[[[0.2, math.nan, 3.0]]]]}),
pl.DataFrame({"a": [[[[0.2, math.nan, 3.0]]]]}),
{"atol": 0.1, "nans_compare_equal": False},
id="double_nested_list_of_float_and_nan_atol_high_nans_compare_equal_false",
),
pytest.param(
pl.DataFrame({"a": [[[[0.2, 3.0]]]]}),
pl.DataFrame({"a": [[[[0.2, 3.11]]]]}),
{"atol": 0.1, "rtol": 0, "nans_compare_equal": False},
id="double_nested_list_of_float_atol_high_nans_compare_equal_false",
{"atol": 0.1, "rtol": 0},
id="double_nested_list_of_float_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[[[0.2, 3.0]]]]]}),
pl.DataFrame({"a": [[[[[0.2, 3.11]]]]]}),
{"atol": 0.1, "rtol": 0, "nans_compare_equal": True},
id="triple_nested_list_of_float_atol_high_nans_compare_equal_true",
),
pytest.param(
pl.DataFrame({"a": [[[[[0.2, math.nan, 3.0]]]]]}),
pl.DataFrame({"a": [[[[[0.2, math.nan, 3.0]]]]]}),
{"atol": 0.1, "nans_compare_equal": False},
id="triple_nested_list_of_float_and_nan_atol_high_nans_compare_equal_true",
{"atol": 0.1, "rtol": 0},
id="triple_nested_list_of_float_atol_high",
),
],
)
Expand All @@ -233,7 +187,6 @@ def test_assert_frame_equal_raises_assertion_error(


def test_compare_frame_equal_nans() -> None:
nan = float("NaN")
df1 = pl.DataFrame(
data={"x": [1.0, nan], "y": [nan, 2.0]},
schema=[("x", pl.Float32), ("y", pl.Float64)],
Expand All @@ -250,8 +203,6 @@ def test_compare_frame_equal_nans() -> None:


def test_compare_frame_equal_nested_nans() -> None:
nan = float("NaN")

# list dtype
df1 = pl.DataFrame(
data={"x": [[1.0, nan]], "y": [[nan, 2.0]]},
Expand Down Expand Up @@ -306,10 +257,13 @@ def test_compare_frame_equal_nested_nans() -> None:
)

assert_frame_equal(df3, df3)
assert_frame_not_equal(df3, df3, nans_compare_equal=False)
with pytest.deprecated_call():
assert_frame_not_equal(df3, df3, nans_compare_equal=False)

assert_frame_equal(df4, df4)
assert_frame_not_equal(df4, df4, nans_compare_equal=False)

with pytest.deprecated_call():
assert_frame_not_equal(df4, df4, nans_compare_equal=False)

assert_frame_not_equal(df3, df4)
for check_dtype in (True, False):
Expand Down Expand Up @@ -418,3 +372,83 @@ def test_assert_frame_not_equal() -> None:
df = pl.DataFrame({"a": [1, 2]})
with pytest.raises(AssertionError, match="frames are equal"):
assert_frame_not_equal(df, df)


@pytest.mark.parametrize(
("df1", "df2", "kwargs"),
[
pytest.param(
pl.DataFrame({"a": [[None, 1.3]]}),
pl.DataFrame({"a": [[None, 0.9]]}),
{"rtol": 1},
id="list_of_none_and_float_integer_rtol",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, 3.00000001]]]}),
{"atol": 0.1},
id="nested_list_of_float_atol_high_nans_compare_equal_false",
),
],
)
def test_assert_frame_equal_passes_assertion_deprecated_nans_compare_equal_false(
df1: pl.DataFrame,
df2: pl.DataFrame,
kwargs: dict[str, Any],
) -> None:
with pytest.deprecated_call():
assert_frame_equal(df1, df2, nans_compare_equal=False, **kwargs)
with pytest.raises(AssertionError), pytest.deprecated_call():
assert_frame_not_equal(df1, df2, nans_compare_equal=False, **kwargs)


@pytest.mark.parametrize(
("df1", "df2", "kwargs"),
[
pytest.param(
pl.DataFrame({"a": [[math.nan, 1.3]]}),
pl.DataFrame({"a": [[math.nan, 0.9]]}),
{"rtol": 1},
id="list_of_nan_and_float_integer_rtol",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, math.nan, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, math.nan, 3.0]]]}),
{},
id="nested_list_of_float_and_nan_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[0.2, 3.0]]]}),
pl.DataFrame({"a": [[[0.2, 3.11]]]}),
{"atol": 0.1},
id="nested_list_of_float_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[[0.2, math.nan, 3.0]]]]}),
pl.DataFrame({"a": [[[[0.2, math.nan, 3.0]]]]}),
{"atol": 0.1},
id="double_nested_list_of_float_and_nan_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[[0.2, 3.0]]]]}),
pl.DataFrame({"a": [[[[0.2, 3.11]]]]}),
{"atol": 0.1, "rtol": 0},
id="double_nested_list_of_float_atol_high",
),
pytest.param(
pl.DataFrame({"a": [[[[[0.2, math.nan, 3.0]]]]]}),
pl.DataFrame({"a": [[[[[0.2, math.nan, 3.0]]]]]}),
{"atol": 0.1},
id="triple_nested_list_of_float_and_nan_atol_high",
),
],
)
def test_assert_frame_equal_raises_assertion_error_deprecated_nans_compare_equal_false(
df1: pl.DataFrame,
df2: pl.DataFrame,
kwargs: dict[str, Any],
) -> None:
with pytest.raises(AssertionError), pytest.deprecated_call():
assert_frame_equal(df1, df2, nans_compare_equal=False, **kwargs)
with pytest.deprecated_call():
assert_frame_not_equal(df1, df2, nans_compare_equal=False, **kwargs)
Loading