Sanic-GraphQL
Adds GraphQL support to your Sanic application.
Based on flask-graphql by Syrus Akbary.
Usage
Just use the GraphQLView view from sanic_graphql
from sanic_graphql import GraphQLView
app.add_route(GraphQLView.as_view(schema=Schema, graphiql=True), '/graphql')
# Optional, for adding batch query support (used in Apollo-Client)
app.add_route(GraphQLView.as_view(schema=Schema, batch=True), '/graphql/batch')
This will add /graphql endpoint to your app.
Sharing eventloop with Sanic
In order to pass Sanic’s eventloop to GraphQL’s AsyncioExecutor, use before_start listener:
@app.listener('before_server_start')
def init_graphql(app, loop):
app.add_route(GraphQLView.as_view(schema=Schema, executor=AsyncioExecutor(loop=loop)), '/graphql')
Supported options
schema: The GraphQLSchema object that you want the view to execute when it gets a valid request.
context: A value to pass as the context to the graphql() function. By default is set to dict with request object at key request.
root_value: The root_value you want to provide to executor.execute.
pretty: Whether or not you want the response to be pretty printed JSON.
executor: The Executor that you want to use to execute queries. If an AsyncioExecutor instance is provided, performs queries asynchronously within executor’s loop.
graphiql: If True, may present GraphiQL when loaded directly from a browser (a useful tool for debugging and exploration).
graphiql_template: Inject a Jinja template string to customize GraphiQL.
jinja_env: Sets jinja environment to be used to process GraphiQL template. If Jinja’s async mode is enabled (by enable_async=True), uses Template.render_async instead of Template.render. If environment is not set, fallbacks to simple regex-based renderer.
batch: Set the GraphQL view as batch (for using in Apollo-Client or ReactRelayNetworkLayer)
You can also subclass GraphQLView and overwrite get_root_value(self, request) to have a dynamic root value per request.
class UserRootValue(GraphQLView):
def get_root_value(self, request):
return request.user
License
Copyright for portions of project sanic-graphql are held by Syrus Akbary as part of project flask-graphql. All other copyright for project sanic-graphql are held by Sergey Porivaev.
This project is licensed under MIT License.
Metadata
Release files for Sanic-GraphQL 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| Sanic-GraphQL-1.2.0.tar.gz | 7.5 kB | Without provenance | Details for Sanic-GraphQL-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Sanic_GraphQL-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for Sanic_GraphQL-1.2.0-py3-none-any.whl |
Total release size: 15.7 kB
Release files / Sanic-GraphQL-1.2.0.tar.gz
| Download URL | Sanic-GraphQL-1.2.0.tar.gz |
|---|---|
| Size | 7.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
08bb4ee95bc8ac12dbd351294a5c1b4f401b192a9f338c1b61840220f73fb7e6
|
|
BLAKE2b-256 checksum How to use checksums |
f2e9f04e17c0cecbe52349a9a6582e5749233bb71392354b3c4e1a64024f8445
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.5
|
Release files / Sanic_GraphQL-1.2.0-py3-none-any.whl
| Download URL | Sanic_GraphQL-1.2.0-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8b6a5dc281ef47631563289c5f88585203b32419907ae03abdedac9246b8c028
|
|
BLAKE2b-256 checksum How to use checksums |
15bcda1ac4b94bd4c723210ad1602afdd5bc98e313d786638f74447ef8926eae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.5
|
Security for Sanic-GraphQL 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.