graphql-python/graphene
1
1
Fork 0
mirror of https://github.com/graphql-python/graphene.git synced 2025-02-16 19:40:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update UPGRADE-v2.0.md

Browse Source
This commit is contained in:
Syrus Akbary 2017-08-07 12:28:18 -07:00 committed by GitHub
parent 1e20e2bff3
commit 19bf9b3713
1 changed files with 7 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
UPGRADE-v2.0.md
View File

@ -25,42 +25,6 @@ developer has to write to use them.
## Deprecations ## Deprecations
### Simpler resolvers
All the resolvers in graphene have been simplified.
Prior to Graphene `2.0`, all resolvers required four arguments: `(root, args, context, info)`.
Now, resolver `args` are passed as keyword arguments to the function, and `context` argument dissapeared in favor of `info.context`.
Before:
```python
my_field = graphene.String(my_arg=graphene.String())
def resolve_my_field(self, args, context, info):
my_arg = args.get('my_arg')
return ...
```
With 2.0:
```python
my_field = graphene.String(my_arg=graphene.String())
def resolve_my_field(self, info, my_arg):
return ...
```
And, if you need the context in the resolver, you can use `info.context`:
```python
my_field = graphene.String(my_arg=graphene.String())
def resolve_my_field(self, info, my_arg):
context = info.context
return ...
```
### AbstractType deprecated ### AbstractType deprecated
AbstractType is deprecated in graphene 2.0, you can now use normal inheritance instead. AbstractType is deprecated in graphene 2.0, you can now use normal inheritance instead.
@ -135,9 +99,9 @@ class User(Mutation):
### Simpler resolvers ### Simpler resolvers
All the resolvers in graphene have been simplified. If before resolvers required All the resolvers in graphene have been simplified.
four arguments `root`, `args`, `context` and `info`, now the `args` are passed as keyword arguments Prior to Graphene `2.0`, all resolvers required four arguments: `(root, args, context, info)`.
and `context` and `info` will only be passed if the function is annotated with it. Now, resolver `args` are passed as keyword arguments to the function, and `context` argument dissapeared in favor of `info.context`.
Before: Before:
@ -154,26 +118,17 @@ With 2.0:
```python ```python
my_field = graphene.String(my_arg=graphene.String()) my_field = graphene.String(my_arg=graphene.String())
def resolve_my_field(self, my_arg): def resolve_my_field(self, info, my_arg):
return ... return ...
``` ```
And, if the resolver want to receive the context: And, if you need the context in the resolver, you can use `info.context`:
```python ```python
my_field = graphene.String(my_arg=graphene.String()) my_field = graphene.String(my_arg=graphene.String())
def resolve_my_field(self, context: graphene.Context, my_arg): def resolve_my_field(self, info, my_arg):
return ... context = info.context
```
which is equivalent in Python 2 to:
```python
my_field = graphene.String(my_arg=graphene.String())
@annotate(context=graphene.Context)
def resolve_my_field(self, context, my_arg):
return ... return ...
``` ```