QuerySetGlue Guide

Purpose

QuerySetGlue allows the user to access a Django QuerySet from the front end.

When to use

• When you need to access to multiple Django Model objects for front end functionality.
  • Ex: Glueing a Django QuerySet in order to select one from a glue select field.

When not to use

• When jinja templates can also complete what you need to do.
  • Ex: Looping over a Django QuerySet to display information.

Shortcut Method

django_glue.shortcuts.glue_query_set

Source code in django_glue/shortcuts.py

def glue_query_set(
        request: HttpRequest,
        unique_name: str,
        target: QuerySet,
        access: str = 'view',
        fields: Union[list, tuple] = (ALL_DUNDER_KEY,),
        exclude: Union[list, tuple] = (NONE_DUNDER_KEY,),
        methods: Union[list, tuple] = (NONE_DUNDER_KEY,),
) -> None:
    glue_query_set_entity = QuerySetGlue(
        unique_name=encode_unique_name(request, unique_name),
        query_set=target,
        access=access,
        included_fields=fields,
        excluded_fields=exclude,
        included_methods=methods
    )

    _glue_base_function(request, glue_query_set_entity)

How To Use

1. Import django_glue.

import django_glue as dg

1. Get the Django QuerySet you need access to on the front end.

import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

1. Use the shortcut method glue_queryset_object(request, <str:unique_name>, <QuerySet:query_set>) to glue the model objects in the query set to the glue session data.

import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

    dg.glue_query_set(request=request, unique_name='adults', target=adults)

    ... update form logic ...

1. On the front end using AlpineJS, initialize a new glue query set with the same unique name you specified in step 3.

<div
    x-data="{
        adult_query_set: new QuerySetGlue('adults')
    }"
></div>

1. Call the all method on the glue query set to retrieve the data from the Django Model Objects in the query set.

<div
    x-data="{
        adults: [],
        adult_query_set: new QuerySetGlue('adults'),
        async init() {
            this.adults = await this.adult_query_set.all()
        }
    }"
></div>

Full Example

Back End

import django_glue as dg

from app.people.models import Person


def person_update_form_view(request, pk):
    adults = Person.objects.filter(age > 17)

    dg.glue_query_set(request=request, unique_name='adults', target=adults)

    ... update form logic ...

    return TemplateResponse(
        request=request,
        template='person/form/update_form.html',
        context={}
    )

Front End

<div
    x-data="{
        adults: [],
        adult_query_set: new QuerySetGlue('adults'),
        async init() {
            this.adults = await this.adult_query_set.all()
        }
    }"
></div>

Query Set Choices

Glue query set also has a to_choices method that can be used to retrieve the data from the Django Model Objects in the query set.

Back End

Choices Class

class CarTypes(TextChoices):
    SEDAN = 'sed', 'Sedan - 4-door passenger vehicle'
    SUV = 'suv', 'SUV - Sport Utility Vehicle'
    TRUCK = 'trk', 'Truck - Heavy-duty pickup truck'
    HATCHBACK = 'htc', 'Hatchback - Compact car with rear door'
    COUPE = 'cpe', 'Coupe - 2-door sporty vehicle'

View

def update_form_view(request, pk):
    car = Car.objects.get(pk=pk)
    brands = Brand.objects.all()

    dg.glue_model_object(request=request, unique_name='car', target=car)
    # Get choices from query set
    dg.glue_query_set(request=request, unique_name='brands', target=brands)

    return TemplateResponse(
        request=request,
        template='car/form/update_form.html',
        context={
            # Get choices from choices class
            'car_type_choices': json.dumps(CarTypes.choices),
        }
    )

Front End

<div
    x-data="{
        car: new ModelObjectGlue('car'),
        brand_query_set: new QuerySetGlue('brands'),
        async init() {
            await this.car.get()
            let brand_choices = await this.brand_query_set.choices()
            <!-- Get choices from query set -->
            this.car.glue_fields.brand.choices = brand_choices
            <!-- Get choices from choices class -->
            this.car.glue_fields.type.choices = {{ car_type_choices }}
        },
    }"
>
    { % include 'django_glue/form/field/select_field.html' with glue_model_field='car.brand' %}
</div>

More Information

See QuerySetGlue for the different methods available for QuerySetGlue objects on the front end.