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

Fix deprecated usage of pytest #235

Merged
merged 3 commits into from
Feb 25, 2024
Merged

Fix deprecated usage of pytest #235

merged 3 commits into from
Feb 25, 2024

Conversation

aisk
Copy link
Member

@aisk aisk commented Feb 25, 2024

Details:

About the change in the test_rpc.py, see the comment below.

Summary by CodeRabbit

Summary by CodeRabbit

  • Tests
    • Standardized method names for setup and teardown operations in test classes.
    • Removed a deprecated warning in the test_client_timeout function related to client instantiation.

Copy link

coderabbitai bot commented Feb 25, 2024

Walkthrough

The update involves refining the naming convention for setup and teardown methods within a test class, aiming to enhance consistency and readability. These adjustments signify a shift towards a more standardized approach in managing test preparations and conclusions. Additionally, a modification in test_rpc.py removes a deprecated warning related to client instantiation with a timeout value.

Changes

File Path Changes
tests/test_aio.py Renamed setup to setup_method, and teardown_ to teardown_method in TestDeprecatedTimeoutKwarg class.
tests/test_rpc.py Modified test_client_timeout function to address a deprecated warning in client instantiation.

🐇✨
In the realm of code, where tests quietly lay,
A rabbit hopped through, making changes today.
"Setup to setup_method, teardown_ shall mend,
For consistency's sake, until the very end."
With each hop and leap, the code did transform,
In the tests' quiet world, now more uniform. 🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5784039 and 4dfee14.
Files selected for processing (1)
  • tests/test_aio.py (1 hunks)
Additional comments: 2
tests/test_aio.py (2)
  • 319-319: The method setup_method correctly follows pytest's updated naming conventions for setup operations in test classes. This change ensures compatibility with the latest versions of pytest and improves the clarity of the test code.
  • 326-326: The method teardown_method has been correctly renamed to align with pytest's updated naming conventions for teardown operations in test classes. This adjustment enhances the maintainability of the test suite by adhering to standardized practices.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4dfee14 and 5bbab1d.
Files selected for processing (2)
  • tests/test_aio.py (2 hunks)
  • tests/test_rpc.py (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tests/test_aio.py
Additional comments: 1
tests/test_rpc.py (1)
  • 253-254: The modification to the test_client_timeout function, specifically changing the timeout value, is a straightforward approach to address the deprecated warning related to client instantiation with a timeout. This change ensures that the test aligns with the intended behavior of testing client timeout functionality. However, it's crucial to verify that this adjustment does not inadvertently affect other tests or the overall test suite's reliability.

@@ -250,9 +250,8 @@ def test_exception_iwth_ssl():

def test_client_timeout():
with pytest.raises(socket.timeout):
with pytest.warns(UserWarning): # Deprecated
Copy link
Member Author

Choose a reason for hiding this comment

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

This UserWarning is never been raised, but the older version of pytest will ignore the failure when it't in a with pytest.raises(...) context.

So we should just remove it.

@aisk
Copy link
Member Author

aisk commented Feb 25, 2024

Since this is a trival change which keeps the CI healthy, I'll merge it after the CI passed. cc @ethe

@aisk aisk merged commit ad0d38e into Thriftpy:master Feb 25, 2024
8 checks passed
@aisk aisk deleted the fix-pytest branch February 25, 2024 10:53
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