Undine - GraphQL for Django
pip install undine
Documentation: https://mrthearman.github.io/undine/
Source Code: https://github.com/MrThearMan/undine/
Contributing: https://mrthearman.github.io/undine/contributing/
Undine is a GraphQL library for Django. It's designed to be easy to use and extend while providing out-of-the-box solutions for many common issues GraphQL developers face.
Feature highlights:
- Automatic generation of GraphQL types from Django models
- Automatic query optimization
- Logically composable filtering
- Ordering based on enums
- Single and bulk mutations, including relations
- Hidden and input-only mutation inputs
- Built-in permission and validation hooks
- Support for Relay Global object IDs and Connection pagination
- File uploads based on GraphQL multipart request specification
- Support for asynchronous execution and DataLoaders
- Subscriptions with WebSockets, Server-Sent Events, or Multipart HTTP
- Server-side query caching
- Optional persisted documents support
- Lifecycle hooks for customizing the GraphQL request cycle
- Hiding fields and types from schema (experimental)
- Incremental delivery (experimental)
- Built-in testing tools
Check out the Tutorial to get started.
import asyncio
from collections.abc import AsyncIterator
from typing import Any
from undine import (
Entrypoint,
Field,
Filter,
FilterSet,
GQLInfo,
Input,
MutationType,
Order,
OrderSet,
QueryType,
RootType,
create_schema,
)
from undine.exceptions import GraphQLPermissionError, GraphQLValidationError
from undine.relay import Connection, Node
from undine.subscriptions import ModelCreateSubscription
from .models import Task
class TaskFilterSet(FilterSet[Task]):
name = Filter(lookup="icontains")
done = Filter()
class TaskOrderSet(OrderSet[Task]):
id = Order()
name = Order(null_placement="last")
@Node
@TaskFilterSet
@TaskOrderSet
class TaskType(QueryType[Task], schema_name="Task"):
pk = Field()
name = Field()
@name.permissions
def name_permissions(self, instance: Task, info: GQLInfo) -> None:
if not info.context.user.is_authenticated:
raise GraphQLPermissionError
class TaskCreateMutation(MutationType[Task]):
name = Input()
done = Input(default_value=False)
@classmethod
def __permissions__(cls, instance: Task, info: GQLInfo, input_data: dict[str, Any]) -> None:
if not info.context.user.is_staff:
msg = "Only staff members can create tasks"
raise GraphQLPermissionError(msg)
@classmethod
def __validate__(cls, instance: Task, info: GQLInfo, input_data: dict[str, Any]) -> None:
if len(input_data["name"]) < 3:
msg = "Task name must be at least 3 characters"
raise GraphQLValidationError(msg)
class Query(RootType):
node = Entrypoint(Node)
task = Entrypoint(TaskType, cache_time=10)
tasks = Entrypoint(Connection(TaskType))
class Mutation(RootType):
create_task = Entrypoint(TaskCreateMutation)
bulk_create_tasks = Entrypoint(TaskCreateMutation, many=True)
class Subscription(RootType):
task_created = Entrypoint(ModelCreateSubscription(TaskType))
@Entrypoint
async def countdown(self, info: GQLInfo) -> AsyncIterator[int]:
for i in range(10, -1, -1):
yield i
await asyncio.sleep(1)
schema = create_schema(query=Query, mutation=Mutation, subscription=Subscription)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
undine-0.3.7.tar.gz
(246.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
undine-0.3.7-py3-none-any.whl
(328.8 kB
view details)
File details
Details for the file undine-0.3.7.tar.gz.
File metadata
- Download URL: undine-0.3.7.tar.gz
- Upload date:
- Size: 246.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.3.2 CPython/3.14.6 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5ac78e730486bb00d281e2848f8c097a330f1dc71523c49475fa92902177fbe
|
|
| MD5 |
e86537df30fb0753135d1a14a8d39922
|
|
| BLAKE2b-256 |
a00b894029f9cd3fa3a81af746e231d2336aacfc6b35efd59b94c29211d00f48
|
File details
Details for the file undine-0.3.7-py3-none-any.whl.
File metadata
- Download URL: undine-0.3.7-py3-none-any.whl
- Upload date:
- Size: 328.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.3.2 CPython/3.14.6 Linux/6.17.0-1020-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e39715fb68bd6a8e84c623a4531cecc7a6fb31e9f6aa7eecb4110c612aa10cef
|
|
| MD5 |
b78a62bd89ed0321c2b007fc7687d8f5
|
|
| BLAKE2b-256 |
f3306af617c0f48a1871456dcf506ae5a545ae7de1dbe35c9b2239654a8f58b1
|
