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.

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

TST: Disallow bare tm.assert_produces_warning #58290

Open
Aloqeely opened this issue Apr 17, 2024 · 0 comments
Open

TST: Disallow bare tm.assert_produces_warning #58290

Aloqeely opened this issue Apr 17, 2024 · 0 comments
Labels
Testing pandas testing functions or related to the test suite Warnings Warnings that appear or should be added to pandas

Comments

@Aloqeely
Copy link
Contributor

Aloqeely commented Apr 17, 2024

Our tests currently ensure that warnings are triggered whenever appropriate, but to ensure end users get a correct and meaningful warning message, we should also make sure the correct warning message is surfaced whenever we check for a warning.

And so I propose we start enforcing the usage of the match argument in all uses of tm.assert_produces_warning.

Using the regex assert_produces_warning\([a-zA-Z]*\), I was able to find around 200 bare uses of assert_produces_warning, and some of them are checking that warnings are not raised, so this will be an easy task to finish and would be a good way for new contributors to get familiar with the pandas codebase.

If all agree, then we can open a new issue which would have instructions for how to find the bare uses, and maybe we can enforce this using our linter. We could also implement a method tm.external_warning_produced similiar to tm.external_error_raised, which would be equivalent to using tm.assert_produces_warning(warning, match=None)

See also #23922, #30999 and #37261.

@mroeschke mroeschke added Testing pandas testing functions or related to the test suite Warnings Warnings that appear or should be added to pandas labels Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Testing pandas testing functions or related to the test suite Warnings Warnings that appear or should be added to pandas
Projects
None yet
Development

No branches or pull requests

2 participants