rename `_type_definition` to `__strawberry_definition__` #2836

nrbnlulu · 2023-06-11T06:59:27Z

Description

Rename _type_definition to __strawberry_definition__.

I understand that @BryceBeagle intended that StrawberryObject would be merged with TypeDefinition somehow in the future.
Currently I exposed WithStrawberryDefinition as a protocol that only includes __strawberry_definition__ in it. If in the future it would be a real type the annotations are already in place.

I am not very sure about the name __strawberry_object__ since it can be InputObject / Interface / ObjectType
and enums use _enum_definition, open to suggestions... As discussed on discord every strawberry decorated type would have this dunder. Follow #2841 for more details.

TODO:

Add alias for _type_definition backward compat with warning.

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-11T07:02:49Z

Codecov Report

Merging #2836 (b3c2a94) into main (170f179) will increase coverage by 0.06%.
The diff coverage is 97.32%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2836      +/-   ##
==========================================
+ Coverage   96.30%   96.36%   +0.06%     
==========================================
  Files         206      207       +1     
  Lines        8911     8949      +38     
  Branches     1641     1644       +3     
==========================================
+ Hits         8582     8624      +42     
+ Misses        208      206       -2     
+ Partials      121      119       -2

botberry · 2023-06-11T08:29:04Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release renames _type_definition to __strawberry_definition__. This doesn't change the public API of Strawberry, but if you were using _type_definition you can still access it, but it will be removed in future.

Here's the preview release card for twitter:

Here's the tweet text:

🆕 Release (next) is out! Thanks to ניר for the PR 👏

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

strawberry/types/types.py

skilkis · 2023-06-12T23:18:27Z

Once again great work @nrbnlulu!! Just left two minor comments, the rest looks good to me 🚀

bellini666

This is an awesome change in general! :)

Made some minor suggestions

strawberry/exceptions/invalid_argument_type.py

strawberry/type.py

strawberry/types/types.py

strawberry/utils/deprecations.py

tests/relay/test_utils.py

tests/schema/test_directives.py

tests/test_deprecations.py

strawberry/codegen/query_codegen.py

bellini666 · 2023-06-14T15:59:18Z

strawberry/object_type.py

@@ -151,6 +152,12 @@ def _process_type(
        _fields=fields,
        is_type_of=is_type_of,
    )
+    # TODO: remove when deprecating _type_definition
+    DeprecatedDescriptor(
+        DEPRECATION_MESSAGES._TYPE_DEFINITION,


Wouldn't it be simpler/better to just put the message in here directly, instead of defining and importing DEPRECATION_MESSAGES?

I use it 3 times, would be duplicated ig.. it also easier to remove it afterwards I think.

bellini666 · 2023-06-14T16:06:24Z

strawberry/schema/schema_converter.py

@@ -340,7 +344,7 @@ def get_graphql_input_fields(
        )

    def from_input_object(self, object_type: type) -> GraphQLInputObjectType:


Just notice that from_input_object is the only converter that receives a type instead of StrawberryObjectDefinition

@patrick91 should we try to normalize this? Don't know if in this PR, but since the breaking change is happening it would be nice. Either this function should receive the object definition, like the others (e.g. from_object, from_interface, etc), or those others should receive the type directly (even typing it as type: WithObjectDefinition)

let's do in another PR 😊

Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>

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

# Conflicts: # tests/schema/test_extensions.py

strawberry/type.py

Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>

patrick91

Thank you so much for doing this! <3

RELEASE.md

nrbnlulu added 2 commits June 11, 2023 07:47

rename _type_definition to __strawberry_definition__

002c985

rename _type_definition to __strawberry_definition__

f25670a

nrbnlulu changed the title ~~rename _type_definition to __strawberry_definition__~~ rename _type_definition to __strawberry_definition__ Jun 11, 2023

nrbnlulu added 4 commits June 11, 2023 10:29

relay tests pass.

d26776a

py 3.8 compat

e529cf7

py 3.8 compat

57b58cd

add alias test.

f2f10d5

nrbnlulu marked this pull request as ready for review June 11, 2023 08:26

add test_deprecations.py

7955db9

Add RELEASE.md

66531bc

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

nrbnlulu added 7 commits June 11, 2023 11:46

fix mypy errors

1dfd103

use compat cached_prop

19ac426

fix tests.

fe4b9a3

fix tests.

e9f80a2

fix mypy

6989ff9

rename to __strawberry_object__

dc3d5e2

TypeDefinition to StrawberryObjectType

d91707f

nrbnlulu changed the title ~~rename _type_definition to __strawberry_definition__~~ rename _type_definition to __strawberry_object__ Jun 11, 2023

nrbnlulu added 7 commits June 11, 2023 19:05

TypeDefinition to StrawberryObject

e7d607f

don't use raw hasattr where possible.

4148d7d

codecov fixes.

50c86e5

codecov fixes.

38c410f

fix schema printer.

f6523b3

fix schema printer.

5051dc9

better RELEASE.md

e448e36

botberry added the bot:release-type-minor label Jun 11, 2023

skilkis reviewed Jun 12, 2023

View reviewed changes

strawberry/types/types.py Outdated Show resolved Hide resolved

nrbnlulu added 7 commits June 13, 2023 07:43

move to strawberry/type.py

1918193

rename to has_strawberry_object_definition

35c513f

use obj instead of klass

c7fa7cc

shorter names

7c63fc4

last use of hasattr

24aca65

Merge branch 'main' into rename_type_definition

01b6050

fix tests

5d409d7

bellini666 requested changes Jun 13, 2023

View reviewed changes

strawberry/exceptions/invalid_argument_type.py Outdated Show resolved Hide resolved

strawberry/type.py Outdated Show resolved Hide resolved

strawberry/types/types.py Outdated Show resolved Hide resolved

review fixes

56acadb

nrbnlulu requested a review from bellini666 June 14, 2023 10:44

add warning descriptor

eb0bb73

bellini666 requested changes Jun 14, 2023

View reviewed changes

nrbnlulu and others added 7 commits June 14, 2023 19:15

Update tests/test_deprecations.py

21dfd06

Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>

Update strawberry/utils/deprecations.py

300991c

Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>

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

b31a5e2

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

resolve review suggestion.

5c0298e

Merge branch 'main' into rename_type_definition

72eb6ee

# Conflicts: # tests/schema/test_extensions.py

merged main

bdb85d3

fix tests

919afd7

nrbnlulu requested a review from bellini666 June 18, 2023 17:35

bellini666 reviewed Jun 18, 2023

View reviewed changes

strawberry/type.py Outdated Show resolved Hide resolved

nrbnlulu and others added 3 commits June 18, 2023 21:16

Update strawberry/type.py

4821219

Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com>

fix ci

2ff2deb

merge main

add12e9

bellini666 approved these changes Jun 20, 2023

View reviewed changes

patrick91 approved these changes Jun 20, 2023

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

Update RELEASE.md

b3c2a94

patrick91 merged commit cd0ab64 into strawberry-graphql:main Jun 20, 2023
39 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rename `_type_definition` to `__strawberry_definition__` #2836

rename `_type_definition` to `__strawberry_definition__` #2836

nrbnlulu commented Jun 11, 2023 •

edited

codecov bot commented Jun 11, 2023 •

edited

botberry commented Jun 11, 2023 •

edited

skilkis commented Jun 12, 2023

bellini666 left a comment

bellini666 Jun 14, 2023

nrbnlulu Jun 14, 2023 •

edited

bellini666 Jun 14, 2023

patrick91 Jun 20, 2023

patrick91 left a comment

		@@ -340,7 +344,7 @@ def get_graphql_input_fields(
		)

		def from_input_object(self, object_type: type) -> GraphQLInputObjectType:

rename _type_definition to __strawberry_definition__ #2836

rename _type_definition to __strawberry_definition__ #2836

Conversation

nrbnlulu commented Jun 11, 2023 • edited

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

codecov bot commented Jun 11, 2023 • edited

Codecov Report

botberry commented Jun 11, 2023 • edited

skilkis commented Jun 12, 2023

bellini666 left a comment

Choose a reason for hiding this comment

bellini666 Jun 14, 2023

Choose a reason for hiding this comment

nrbnlulu Jun 14, 2023 • edited

Choose a reason for hiding this comment

bellini666 Jun 14, 2023

Choose a reason for hiding this comment

patrick91 Jun 20, 2023

Choose a reason for hiding this comment

patrick91 left a comment

Choose a reason for hiding this comment

rename `_type_definition` to `__strawberry_definition__` #2836

rename `_type_definition` to `__strawberry_definition__` #2836

nrbnlulu commented Jun 11, 2023 •

edited

codecov bot commented Jun 11, 2023 •

edited

botberry commented Jun 11, 2023 •

edited

nrbnlulu Jun 14, 2023 •

edited