mirror of
https://github.com/graphql-python/graphene.git
synced 2024-09-21 11:28:56 +03:00
143 lines
3.3 KiB
Markdown
143 lines
3.3 KiB
Markdown
# Graphene: Python DSL for GraphQL
|
|
|
|
This is a library to use GraphQL in Python in a easy way.
|
|
It will map the models/fields to internal GraphQL-py objects without effort.
|
|
|
|
[](https://travis-ci.org/syrusakbary/graphene)
|
|
[](https://coveralls.io/github/syrusakbary/graphene?branch=master)
|
|
|
|
## Usage
|
|
|
|
Example code of a GraphQL schema using Graphene:
|
|
|
|
### Schema definition
|
|
|
|
```python
|
|
import graphene
|
|
# ...
|
|
|
|
class Character(graphene.Interface):
|
|
id = graphene.IDField()
|
|
name = graphene.StringField()
|
|
friends = graphene.ListField('self')
|
|
appearsIn = graphene.ListField(Episode)
|
|
|
|
def resolve_friends(self, args, *_):
|
|
return [wrap_character(getCharacter(f)) for f in self.instance.friends]
|
|
|
|
class Human(Character):
|
|
homePlanet = graphene.StringField()
|
|
|
|
|
|
class Droid(Character):
|
|
primaryFunction = graphene.StringField()
|
|
|
|
|
|
class Query(graphene.ObjectType):
|
|
hero = graphene.Field(Character,
|
|
episode = graphene.Argument(Episode)
|
|
)
|
|
human = graphene.Field(Human,
|
|
id = graphene.Argument(graphene.String)
|
|
)
|
|
droid = graphene.Field(Droid,
|
|
id = graphene.Argument(graphene.String)
|
|
)
|
|
|
|
@resolve_only_args
|
|
def resolve_hero(self, episode):
|
|
return wrap_character(getHero(episode))
|
|
|
|
@resolve_only_args
|
|
def resolve_human(self, id):
|
|
return wrap_character(getHuman(id))
|
|
|
|
@resolve_only_args
|
|
def resolve_droid(self, id):
|
|
return wrap_character(getDroid(id))
|
|
|
|
|
|
Schema = graphene.Schema(query=Query)
|
|
```
|
|
|
|
### Querying
|
|
|
|
Querying `graphene.Schema` is as simple as:
|
|
|
|
```python
|
|
query = '''
|
|
query HeroNameQuery {
|
|
hero {
|
|
name
|
|
}
|
|
}
|
|
'''
|
|
result = Schema.execute(query)
|
|
```
|
|
|
|
### Relay Schema
|
|
|
|
Graphene also supports Relay, check the (Starwars Relay example)[/tests/starwars_relay]!
|
|
|
|
```python
|
|
import graphene
|
|
from graphene import relay
|
|
|
|
class Ship(relay.Node):
|
|
'''A ship in the Star Wars saga'''
|
|
name = graphene.StringField(description='The name of the ship.')
|
|
|
|
@classmethod
|
|
def get_node(cls, id):
|
|
return Ship(getShip(id))
|
|
|
|
|
|
class Faction(relay.Node):
|
|
'''A faction in the Star Wars saga'''
|
|
name = graphene.StringField(description='The name of the faction.')
|
|
ships = relay.ConnectionField(Ship, description='The ships used by the faction.')
|
|
|
|
@resolve_only_args
|
|
def resolve_ships(self, **kwargs):
|
|
return [Ship(getShip(ship)) for ship in self.instance.ships]
|
|
|
|
@classmethod
|
|
def get_node(cls, id):
|
|
return Faction(getFaction(id)
|
|
|
|
|
|
class Query(graphene.ObjectType):
|
|
rebels = graphene.Field(Faction)
|
|
empire = graphene.Field(Faction)
|
|
node = relay.NodeField()
|
|
|
|
@resolve_only_args
|
|
def resolve_rebels(self):
|
|
return Faction(getRebels())
|
|
|
|
@resolve_only_args
|
|
def resolve_empire(self):
|
|
return Faction(getEmpire())
|
|
|
|
|
|
Schema = graphene.Schema(query=Query)
|
|
|
|
# Later on, for querying
|
|
Schema.execute('''rebels { name }''')
|
|
|
|
```
|
|
|
|
## Contributing
|
|
|
|
After cloning this repo, ensure dependencies are installed by running:
|
|
|
|
```sh
|
|
python setup.py install
|
|
```
|
|
|
|
After developing, the full test suite can be evaluated by running:
|
|
|
|
```sh
|
|
python setup.py test # Use --pytest-args="-v -s" for verbose mode
|
|
```
|