在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):graphql-python/graphql-relay-py开源软件地址(OpenSource Url):https://github.com/graphql-python/graphql-relay-py开源编程语言(OpenSource Language):Python 100.0%开源软件介绍(OpenSource Introduction):Relay Library for GraphQL PythonGraphQL-relay-py is the Relay library for GraphQL-core. It allows the easy creation of Relay-compliant servers using GraphQL-core. GraphQL-Relay-Py is a Python port of graphql-relay-js, while GraphQL-Core is a Python port of GraphQL.js, the reference implementation of GraphQL for JavaScript. Since version 3, GraphQL-Relay-Py and GraphQL-Core support Python 3.6 and above only. For older versions of Python, you can use version 2 of these libraries. Getting StartedA basic understanding of GraphQL and of the GraphQL Python implementation is needed to provide context for this library. An overview of GraphQL in general is available in the README for the Specification for GraphQL. This library is designed to work with the the GraphQL-Core Python reference implementation of a GraphQL server. An overview of the functionality that a Relay-compliant GraphQL server should provide is in the GraphQL Relay Specification on the Relay website. That overview describes a simple set of examples that exist as tests in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together. Using Relay Library for GraphQL Python (graphql-core)Install Relay Library for GraphQL Python pip install graphql-core
pip install graphql-relay When building a schema for GraphQL, the provided library functions can be used to simplify the creation of Relay patterns. All the functions that are explained in the following sections must be
imported from the top level of the from graphql_relay import connection_definitions ConnectionsHelper functions are provided for both building the GraphQL types
for connections and for implementing the
An example usage of these methods from the test schema: ship_edge, ship_connection = connection_definitions(ship_type, "Ship")
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 shows adding a Object IdentificationHelper functions are provided for both building the GraphQL types for nodes and for implementing global IDs around local IDs.
An example usage of these methods from the test schema: 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]
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],
)
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 uses MutationsA helper function is provided for building mutations with single inputs and client mutation IDs.
An example usage of these methods from the test schema: class IntroduceShipMutation:
def __init__(self, shipId, factionId, clientMutationId=None):
self.shipId = shipId
self.factionId = factionId
self.clientMutationId = clientMutationId
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,
)
mutation_type = GraphQLObjectType(
"Mutation", fields=lambda: {"introduceShip": ship_mutation}
) This code creates a mutation named Our mutation type then creates the ContributingAfter cloning this repository from GitHub, we recommend using Poetry to create a test environment. With poetry installed, you do this with the following command: poetry install You can then run the complete test suite like this: poetry run pytest In order to run only a part of the tests with increased verbosity, you can add pytest options, like this: poetry run pytest tests/node -vv In order to check the code style with flake8, use this: poetry run flake8 Use the poetry run tox -e py39 |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论