1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
from graphql import (
GraphQLID,
GraphQLNonNull,
GraphQLObjectType,
GraphQLInputField,
GraphQLSchema,
GraphQLString,
GraphQLField,
)
from graphql_relay.node.node import node_definitions, global_id_field, from_global_id
from graphql_relay.connection.array_connection import connection_from_array
from graphql_relay.connection.connection import connection_args, connection_definitions
from graphql_relay.mutation.mutation import mutation_with_client_mutation_id
from .star_wars_data import (
Faction,
get_faction,
get_ship,
get_rebels,
get_empire,
create_ship,
)
# This is a basic end-to-end test, designed to demonstrate the various
# capabilities of a Relay-compliant GraphQL server.
#
# It is recommended that readers of this test be familiar with
# the end-to-end test in GraphQL.js first, as this test skips
# over the basics covered there in favor of illustrating the
# key aspects of the Relay spec that this test is designed to illustrate.
#
# We will create a GraphQL schema that describes the major
# factions and ships in the original Star Wars trilogy.
#
# NOTE: This may contain spoilers for the original Star
# Wars trilogy.
# Using our shorthand to describe type systems, the type system for our
# example will be the following:
#
# interface Node {
# id: ID!
# }
#
# type Faction : Node {
# id: ID!
# name: String
# ships: ShipConnection
# }
#
# type Ship : Node {
# id: ID!
# name: String
# }
#
# type ShipConnection {
# edges: [ShipEdge]
# pageInfo: PageInfo!
# }
#
# type ShipEdge {
# cursor: String!
# node: Ship
# }
#
# type PageInfo {
# hasNextPage: Boolean!
# hasPreviousPage: Boolean!
# startCursor: String
# endCursor: String
# }
#
# type Query {
# rebels: Faction
# empire: Faction
# node(id: ID!): Node
# }
#
# input IntroduceShipInput {
# clientMutationId: string
# shipName: string!
# factionId: ID!
# }
#
# type IntroduceShipPayload {
# clientMutationId: string
# ship: Ship
# faction: Faction
# }
#
# type Mutation {
# introduceShip(input IntroduceShipInput!): IntroduceShipPayload
# }
# We get the node interface and field from the relay library.
#
# The first method is the way we resolve an ID to its object. The second is the
# way we resolve an object that implements node to its type.
def get_node(global_id, _info):
type_, id_ = from_global_id(global_id)
if type_ == "Faction":
return get_faction(id_)
if type_ == "Ship":
return get_ship(id_)
return None # pragma: no cover
def get_node_type(obj, _info, _type):
if isinstance(obj, Faction):
return faction_type.name
return ship_type.name
node_interface, node_field = node_definitions(get_node, get_node_type)[:2]
# We define our basic ship type.
#
# This implements the following type system shorthand:
# type Ship : Node {
# id: String!
# name: String
# }
ship_type = GraphQLObjectType(
name="Ship",
description="A ship in the Star Wars saga",
fields=lambda: {
"id": global_id_field("Ship"),
"name": GraphQLField(GraphQLString, description="The name of the ship."),
},
interfaces=[node_interface],
)
# We define a connection between a faction and its ships.
#
# connection_type implements the following type system shorthand:
# type ShipConnection {
# edges: [ShipEdge]
# pageInfo: PageInfo!
# }
#
# connection_type has an edges field - a list of edgeTypes that implement the
# following type system shorthand:
# type ShipEdge {
# cursor: String!
# node: Ship
# }
ship_edge, ship_connection = connection_definitions(ship_type, "Ship")
# We define our faction type, which implements the node interface.
#
# This implements the following type system shorthand:
# type Faction : Node {
# id: String!
# name: String
# ships: ShipConnection
# }
faction_type = GraphQLObjectType(
name="Faction",
description="A faction in the Star Wars saga",
fields=lambda: {
"id": global_id_field("Faction"),
"name": GraphQLField(GraphQLString, description="The name of the faction."),
"ships": GraphQLField(
ship_connection,
description="The ships used by the faction.",
args=connection_args,
resolve=lambda faction, _info, **args: connection_from_array(
[get_ship(ship) for ship in faction.ships], args
),
),
},
interfaces=[node_interface],
)
# This is the type that will be the root of our query, and the
# entry point into our schema.
#
# This implements the following type system shorthand:
# type Query {
# rebels: Faction
# empire: Faction
# node(id: String!): Node
# }
query_type = GraphQLObjectType(
name="Query",
fields=lambda: {
"rebels": GraphQLField(faction_type, resolve=lambda _obj, _info: get_rebels()),
"empire": GraphQLField(faction_type, resolve=lambda _obj, _info: get_empire()),
"node": node_field,
},
)
# This will return a GraphQLFieldConfig for our ship
# mutation.
#
# It creates these two types implicitly:
# input IntroduceShipInput {
# clientMutationId: string
# shipName: string!
# factionId: ID!
# }
#
# type IntroduceShipPayload {
# clientMutationId: string
# ship: Ship
# faction: Faction
# }
class IntroduceShipMutation:
# noinspection PyPep8Naming
def __init__(self, shipId, factionId, clientMutationId=None):
self.shipId = shipId
self.factionId = factionId
self.clientMutationId = clientMutationId
# noinspection PyPep8Naming
def mutate_and_get_payload(_info, shipName, factionId, **_input):
new_ship = create_ship(shipName, factionId)
return IntroduceShipMutation(shipId=new_ship.id, factionId=factionId)
ship_mutation = mutation_with_client_mutation_id(
"IntroduceShip",
input_fields={
"shipName": GraphQLInputField(GraphQLNonNull(GraphQLString)),
"factionId": GraphQLInputField(GraphQLNonNull(GraphQLID)),
},
output_fields={
"ship": GraphQLField(
ship_type, resolve=lambda payload, _info: get_ship(payload.shipId)
),
"faction": GraphQLField(
faction_type, resolve=lambda payload, _info: get_faction(payload.factionId)
),
},
mutate_and_get_payload=mutate_and_get_payload,
)
# This is the type that will be the root of our mutations, and the
# entry point into performing writes in our schema.
#
# This implements the following type system shorthand:
# type Mutation {
# introduceShip(input IntroduceShipInput!): IntroduceShipPayload
# }
mutation_type = GraphQLObjectType(
"Mutation", fields=lambda: {"introduceShip": ship_mutation}
)
# Finally, we construct our schema (whose starting query type is the query
# type we defined above) and export it.
star_wars_schema = GraphQLSchema(query=query_type, mutation=mutation_type)
|