Add support for type[strawberry.UNSET]

[alexey-pelykh]

Description

Support for type[strawberry.UNSET] in addition to strawberry.types.unset.UnsetType

Types of Changes

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

Issues Fixed or Closed by This PR

• Closes Explore if we can improve the typing for UNSET #1473
• Closes Add support for implicit UNSET as a type annotation #872 (potentially)

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

Add support for type[strawberry.UNSET] in annotations, expanding the ways to specify optional fields.

New Features:

• Allow using type[strawberry.UNSET] to indicate optional fields in type annotations.

Tests:

• Added tests to verify the behavior of optional fields with type[strawberry.UNSET].

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces support for type[strawberry.UNSET] in addition to strawberry.types.unset.UnsetType. This change allows developers to use type[strawberry.UNSET] when defining optional input types, providing more flexibility when defining input types.

Class diagram showing Point2D input type changes

classDiagram
    class Point2D {
        +float x
        +float y
        +Optional[str] | type[strawberry.UNSET] label
    }
    note for Point2D "Updated to support type[strawberry.UNSET]"

Loading

File-Level Changes

Change	Details	Files
Added support for type[strawberry.UNSET] when resolving optionals.	Modified the filter in create_optional to include x != type[UNSET].	strawberry/annotation.py
Added a test case for type[strawberry.UNSET].	Added test_optional_with_type_of_unset to verify that type[strawberry.UNSET] is correctly handled.	tests/types/resolving/test_optionals.py
Updated documentation to include type[strawberry.UNSET] as a valid type for optionals.	Updated the example to include `Optional[str]	type[strawberry.UNSET]`.
Added release notes.	Added a release note indicating the new feature.	tests/RELEASE.md

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @alexey-pelykh - 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[botberry]

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

---

This release adds support for type[strawberry.UNSET] in addition to strawberry.types.unset.UnsetType for annotations.

@strawberry.type
class User:
    name: str | None = UNSET
    age: int | None | type[strawberry.UNSET] = UNSET

Here's the tweet text:

🆕 Release (next) is out! Thanks to @alexey_pelykh for the PR 👏

Get it here 👉 https://strawberry.rocks/release/(next)

[botberry]

Hi, thanks for contributing to Strawberry 🍓!

We noticed that this PR is missing a RELEASE.md file. We use that to automatically do releases here on GitHub and, most importantly, to PyPI!

So as soon as this PR is merged, a release will be made 🚀.

Here's an example of RELEASE.md:

Release type: patch

Description of the changes, ideally with some examples, if adding a new feature.

Release type can be one of patch, minor or major. We use semver, so make sure to pick the appropriate type. If in doubt feel free to ask :)

Here's the tweet text:

🆕 Release (next) is out! Thanks to Alexey Pelykh for the PR 👏

Get it here 👉 https://strawberry.rocks/release/(next)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.24%. Comparing base (9282907) to head (cdd651e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3765   +/-   ##
=======================================
  Coverage   97.24%   97.24%           
=======================================
  Files         503      503           
  Lines       33561    33568    +7     
  Branches     1717     1717           
=======================================
+ Hits        32635    32642    +7     
  Misses        707      707           
  Partials      219      219           

[codspeed-hq]

CodSpeed Performance Report

Merging #3765 will not alter performance

_{Comparing alexey-pelykh:imp/type-unset (cdd651e) with main (9282907)}

Summary

✅ 21 untouched benchmarks

[bellini666]

LGTM

Asking review from @patrick91 as well, just to get a second opinion

[alexey-pelykh]

@patrick91 what do you think? :)

[nrbnlulu]

See #3791 which basically removes the need of using UNSET directly.

[patrick91]

@nrbnlulu I think it makes sense to merge both :D