mirror of
https://github.com/graphql-python/graphene.git
synced 2024-11-13 13:16:49 +03:00
183 lines
3.7 KiB
Markdown
183 lines
3.7 KiB
Markdown
# v2.0 Upgrade Guide
|
|
|
|
`ObjectType`, `Interface`, `InputObjectType`, `Scalar` and `Enum` implementations
|
|
have been quite simplified, without the need to define a explicit Metaclass for each subtype.
|
|
|
|
It also improves the function resolvers, [simplifying the code](#resolve_only_args) the
|
|
developer have to write to use them.
|
|
|
|
Deprecations:
|
|
* [`AbstractType`](#abstracttype-deprecated)
|
|
* [`resolve_only_args`](#resolve_only_args)
|
|
|
|
Breaking changes:
|
|
* [`Node Connections`](#node-connections)
|
|
|
|
New Features!
|
|
* [`InputObjectType`](#inputobjecttype)
|
|
* [`Meta as Class arguments`](#meta-ass-class-arguments) (_only available for Python 3_)
|
|
|
|
|
|
> The type metaclases are now deleted as are no longer necessary, if your code was depending
|
|
> on this strategy for creating custom attrs, see an [example on how to do it in 2.0](https://github.com/graphql-python/graphene/blob/2.0/graphene/tests/issues/test_425.py).
|
|
|
|
## Deprecations
|
|
|
|
### AbstractType deprecated
|
|
|
|
AbstractType is deprecated in graphene 2.0, you can now use normal inheritance instead.
|
|
|
|
Before:
|
|
|
|
```python
|
|
class CommonFields(AbstractType):
|
|
name = String()
|
|
|
|
class Pet(CommonFields, Interface):
|
|
pass
|
|
```
|
|
|
|
With 2.0:
|
|
|
|
```python
|
|
class CommonFields(object):
|
|
name = String()
|
|
|
|
class Pet(CommonFields, Interface):
|
|
pass
|
|
```
|
|
|
|
### resolve\_only\_args
|
|
|
|
`resolve_only_args` is now deprecated in favor of type annotations (using the polyfill `@graphene.annotate` in Python 2 in case is necessary for accessing `context` or `info`).
|
|
|
|
Before:
|
|
|
|
```python
|
|
class User(ObjectType):
|
|
name = String()
|
|
|
|
@resolve_only_args
|
|
def resolve_name(self):
|
|
return self.name
|
|
```
|
|
|
|
With 2.0:
|
|
|
|
```python
|
|
class User(ObjectType):
|
|
name = String()
|
|
|
|
def resolve_name(self):
|
|
return self.name
|
|
```
|
|
|
|
|
|
## Breaking Changes
|
|
|
|
### Node Connections
|
|
|
|
Node types no longer have a `Connection` by default.
|
|
In 2.0 and onwards `Connection`s should be defined explicitly.
|
|
|
|
Before:
|
|
|
|
```python
|
|
class User(ObjectType):
|
|
class Meta:
|
|
interfaces = [relay.Node]
|
|
name = String()
|
|
|
|
class Query(ObjectType):
|
|
user_connection = relay.ConnectionField(User)
|
|
```
|
|
|
|
With 2.0:
|
|
|
|
```python
|
|
class User(ObjectType):
|
|
class Meta:
|
|
interfaces = [relay.Node]
|
|
name = String()
|
|
|
|
class UserConnection(relay.Connection):
|
|
class Meta:
|
|
node = User
|
|
|
|
class Query(ObjectType):
|
|
user_connection = relay.ConnectionField(UserConnection)
|
|
```
|
|
|
|
## New Features
|
|
|
|
### InputObjectType
|
|
|
|
If you are using `InputObjectType`, you now can access
|
|
it's fields via `getattr` (`my_input.myattr`) when resolving, instead of
|
|
the classic way `my_input['myattr']`.
|
|
|
|
And also use custom defined properties on your input class.
|
|
|
|
Example. Before:
|
|
|
|
```python
|
|
class UserInput(InputObjectType):
|
|
id = ID()
|
|
|
|
def is_user_id(id):
|
|
return id.startswith('userid_')
|
|
|
|
class Query(ObjectType):
|
|
user = graphene.Field(User, input=UserInput())
|
|
|
|
@resolve_only_args
|
|
def resolve_user(self, input):
|
|
user_id = input.get('id')
|
|
if is_user_id(user_id):
|
|
return get_user(user_id)
|
|
```
|
|
|
|
With 2.0:
|
|
|
|
```python
|
|
class UserInput(InputObjectType):
|
|
id = ID()
|
|
|
|
@property
|
|
def is_user_id(self):
|
|
return self.id.startswith('userid_')
|
|
|
|
class Query(ObjectType):
|
|
user = graphene.Field(User, input=UserInput())
|
|
|
|
def resolve_user(self, input):
|
|
if input.is_user_id:
|
|
return get_user(input.id)
|
|
|
|
```
|
|
|
|
|
|
### Meta as Class arguments
|
|
|
|
Now you can use the meta options as class arguments (**ONLY PYTHON 3**).
|
|
|
|
Before:
|
|
|
|
```python
|
|
class Dog(ObjectType):
|
|
class Meta:
|
|
interfaces = [Pet]
|
|
name = String()
|
|
```
|
|
|
|
With 2.0:
|
|
|
|
```python
|
|
class Dog(ObjectType, interfaces=[Pet]):
|
|
name = String()
|
|
```
|
|
|
|
### UUID Scalar
|
|
|
|
In Graphene 2.0 there is a new dedicated scalar for UUIDs, `UUID`.
|