Implement unions as annotated types #2840

Ambro17 · 2023-06-11T23:19:54Z

Description

Replace strawberry.union direct usage with typing.Annotated for better type hints

Add test for warning over multiple args in tests/types/resolving/test_unions.py
Add tests for unions new api equivalent to those of the old api in tests/types/resolving/test_unions.py

Types of Changes

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).

codecov · 2023-06-11T23:22:07Z

Codecov Report

Merging #2840 (2f6c288) into main (3487d19) will decrease coverage by 0.41%.
The diff coverage is 86.90%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2840      +/-   ##
==========================================
- Coverage   96.37%   95.96%   -0.41%     
==========================================
  Files         207      207              
  Lines        8957     9028      +71     
  Branches     1646     1662      +16     
==========================================
+ Hits         8632     8664      +32     
- Misses        206      238      +32     
- Partials      119      126       +7

botberry · 2023-06-11T23:22:46Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release adds support for declaring union types using typing.Annotated
instead of strawberry.union(name, types=...).

Code using the old syntax will continue to work, but it will trigger a
deprecation warning. Using Annotated will improve type checking and IDE support
especially when using pyright.

Before:

Animal = strawberry.union("Animal", (Cat, Dog))

After:

from typing import Annotated, Union

Animal = Annotated[Union[Cat, Dog], strawberry.union("Animal")]

Here's the preview release card for twitter:

Here's the tweet text:

🆕 Release (next) is out! Thanks to Nahuel Ambrosini for the PR 👏

Get it here 👉 https://github.com/strawberry-graphql/strawberry/releases/tag/(next)

patrick91

Thank you so much! <3

I've left only one comment 😊

strawberry/annotation.py

* Replace click with typer * Fix dependencies * Fix type * Update test for pyinstrument * Lock * Use stdout instead of output * Add release notes * Workound failing tests * Fix one more test

…ql#2227) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Co-authored-by: Matt Gilson <mgilson@lat.ai> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

strawberry/annotation.py

Co-authored-by: Patrick Arminio <patrick.arminio@gmail.com>

for more information, see https://pre-commit.ci

patrick91 · 2023-06-22T22:39:04Z

I've worked on this a bit more, I think it is almost ready to go, I want to improve the errors, but shouldn't take too long 😊

patrick91 · 2023-06-23T09:58:05Z

This should be ready now 😊

bellini666

My 2 cents :)

strawberry/annotation.py

strawberry/union.py

strawberry/annotation.py

patrick91 · 2023-06-26T22:05:20Z

this is ready!

bellini666

No more suggestions, LGTM 👍🏼

patrick91 · 2023-06-27T16:35:42Z

@bellini666 let's merge yours first and then this one later today or tomorrow 😊

botberry added bot:has-release-file labels Jun 11, 2023

Ambro17 force-pushed the implement-unions-as-annotated-types branch from 802dfbc to c7bf740 Compare June 11, 2023 23:37

patrick91 reviewed Jun 12, 2023

View reviewed changes

strawberry/annotation.py Show resolved Hide resolved

patrick91 mentioned this pull request Jun 12, 2023

Implement union using Annotated #2212

Closed

✨ Implement union with typing.Annotated

9e2ff64

Ambro17 force-pushed the implement-unions-as-annotated-types branch from ebbb837 to 9e2ff64 Compare June 14, 2023 20:25

patrick91 and others added 7 commits June 14, 2023 17:29

Replace click with typer (strawberry-graphql#2569)

f3d8581

* Replace click with typer * Fix dependencies * Fix type * Update test for pyinstrument * Lock * Use stdout instead of output * Add release notes * Workound failing tests * Fix one more test

Release 🍓 0.184.1

ff6f93b

Use dataclass_transform instead of our custom one (strawberry-graph…

6f4360d

…ql#2227) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Release 🍓 0.185.0

ca38bc2

Fix directive typehint (strawberry-graphql#2847)

717c8e8

Co-authored-by: Matt Gilson <mgilson@lat.ai> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Release 🍓 0.185.1

f265bb8

Merge branch 'main' into implement-unions-as-annotated-types

44f2403

patrick91 reviewed Jun 14, 2023

View reviewed changes

strawberry/annotation.py Outdated Show resolved Hide resolved

strawberry/annotation.py Outdated Show resolved Hide resolved

Ambro17 and others added 3 commits June 14, 2023 18:33

Update strawberry/annotation.py

ca61b15

Co-authored-by: Patrick Arminio <patrick.arminio@gmail.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

3f24ad3

for more information, see https://pre-commit.ci

🔧

4846baf

botberry removed bot:release-type-patch labels Jun 22, 2023

patrick91 added 4 commits June 22, 2023 22:46

Merge branch 'main' into implement-unions-as-annotated-types

4cc5b4f

Type fix

4da83ab

Update

7c5d996

Update tests for latest pyright

b359339

botberry added bot:has-release-file labels Jun 22, 2023

Initial new tests

f6f04d2

patrick91 added 2 commits June 23, 2023 10:46

Removed unused tests

43d060a

Remove type ignores

dee2935

patrick91 requested review from bellini666 and skilkis June 23, 2023 09:58

bellini666 requested changes Jun 23, 2023

View reviewed changes

strawberry/annotation.py Outdated Show resolved Hide resolved

strawberry/union.py Outdated Show resolved Hide resolved

strawberry/union.py Outdated Show resolved Hide resolved

bellini666 reviewed Jun 23, 2023

View reviewed changes

strawberry/annotation.py Outdated Show resolved Hide resolved

botberry removed the bot:has-release-file label Jun 25, 2023

Don't put source file inside __init__

de082f7

botberry added the bot:has-release-file label Jun 25, 2023

patrick91 added 12 commits June 25, 2023 22:32

Move union validation to unions

95f38c7

remove duplicated code, split tests

f791515

Fix test

54c1b93

Update tests

b0f22ca

Error support for union with pipe

4f47618

Test union of unions

7abce0e

Ignore unions in is_valid_union_type

ca4af9a

Fix test

f486b93

Improve error for list

2514de2

better errors for scalars

7064ab1

update release notes

3c6f36b

remove type ignore

2f6c288

patrick91 requested a review from bellini666 June 26, 2023 22:05

botberry added bot:release-type-minor and removed bot:release-type-patch labels Jun 27, 2023

bellini666 approved these changes Jun 27, 2023

View reviewed changes

patrick91 merged commit a7a7c0d into strawberry-graphql:main Jun 28, 2023
39 of 41 checks passed

patrick91 mentioned this pull request Dec 30, 2023

Pyright 1.1.344 reports that a strawberry.scalar(...) variable cannot be used for return type annotation #3312

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement unions as annotated types #2840

Implement unions as annotated types #2840

Ambro17 commented Jun 11, 2023 •

edited

Loading

codecov bot commented Jun 11, 2023 •

edited

Loading

botberry commented Jun 11, 2023 •

edited

Loading

patrick91 left a comment

patrick91 commented Jun 22, 2023

patrick91 commented Jun 23, 2023

bellini666 left a comment

patrick91 commented Jun 26, 2023

bellini666 left a comment

patrick91 commented Jun 27, 2023

Implement unions as annotated types #2840

Implement unions as annotated types #2840

Conversation

Ambro17 commented Jun 11, 2023 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

codecov bot commented Jun 11, 2023 • edited Loading

Codecov Report

botberry commented Jun 11, 2023 • edited Loading

patrick91 left a comment

Choose a reason for hiding this comment

patrick91 commented Jun 22, 2023

patrick91 commented Jun 23, 2023

bellini666 left a comment

Choose a reason for hiding this comment

patrick91 commented Jun 26, 2023

bellini666 left a comment

Choose a reason for hiding this comment

patrick91 commented Jun 27, 2023

Ambro17 commented Jun 11, 2023 •

edited

Loading

codecov bot commented Jun 11, 2023 •

edited

Loading

botberry commented Jun 11, 2023 •

edited

Loading