Skip to content
New issue

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

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

Already on GitHub? # to your account

Catch a known DeprecationWarning when calling .close() #3335

Merged

Conversation

kurtmckee
Copy link
Contributor

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

When running the test suite, an expected DeprecationWarning is not caught. Recent example:

tests/test_asyncio/test_cluster.py::TestRedisClusterObj::test_close_is_aclose
  /home/runner/work/redis-py/redis-py/tests/test_asyncio/test_cluster.py:316: DeprecationWarning: Call to deprecated close. (Use aclose() instead) -- Deprecated since version 5.0.0.
    await cluster.close()

As this is expected behavior, this PR adds a pytest.warns() context manager to verify that this warning is issued and has an expected message.

@kurtmckee
Copy link
Contributor Author

Hello @gerzse and @vladvildanov! Please review this PR when you can. It's part of my effort to get CI tests to pass cleanly.

@vladvildanov vladvildanov merged commit b4fcbaa into redis:master Sep 2, 2024
56 checks passed
@kurtmckee kurtmckee deleted the catch-close-aclose-deprecation-warning branch September 2, 2024 12:40
vladvildanov added a commit that referenced this pull request Sep 27, 2024
Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
vladvildanov added a commit that referenced this pull request Sep 27, 2024
Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
vladvildanov added a commit that referenced this pull request Sep 27, 2024
Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants