Integrations🔗

In this section, we'll cover the integrations to other libraries that Undine includes.

django-debug-toolbar🔗

Undine integrates with django-debug-toolbar by modifying the debug toolbar so that it works with GraphiQL. After installing the debug toolbar, Undine should automatically patch the toolbar without any additional configuration.

django-modeltranslation🔗

Undine integrates with django-modeltranslation by allowing you to modify how auto-generated Fields, Inputs, Filters and Orders are created. Specifically, this happens using two settings: MODELTRANSLATION_INCLUDE_TRANSLATABLE and MODELTRANSLATION_INCLUDE_TRANSLATIONS.

Let's say you the following model and translation options:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

from django.db import models
from modeltranslation.decorators import register
from modeltranslation.translator import TranslationOptions

# In settings.py:
#
# MODELTRANSLATION_LANGUAGES = ("en", "fi")


class Task(models.Model):
    name = models.CharField(max_length=255)

    # From modeltranslation
    name_en: str | None
    name_fi: str | None


@register(Task)
class TaskTranslationOptions(TranslationOptions):
    fields = ["name"]

As noted in the example, due to the way that django-modeltranslation works, your models will get additional fields for each language you have defined. We'll call the fields for which the translations are created "translatable" fields, and the fields that are created for each language "translation" fields.

Using the MODELTRANSLATION_INCLUDE_TRANSLATABLE and MODELTRANSLATION_INCLUDE_TRANSLATIONS settings, you can control which of these fields undine will add to your schema using auto-generation. By default, only the translation fields are added. You can of course always add the translatable fields manually.

Note that due to the way that django-modeltranslation works, the translation fields are always nullable, even for the default language.

pytest🔗

Undine ships with a pytest plugin that includes a testing client and few fixtures to help you write tests for your GraphQL APIs.

The GraphQLClient class is wrapper around Django's test client that makes testing your GraphQL API easier. It can be added to a test using the graphql fixture. Here is a simple example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

def test_graphql(graphql) -> None:
    # Setup goes here...

    query = """
        query {
          hello
        }
    """

    response = graphql(query)

    assert response.data == {"hello": "Hello, World!"}

GraphQL requests can be made by calling the client as shown above. This makes a request to the GraphQL endpoint set by the GRAPHQL_PATH setting.

GraphQL variables can be passed using the variables argument. If these variables include any files, the client will automatically create a GraphQL multipart request instead of a normal GraphQL request.

The client returns a custom response object GraphQLClientResponse, which has a number of useful properties for introspecting the response. The response object also has details on the database queries that were executed during the request, which can be useful for debugging the performance of your GraphQL API.

The plugin also includes a undine_settings fixture that allows modifying Undine's settings during testing more easily.