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.

Sign up for GitHub

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

Jump to bottom

feat: omit TestClient from pytest's test discovery #694

Merged
merged 1 commit into from
Jan 25, 2025
Merged

feat: omit TestClient from pytest's test discovery #694

merged 1 commit into from
Jan 25, 2025

Conversation

pbratkowski
Copy link
Contributor

@pbratkowski pbratkowski commented Jan 20, 2025 •
edited by sourcery-ai bot
Loading

Description

pytest's test discovery treats the strawberry_django.test.client.TestClient class as a test class, and raises a warning similar to:

/app/.venv/lib/python3.13/site-packages/strawberry_django/test/client.py:16:
    PytestCollectionWarning: cannot collect test class 'TestClient' because it has a __init__ constructor

This PR adds the attribute __test__ = False, which prevents test discovery within the class, and suppresses the warning.

Source

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Enhancements:

  • Prevent pytest from treating TestClient as a test class by setting test = False.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Jan 20, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

The pull request adds the attribute test = False to the TestClient class in strawberry_django/test/client.py to prevent pytest from mistakenly identifying it as a test class, thereby suppressing related warnings during test discovery.

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

File-Level Changes

Change Details Files
Prevent pytest from treating TestClient as a test class by adding a special attribute.
  • Added the attribute test = False to the TestClient class to prevent pytest from collecting it as a test class.
 strawberry_django/test/client.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

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 20, 2025
View reviewed changes
Copy link
Contributor

@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 @pbratkowski - 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.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.05%. Comparing base (1079fa6) to head (5113d3c).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #694   +/-   ##
=======================================
  Coverage   89.05%   89.05%           
=======================================
  Files          42       42           
  Lines        3836     3837    +1     
=======================================
+ Hits         3416     3417    +1     
  Misses        420      420

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

bellini666
bellini666 approved these changes Jan 25, 2025
View reviewed changes
Copy link
Member

@bellini666 bellini666 left a comment

Choose a reason for hiding this comment

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

Thank you!

@bellini666 bellini666 merged commit 4fbad27 into strawberry-graphql:main Jan 25, 2025
28 checks passed
@pbratkowski pbratkowski deleted the feat/suppress-test-warning branch January 25, 2025 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@bellini666 bellini666 bellini666 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pbratkowski @codecov-commenter @bellini666