ENH: Add all warnings check to the assert_produces_warnings, and separate messages for each warning. #57222

Jorewin · 2024-02-03T05:30:15Z

The function in question gets used in multiple places, that's why I felt it would be safer to preserve current behavior and API, and add an additional, optional parameter, which alters the behavior, enabling checking if all passed warning types get detected.

closes TST: assert_produces_warning multiple warnings/messages #56555 (Replace xxxx with the GitHub issue number)
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

…parate messages for each warning.

Jorewin · 2024-02-06T14:46:19Z

@rhshadrach Could you review this? Or direct me to someone who can? It's my first contribution here, so I don't know who to ask.

rhshadrach · 2024-02-07T03:48:15Z

I should be able to get to this tomorrow.

rhshadrach

Thanks for the PR!

doc/source/whatsnew/v3.0.0.rst

pandas/_testing/_warnings.py

rhshadrach · 2024-02-07T21:58:19Z

pandas/_testing/_warnings.py

+        type must get encountered. Otherwise, even one expected warning
+        results in success.
+
+        .. versionadded:: 3.0.0


This function isn't in the documentation; this line can be removed.

rhshadrach · 2024-02-07T21:58:37Z

pandas/_testing/_warnings.py

-                    match=match,
-                    check_stacklevel=check_stacklevel,
-                )
+                if type(expected_warning) == tuple and must_find_all_warnings:


Should use isinstance here I think, hopefully making the cast below unnecessary.

Thank you, that helped to remove most of the casts.

pandas/_testing/_warnings.py

…y default

…new API of `assert_produces_warning`

# Conflicts: # pandas/tests/copy_view/test_chained_assignment_deprecation.py # pandas/tests/frame/methods/test_interpolate.py # pandas/tests/indexing/test_chaining_and_caching.py

Jorewin · 2024-02-19T21:25:08Z

@rhshadrach Could you take another look at this, when you have time? I addressed all change requests and resolved all merge conflicts. The docstring checks seem to still be failing, but it looks unrelated to the changes introduced in this PR.

# Conflicts: # pandas/tests/io/parser/common/test_inf.py

rhshadrach

This is looking nice!

rhshadrach · 2024-02-15T04:31:41Z

pandas/_testing/_warnings.py

+                            check_stacklevel=check_stacklevel,
+                        )
+                else:
+                    expected_warning = cast(type[Warning], expected_warning)


This can still be a tuple, no?

Yes, you're right. I believe this was originally done, to suppress _assert_caught_expected_warning not accepting tuples. I changed that and fixed some issues that arose because of that now.

rhshadrach · 2024-02-23T20:08:07Z

pandas/_testing/_warnings.py

+                    match = (
+                        match
+                        if isinstance(match, tuple)
+                        else tuple(match for i in range(len(expected_warning)))


nit: Use (match,) * len(expected_warning) instead.

…arnings

…le of warnings

Jorewin · 2024-02-27T20:25:41Z

@rhshadrach I just applied a patch that fixed the python 3.9 unit test not passing. With this, this should be ready for review.

rhshadrach

lgtm, @mroeschke - wouldn't mind a 2nd eye on this if you get the chance.

mroeschke

Could you add some tests to pandas/tests/util/test_assert_produces_warning.py? e.g. multiple warnings and matches, multiple warnings and maches don't match, etc

github-actions · 2024-03-30T00:05:20Z

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

rhshadrach · 2024-03-30T11:50:36Z

@Jorewin - are you interested in finishing this up? If not, I can add some tests to get it over the finish line.

Jorewin · 2024-04-02T13:34:27Z

@rhshadrach If you want to, then go ahead. I just didn't have much time lately.

…uces-warning-enh

rhshadrach · 2024-04-13T12:05:31Z

@mroeschke - tests added for various combinations. Let me know if you see any others to add.

mroeschke · 2024-04-14T19:18:33Z

Thanks @Jorewin and @rhshadrach

…rate messages for each warning. (pandas-dev#57222) * ENH: Add all warnings check to the `assert_produces_warnings`, and separate messages for each warning. * Fix typing errors * Fix typing errors * Remove unnecessary documentation * Change `assert_produces_warning behavior` to check for all warnings by default * Refactor typing * Fix tests expecting a Warning that is not raised * Adjust `raises_chained_assignment_error` and its dependencies to the new API of `assert_produces_warning` * Fix `_assert_caught_expected_warning` typing not including tuple of warnings * fixup! Refactor typing * fixup! Fix `_assert_caught_expected_warning` typing not including tuple of warnings * fixup! Fix `_assert_caught_expected_warning` typing not including tuple of warnings * Add tests --------- Co-authored-by: Richard Shadrach <[email protected]>

Jorewin added 3 commits February 3, 2024 06:27

ENH: Add all warnings check to the assert_produces_warnings, and se…

83a045b

…parate messages for each warning.

Fix typing errors

05bb67d

Fix typing errors

f404767

rhshadrach added Testing pandas testing functions or related to the test suite Warnings Warnings that appear or should be added to pandas labels Feb 4, 2024

rhshadrach requested changes Feb 7, 2024

View reviewed changes

Jorewin added 3 commits February 14, 2024 20:56

Remove unnecessary documentation

da262ca

Change assert_produces_warning behavior to check for all warnings b…

d47bf11

…y default

Refactor typing

9093962

Jorewin force-pushed the feature/assert-produces-warning-enh branch from b4d9fc0 to 9093962 Compare February 14, 2024 19:56

Fix tests expecting a Warning that is not raised

74b93de

Jorewin force-pushed the feature/assert-produces-warning-enh branch from 3523b7b to c6d6983 Compare February 19, 2024 18:46

Adjust raises_chained_assignment_error and its dependencies to the …

2242796

…new API of `assert_produces_warning`

Jorewin force-pushed the feature/assert-produces-warning-enh branch from c6d6983 to 2242796 Compare February 19, 2024 19:28

Merge branch 'main' into feature/assert-produces-warning-enh

b8151ee

# Conflicts: # pandas/tests/copy_view/test_chained_assignment_deprecation.py # pandas/tests/frame/methods/test_interpolate.py # pandas/tests/indexing/test_chaining_and_caching.py

Merge branch 'main' into feature/assert-produces-warning-enh

910cae6

# Conflicts: # pandas/tests/io/parser/common/test_inf.py

Jorewin requested a review from rhshadrach February 20, 2024 00:52

rhshadrach requested changes Feb 23, 2024

View reviewed changes

Jorewin added 4 commits February 24, 2024 01:47

Merge branch 'main' into feature/assert-produces-warning-enh

7331302

Fix _assert_caught_expected_warning typing not including tuple of w…

a3b18ab

…arnings

fixup! Refactor typing

e5020ca

fixup! Fix _assert_caught_expected_warning typing not including tup…

a21cfc9

…le of warnings

Jorewin requested a review from rhshadrach February 24, 2024 02:25

Jorewin added 2 commits February 27, 2024 18:34

Merge branch 'main' into feature/assert-produces-warning-enh

ea25602

fixup! Fix _assert_caught_expected_warning typing not including tup…

2fadce2

…le of warnings

rhshadrach approved these changes Feb 27, 2024

View reviewed changes

mroeschke reviewed Feb 28, 2024

View reviewed changes

github-actions bot added the Stale label Mar 30, 2024

rhshadrach removed the Stale label Mar 31, 2024

rhshadrach self-assigned this Mar 31, 2024

rhshadrach added 2 commits April 13, 2024 08:02

Add tests

d13e876

Merge remote-tracking branch 'upstream/main' into feature/assert-prod…

cb5bef6

…uces-warning-enh

mroeschke added this to the 3.0 milestone Apr 14, 2024

mroeschke approved these changes Apr 14, 2024

View reviewed changes

mroeschke merged commit d8c7e85 into pandas-dev:main Apr 14, 2024
46 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Add all warnings check to the assert_produces_warnings, and separate messages for each warning. #57222

ENH: Add all warnings check to the assert_produces_warnings, and separate messages for each warning. #57222

Jorewin commented Feb 3, 2024 •

edited

Loading

Jorewin commented Feb 6, 2024

rhshadrach commented Feb 7, 2024

rhshadrach left a comment

rhshadrach Feb 7, 2024

Jorewin Feb 14, 2024

rhshadrach Feb 7, 2024

Jorewin Feb 14, 2024

Jorewin commented Feb 19, 2024

rhshadrach left a comment

rhshadrach Feb 15, 2024

Jorewin Feb 24, 2024

rhshadrach Feb 23, 2024

Jorewin Feb 24, 2024

Jorewin commented Feb 27, 2024

rhshadrach left a comment

mroeschke left a comment

github-actions bot commented Mar 30, 2024

rhshadrach commented Mar 30, 2024

Jorewin commented Apr 2, 2024

rhshadrach commented Apr 13, 2024

mroeschke commented Apr 14, 2024

ENH: Add all warnings check to the assert_produces_warnings, and separate messages for each warning. #57222

ENH: Add all warnings check to the assert_produces_warnings, and separate messages for each warning. #57222

Conversation

Jorewin commented Feb 3, 2024 • edited Loading

Jorewin commented Feb 6, 2024

rhshadrach commented Feb 7, 2024

rhshadrach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jorewin commented Feb 19, 2024

rhshadrach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jorewin commented Feb 27, 2024

rhshadrach left a comment

Choose a reason for hiding this comment

mroeschke left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 30, 2024

rhshadrach commented Mar 30, 2024

Jorewin commented Apr 2, 2024

rhshadrach commented Apr 13, 2024

mroeschke commented Apr 14, 2024

Jorewin commented Feb 3, 2024 •

edited

Loading