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

(chore) fastapi: test typing #3782

Merged

Conversation

alexey-pelykh
Copy link
Contributor

@alexey-pelykh alexey-pelykh commented Feb 13, 2025

Description

Add tests to ensure that GraphQLRouter for FastAPI is typed correctly

Types of Changes

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

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

Tests:

  • Add tests to ensure the GraphQLRouter for FastAPI is correctly typed using both pyright and mypy.

Copy link
Contributor

sourcery-ai bot commented Feb 13, 2025

Reviewer's Guide by Sourcery

This pull request introduces type-checking tests for the FastAPI GraphQLRouter to ensure that its type definitions, especially when using both synchronous and asynchronous context getters, are correctly inferred by type checkers like pyright and mypy.

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

File-Level Changes

Change Details Files
Added type-checking tests for GraphQLRouter using a synchronous context getter.
  • Defined a test snippet (CODE_ROUTER_WITH_CONTEXT) that creates a GraphQLRouter with a synchronous context getter.
  • Implemented the test function test_router_with_context to assert type information using inline snapshots.
  • Verified that pyright and mypy output match the expected snapshot results.
tests/typecheckers/test_fastapi.py
Added type-checking tests for GraphQLRouter using an asynchronous context getter.
  • Defined a separate test snippet (CODE_ROUTER_WITH_ASYNC_CONTEXT) to create a GraphQLRouter with an async context getter.
  • Implemented the test function test_router_with_async_context with assertions against expected inline snapshot outputs.
  • Ensured consistent type revelation results for both pyright and mypy.
tests/typecheckers/test_fastapi.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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
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 @alexey-pelykh - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a test case that uses graphiql=False to ensure that the typing is correct when graphiql is disabled.
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.

@alexey-pelykh
Copy link
Contributor Author

@bellini666 to give you more context: with #3763 merged, neither mypy nor pyright is able to infer the Context typevar, thus it has to be specified explicitly. I assumed that I've messed up with typing, so #3781 was a panic-mode attempt to fix the bug that isn't there - however apparently there's no fix, inferring just won't happen so at least I'll add a test :)

Copy link

codspeed-hq bot commented Feb 13, 2025

CodSpeed Performance Report

Merging #3782 will not alter performance

Comparing alexey-pelykh:chore/fastapi/test-typing (e1e3986) with main (4c4e07b)

Summary

✅ 21 untouched benchmarks

Copy link
Member

@patrick91 patrick91 left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks! 😊

@patrick91 patrick91 merged commit 03d8aca into strawberry-graphql:main Feb 13, 2025
166 checks passed
@alexey-pelykh alexey-pelykh deleted the chore/fastapi/test-typing branch February 13, 2025 11:08
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.

2 participants