starlette-graphene3 0.3.1

Use Graphene v3 on Starlette

starlette-graphene3

A simple ASGI app for using Graphene v3 with Starlette.

It supports:

• Queries and Mutations (over HTTP or WebSocket)
• Subscriptions (over WebSocket)
• File uploading (https://github.com/jaydenseric/graphql-multipart-request-spec)
• GraphQL Playground

Installation

pip3 install -U starlette-graphene3

Example

import asyncio

import graphene
from graphene_file_upload.scalars import Upload

from starlette.applications import Starlette
from starlette_graphene3 import GraphQLApp


class User(graphene.ObjectType):
    id = graphene.ID()
    name = graphene.String()


class Query(graphene.ObjectType):
    me = graphene.Field(User)

    def resolve_me(root, info):
        return {"id": "john", "name": "John"}


class FileUploadMutation(graphene.Mutation):
    class Arguments:
        file = Upload(required=True)

    ok = graphene.Boolean()

    def mutate(self, info, file, **kwargs):
        return FileUploadMutation(ok=True)


class Mutation(graphene.ObjectType):
    upload_file = FileUploadMutation.Field()


class Subscription(graphene.ObjectType):
    count = graphene.Int(upto=graphene.Int())

    async def subscribe_count(root, info, upto=3):
        for i in range(upto):
            yield i
            await asyncio.sleep(1)


app = Starlette()
schema = graphene.Schema(query=Query, mutation=Mutation, subscription=Subscription)
app.mount("/", GraphQLApp(schema, playground=True))

GraphQLApp

GraphQLApp(schema, [options...])

• (required) schema: graphene.Schema
• (optional) playground (default: True)
• (optional) context_value (default: None)
• (optional) root_value (default: None)
• (optional) middleware (default: None)
• (optional) playground_options: (default: {})