Run strawberry codegen on top of graphql schema. #3221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for adding the Here's a preview of the changelog: Allow strawberry's code generator to build clients from graphql schema files. Here's the tweet text: |
CodSpeed Performance ReportMerging #3221 will not alter performanceComparing Summary
|
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3221 +/- ##
==========================================
- Coverage 96.60% 96.48% -0.12%
==========================================
Files 481 482 +1
Lines 29928 30083 +155
Branches 3691 3719 +28
==========================================
+ Hits 28911 29026 +115
- Misses 833 858 +25
- Partials 184 199 +15 |
mgilson
force-pushed
the
codegen-from-schema
branch
from
3b75011 to
09b06ce
Compare
for more information, see https://pre-commit.ci
patrick91
reviewed
Nov 17, 2023
| @@ -0,0 +1,3 @@ | |||
| Release type: minor | |||
|
|
|||
| Allow strawberry's code generator to build clients from graphql schema files. | |||
There was a problem hiding this comment.
this is an awesome feature, we should extend this release note :)
Comment on lines
+129
to
+131
| if schema.endswith(".graphql"): | ||
| with Path(schema).open() as input_schema: | ||
| schema_symbol = GraphQLSchemaWrapper(build_schema(input_schema.read())) |
There was a problem hiding this comment.
I wonder if we should use a different flag for this :)
Also I prefer to remove one nesting level using read_text
Suggested change
| if schema.endswith(".graphql"): | |
| with Path(schema).open() as input_schema: | |
| schema_symbol = GraphQLSchemaWrapper(build_schema(input_schema.read())) | |
| if schema.endswith(".graphql"): | |
| schema = Path(schema).read_text() | |
| schema_symbol = GraphQLSchemaWrapper(build_schema(schema)) |
| skip_snapshot_test = False | ||
| if query.name == "custom_scalar.graphql": | ||
| # The default plugins don't support custom types built this way | ||
| # (because it doesn't know the python on Typscript types). |
There was a problem hiding this comment.
Suggested change
| # (because it doesn't know the python on Typscript types). | |
| # (because it doesn't know the python or typescript types). |
|
|
||
| class SchemaConverterLike(Protocol): | ||
| @property | ||
| def scalar_registry(self) -> Registry: |
There was a problem hiding this comment.
can we add some pragma no cover here? 😊
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There aren't many graphql client generators in the python ecosystem. AFAIK, strawberry and https://github.com/mirumee/ariadne-codegen are the only two. For organizations already using strawberry on the backend, it makes a lot of sense to continue to use strawberry codegen, however it would be nice to be able to use the same custom plugins for strawberry services and other services that aren't using strawberry on the backend (e.g.
github).From the strawberry codegen perspective, this really just means swapping out the schema object with a separate object with a compatible interface. Luckily, there schema object has a very small used-surface area in the query-codegen code so making this swap isn't terribly difficult.
Description
Enable building client objects on top of graphql schema files. Future changes could allow this to happen on top of introspection URLs.
Types of Changes
Issues Fixed or Closed by This PR
Checklist