Skip to main content

Client library for making graphql calls.

Project description

codecov

Documentation Status

A pythonic interface for making requests to a GraphQL server using standard library or pydantic dataclasses to spare you from string manipulation.

Features

  • Use standard library dataclasses to specify graphql parameters and responses

  • Use pydantic dataclasses to specify graphql parameters and responses that have type validation

  • Use pydantic BaseModels to specify graphql parameters and responses

  • Create and execute GraphQL Queries based upon typed models

  • Create and execute GraphQL Mutations based upon typed models

  • Async support

Installation

pip install gqlclient

with asyncio support

pip install gqlclient[async]

with pydantic support

pip install gqlclient[pydantic]

for developers

pip install gqlclient[test]
pip install pre-commit
pre-commit install

Examples

Query

from pydantic.dataclasses import dataclass

from gqlclient import GraphQLClient

@dataclass
class Parameters:
    attr_one: str
    attr_two: int

@dataclass
class Response:
    attr_three: int
    attr_four: str

client = GraphQLClient(gql_uri="http://localhost:5000/graphql")
parameters = Parameters(attr_one="foo", attr_two=3)
query = client.get_query(query_base="baseType", query_response_cls=Response, query_parameters=parameters)
print(query)
# {'query': '{baseType(filterParams: {attr_one: "foo", attr_two: 3}){attr_three, attr_four} }'}
response = client.execute_gql_query(query_base="baseType", query_response_cls=Response, query_parameters=parameters, response_encoder=json_encoder)
print(response)
# with the default dataclass_encoder
# [Response(attr_three=5, attr_four="bar")]

Mutation

from pydantic.dataclasses import dataclass

from gqlclient import GraphQLClient


@dataclass
class Parameters:
    attr_one: str
    attr_two: int


@dataclass
class Response:
    attr_three: int
    attr_four: str

client = GraphQLClient(gql_uri="http://localhost:5000/graphql")
parameters = Parameters(attr_one="foo", attr_two=3)
query = client.get_mutation(mutation_base="baseMutation", mutation_response_cls=Response, mutation_parameters=parameters)
print(query)
# {'query': 'mutation baseType {baseType(mutateParams: {attr_one: "foo", attr_two: 3}){attr_three, attr_four} }', 'operationName': 'baseType'}

response = client.execute_gql_mutation(mutation_base="baseMutation", mutation_response_cls=Response, mutation_parameters=parameters)
print(response)
# with the default dataclass_encoder
# [Response(attr_three=5, attr_four="bar")]

Encoders

from dataclasses import dataclass

from gqlclient import GraphQLClient
from gqlclient import json_encoder

# set the default encoder to the json_encoder
client = GraphQLClient(gql_uri="http://127.0.0.1:30003/graphql", response_encoder=json_encoder)

@dataclass
class QueryResponse:
    workflowId: int
    workflowName: str
    workflowDescription: str | None

response = client.execute_gql_query("workflows",QueryResponse)
print(response)
# Response is a json formatted string
# {"workflows": [{"workflowId": 1, "workflowName": "gql3_full - workflow_name", "workflowDescription": "gql3_full - workflow_description"}, {"workflowId": 2, "workflowName": "VBI base calibration", "workflowDescription": "The base set of calibration tasks for VBI."}]}

from gqlclient import dataclass_encoder
# for this call override the default encoder
response = client.execute_gql_query("workflows", QueryResponse, response_encoder=dataclass_encoder)
print(response)
# Response type is a list of dataclasses
# [QueryResponse(workflowId=1, workflowName='gql3_full - workflow_name', workflowDescription='gql3_full - workflow_description'), QueryResponse(workflowId=2, workflowName='VBI base calibration', workflowDescription='The base set of calibration tasks for VBI.')]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gqlclient-1.2.3.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

gqlclient-1.2.3-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file gqlclient-1.2.3.tar.gz.

File metadata

  • Download URL: gqlclient-1.2.3.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for gqlclient-1.2.3.tar.gz
Algorithm Hash digest
SHA256 e475c1dbb5dc1b2c2c7b8f3e25a568cef139436d3b2b8325f4445c02444f6949
MD5 1beaaa334e2b5b893a8b22664be6f5e9
BLAKE2b-256 bbf39f0152f84a78a67049ae32c2f2155e711d2d05b3606930af7037ef2e7824

See more details on using hashes here.

File details

Details for the file gqlclient-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: gqlclient-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for gqlclient-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a60c885c3e1a6d126a5c154ebd12d4984b9c2b37c290886230bce415764e1435
MD5 adf332403a87ab360cd43f106d99292d
BLAKE2b-256 6db4fd9ae5363363853e5f9ae85e0b1bed27da0308a1553241a7f25b863ed086

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page