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: fix testing for no user warning #161

Merged
merged 2 commits into from
Nov 21, 2024
Merged

TST: fix testing for no user warning #161

merged 2 commits into from
Nov 21, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Nov 21, 2024

We tested with with pytest.warns(None) that no user warning is raised, which was wrong and also raises an error since pytest > 7.0. As stated in the pytest documentation, one should use

with warnings.catch_warnings():
    warnings.simplefilter("error")
    ...

to check that no warning is raised.

I updated the code accordingly.

Summary by Sourcery

Bug Fixes:

  • Fix testing for no user warning by replacing 'pytest.warns(None)' with 'warnings.catch_warnings()' and 'warnings.simplefilter("error")' to comply with pytest > 7.0.

Copy link

sourcery-ai bot commented Nov 21, 2024

Reviewer's Guide by Sourcery

The PR updates the testing approach for checking absence of warnings in pytest tests. It replaces the deprecated pytest.warns(None) with the recommended warnings.catch_warnings() and warnings.simplefilter("error") pattern.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update warning assertion pattern in test code
  • Replace deprecated pytest.warns(None) with warnings.catch_warnings()
  • Add warnings.simplefilter('error') to ensure no warnings are raised
  • Maintain existing test logic for checking function calls with different parameter values
tests/test_utils.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@hagenw hagenw merged commit 3959b41 into main Nov 21, 2024
19 checks passed
@hagenw hagenw deleted the fix-test branch November 21, 2024 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant