Add custom dataclass init function #1187

jkimbo · 2021-08-30T13:36:36Z

Description

This PR adds a custom dataclass init function that enforces that all args get passed as keyword arguments. This allows us to avoid the problem where a type cannot define a field with a default value before a field that doesn't have a default value.

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

strawberry/utils/dataclasses.py

botberry · 2021-08-30T13:39:47Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release changes how dataclasses are created to make use of the new
kw_only argument in Python 3.10 so that fields without a default value can now
follow a field with a default value. This feature is also backported to all other
supported Python versions.

More info: https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass

For example:

# This no longer raises a TypeError

@strawberry.type
class MyType:
    a: str = "Hi"
    b: int

⚠️ This is a breaking change! Whenever instantiating a Strawberry type make sure
that you only pass values are keyword arguments:

# Before:

MyType("foo", 3)

# After:

MyType(a="foo", b=3)

Here's the preview release card for twitter:

Here's the tweet text:

🆕 Release (next) is out! Thanks to Jonathan Kim for the PR 👏

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

codecov · 2021-08-30T13:40:08Z

Codecov Report

Merging #1187 (bbc9ebe) into main (431db0a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1187   +/-   ##
=======================================
  Coverage   98.19%   98.20%           
=======================================
  Files         160      162    +2     
  Lines        6388     6422   +34     
  Branches     1205     1216   +11     
=======================================
+ Hits         6273     6307   +34     
  Misses         58       58           
  Partials       57       57

patrick91

This might be good for now, I wan't to see what @BryceBeagle thinks before merging though 😊

I think we should still vendorize in future :)

BryceBeagle

I think this is a pretty good solution for now, just a few minor changes I see here

strawberry/utils/dataclasses.py

jkimbo · 2021-12-18T16:50:22Z

@patrick91 @BryceBeagle this is ready for a review again. Sorry for the delay!

patrick91

Looks good to me, I think we need to make this release more visible somehow, to make sure the breaking change is seen by everyone 😊

patrick91 · 2021-12-20T18:08:04Z

RELEASE.md

+This release changes how dataclasses are created to make use of the new
+`kw_only` argument in Python 3.10 so that fields without a default value can now
+follow a field with a default value. This feature is also backported to all other
+supported Python versions.


jkimbo · 2021-12-20T20:26:50Z

@patrick91 yep I agree. Any suggestions on how to do that?

patrick91 · 2021-12-20T20:27:53Z

@patrick91 yep I agree. Any suggestions on how to do that?

Maybe we can send a newsletter for the end of the year and include it there! I can write something in the next few days ☺️

patrick91 · 2022-01-14T17:12:28Z

/pre-release

botberry · 2022-01-14T17:13:30Z

Pre-release

👋

Releasing commit [50d7463] to PyPi as pre-release! 📦

botberry · 2022-01-14T17:13:41Z

Pre-release

👋

Pre-release 0.94.0-dev.1642180413 [50d7463] has been released on PyPi! 🚀
You can try it by doing:

poetry add strawberry-graphql==0.94.0-dev.1642180413

jkimbo · 2022-09-05T17:39:40Z

@patrick91 is this still relevant?

patrick91 · 2022-09-05T17:41:04Z

@patrick91 is this still relevant?

yes, I need to merge it! sorry about that, will rebase it tonight and see what we need to do before merging it :)

patrick91

Hey, so sorry it took me so long to merge this! Thanks for the nudge and all the work @jkimbo 😊

…e behaviour introduced in strawberry-graphql#1187 - Set `kw_only=True` in DataclassAttribute object - Remove code to check that `Attributes without a default cannot follow attributes with one`

* Update Mypy plugin to treat strawberry fields as kw_only, matching the behaviour introduced in #1187 - Set `kw_only=True` in DataclassAttribute object - Remove code to check that `Attributes without a default cannot follow attributes with one` * Fix type issue * Update types * Fix types * Update pyright support Co-authored-by: Patrick Arminio <patrick.arminio@gmail.com>

jceresini · 2022-09-27T19:00:58Z

This introduced a breaking change for us when upgrading from 0.119.1 to 0.131.1. We're using federation, and defined a type that is handled by another subgraph:

@strawberry.federation.type(extend=True, keys=["id"])
class Resource:
    id: strawberry.ID = strawberry.federation.field(external=True)

# [...]

@strawberry.federation.type(keys=["id"], name="Event" )
class Event:
    id: strawberry.ID
    resource_id: strawberry.Private[str]

    @strawberry.field
    def resource(self) -> Resource:
        return Resource(self.resource_id)

After an update we started seeing this error in our logs

        return Resource(self.resource_id)
TypeError: __init__() takes 1 positional argument but 2 were given

It was a simple fix (passing the id as a kwarg) but tracking it down was a bit frustrating, and unexpected for a minor release. Sharing this in case others run into similar issues.

jceresini · 2022-09-27T19:17:30Z

I tracked down this PR while addressing the issue in our code, and commented without reading the above. The PR clearly explains that its a breaking change. 🤦‍♂️ I'll pay more attention to release notes when approving changes that bump the strawberry version.

jkimbo · 2022-09-27T22:03:43Z

@jceresini apologies for the inconvenience. We try hard to not make breaking changes but sometimes it's unavoidable.

I think this is also an artifact of the quick release cycle that Strawberry has which often results in people upgrading between quite large version ranges and so it's hard to identify all the potential breaking changes. We might benefit from something on the website that allows you show the difference between versions and view all the changes at once. What do you think @patrick91 ?

patrick91 · 2022-09-27T22:21:08Z

@jceresini apologies for the inconvenience. We try hard to not make breaking changes but sometimes it's unavoidable.

I think this is also an artifact of the quick release cycle that Strawberry has which often results in people upgrading between quite large version ranges and so it's hard to identify all the potential breaking changes. We might benefit from something on the website that allows you show the difference between versions and view all the changes at once. What do you think @patrick91 ?

yes, I'd love to have something like that! were you thinking of a page with a list of breaking changes and pending deprecations? or something else entirely?

@jceresini sorry about this! Ideally we should have done this in a major release, but unfortunately we haven't made the jump to v1 just yet

jkimbo · 2022-09-27T22:50:13Z

yes, I'd love to have something like that! were you thinking of a page with a list of breaking changes and pending deprecations? or something else entirely?

Highlighting breaking changes would be ideal but I'm not sure how we would extract that. As a first step it would be great to just list all the titles of the changes and you can open each one to find out more. More like traditional release notes. I'm imagining something like this: https://react-native-community.github.io/upgrade-helper/

jkimbo requested review from patrick91, BryceBeagle and DoctorJohn August 30, 2021 13:36

jkimbo commented Aug 30, 2021

View reviewed changes

strawberry/utils/dataclasses.py Outdated Show resolved Hide resolved

patrick91 reviewed Aug 30, 2021

View reviewed changes

jkimbo self-assigned this Sep 1, 2021

BryceBeagle suggested changes Sep 2, 2021

View reviewed changes

jkimbo added 5 commits December 18, 2021 16:21

Add custom dataclass init function

1b878ad

Add note about kw_only

02a6ebd

Add some tests and fix issue with empty fields

dd8148d

Fix tests

3eb2cfb

Fix another test

d72d1bd

jkimbo force-pushed the custom-dataclass-init branch from 0be0bbf to d72d1bd Compare December 18, 2021 16:23

jkimbo added 3 commits December 18, 2021 16:34

Move dataclasses code into separate folder

d4f99b0

Fix typo

9907734

Add RELEASE file

50d7463

jkimbo requested review from BryceBeagle and patrick91 December 18, 2021 16:50

botberry added bot:has-release-file and removed bot:release-type-minor labels Dec 18, 2021

patrick91 approved these changes Dec 20, 2021

View reviewed changes

patrick91 mentioned this pull request Dec 21, 2021

Bump mypy and fix compatibility issue with 0.920 #1503

Merged

11 tasks

BryceBeagle approved these changes Dec 24, 2021

View reviewed changes

patrick91 mentioned this pull request Jan 3, 2022

fix(pydantic): Allow conversion of pydantic models with mutable defaults #1491

Merged

11 tasks

nrbnlulu mentioned this pull request Jul 10, 2022

Support for slots #2004

Closed

11 tasks

Merge branch 'main' into custom-dataclass-init

8733874

botberry added the bot:release-type-minor label Sep 5, 2022

Fix type ignore

938781c

patrick91 force-pushed the custom-dataclass-init branch 2 times, most recently from 1d00daf to 8370a2a Compare September 5, 2022 21:09

Update code

bbc9ebe

patrick91 force-pushed the custom-dataclass-init branch from 8370a2a to bbc9ebe Compare September 5, 2022 21:20

patrick91 approved these changes Sep 5, 2022

View reviewed changes

patrick91 merged commit 1b14a45 into main Sep 5, 2022

patrick91 deleted the custom-dataclass-init branch September 5, 2022 21:26

nrbnlulu mentioned this pull request Sep 6, 2022

[WIP] Support custom fields #2117

Closed

21 tasks

paulo-raca mentioned this pull request Sep 22, 2022

Do not use kw_only=False when specifying strawberry.field() #2189

Merged

11 tasks

paulo-raca mentioned this pull request Sep 22, 2022

Let type checkers know that fields are kwonly #2191

Merged

11 tasks

patrick91 mentioned this pull request Sep 28, 2022

Document breaking changes #2208

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom dataclass init function #1187

Add custom dataclass init function #1187

jkimbo commented Aug 30, 2021

botberry commented Aug 30, 2021 •

edited

Loading

codecov bot commented Aug 30, 2021 •

edited

Loading

patrick91 left a comment

BryceBeagle left a comment

jkimbo commented Dec 18, 2021

patrick91 left a comment

patrick91 Dec 20, 2021

jkimbo commented Dec 20, 2021

patrick91 commented Dec 20, 2021

patrick91 commented Jan 14, 2022

botberry commented Jan 14, 2022

botberry commented Jan 14, 2022

jkimbo commented Sep 5, 2022

patrick91 commented Sep 5, 2022

patrick91 left a comment

jceresini commented Sep 27, 2022

jceresini commented Sep 27, 2022 •

edited

Loading

jkimbo commented Sep 27, 2022

patrick91 commented Sep 27, 2022

jkimbo commented Sep 27, 2022

Add custom dataclass init function #1187

Add custom dataclass init function #1187

Conversation

jkimbo commented Aug 30, 2021

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

botberry commented Aug 30, 2021 • edited Loading

codecov bot commented Aug 30, 2021 • edited Loading

Codecov Report

patrick91 left a comment

Choose a reason for hiding this comment

BryceBeagle left a comment

Choose a reason for hiding this comment

jkimbo commented Dec 18, 2021

patrick91 left a comment

Choose a reason for hiding this comment

patrick91 Dec 20, 2021

Choose a reason for hiding this comment

jkimbo commented Dec 20, 2021

patrick91 commented Dec 20, 2021

patrick91 commented Jan 14, 2022

botberry commented Jan 14, 2022

Pre-release

botberry commented Jan 14, 2022

Pre-release

jkimbo commented Sep 5, 2022

patrick91 commented Sep 5, 2022

patrick91 left a comment

Choose a reason for hiding this comment

jceresini commented Sep 27, 2022

jceresini commented Sep 27, 2022 • edited Loading

jkimbo commented Sep 27, 2022

patrick91 commented Sep 27, 2022

jkimbo commented Sep 27, 2022

botberry commented Aug 30, 2021 •

edited

Loading

codecov bot commented Aug 30, 2021 •

edited

Loading

jceresini commented Sep 27, 2022 •

edited

Loading