Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Response models #18

Draft
wants to merge 2 commits into
base: prompt-models
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions app/prompts/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ class BinaryPrompt(Prompt):
positive_answer_label = models.CharField(max_length=64, default="Yes")
negative_answer_label = models.CharField(max_length=64, default="No")

def get_label(self, answer: bool) -> str:
"""
Returns the label given a positive or negative answer
"""
return (
self.positive_answer_label if answer else self.negative_answer_label
)


class RangedPrompt(Prompt):
pass
Expand Down
Empty file added app/responses/__init__.py
Empty file.
99 changes: 99 additions & 0 deletions app/responses/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
from django import forms
from django.contrib import admin
from django.urls import reverse
from django.utils.html import escape
from django.utils.safestring import mark_safe

from app.prompts.admin import get_prompt_viewname
from app.prompts.models import Prompt
from app.responses.models import (
BinaryPromptResponse,
PromptResponse,
RangedPromptResponse,
Response,
TextPromptResponse,
)
from app.utils.admin import (
HideReadOnlyOnCreationAdmin,
SetCreatedByOnCreationAdmin,
)


class PromptResponseForm(forms.ModelForm):
answer = forms.CharField(required=False)

class Meta:
model = PromptResponse
fields = "__all__"


class PromptResponseInline(admin.TabularInline):
model = PromptResponse
form = PromptResponseForm
extra = 0
can_delete = False
ordering = ["prompt__order"]
fields = ["prompt_link", "answer", "uuid"]
list_display = ["uuid"]
readonly_fields = ["uuid", "prompt_link"]

def prompt_link(self, instance: Prompt):
"""
Replaces prompt field in order to include link to the prompt
"""
prompt: Prompt = instance.get_subclass_prompt()
url = reverse(
get_prompt_viewname(prompt), kwargs={"object_id": prompt.id}
)
return mark_safe(f'<a href="{url}">{escape(prompt)}</a>')

prompt_link.short_description = "Prompt"

def get_queryset(self, request):
query_set = super().get_queryset(request)
return query_set.prefetch_related("prompt").select_subclasses(
BinaryPromptResponse, RangedPromptResponse, TextPromptResponse
)


class ResponseAdmin(HideReadOnlyOnCreationAdmin, SetCreatedByOnCreationAdmin):
model = Response
inlines = [PromptResponseInline]

def has_add_permission(self, request, obj=None):
return False

def has_change_permission(self, request, obj=None):
return False

def has_delete_permission(self, request, obj=None):
return False

ordering = ["-created_at"]
readonly_fields = ["uuid", "feedback_form", "url", "metadata"]
fields = [
"uuid",
"feedback_form",
"url",
"metadata",
]
list_display = [
"url",
"prompt_response_count",
"feedback_form",
"created_at",
"uuid",
]
list_filter = [
"feedback_form",
"feedback_form__project",
]
search_fields = ["url", "metadata", "uuid"]

def prompt_response_count(self, obj):
return obj.prompt_responses.count()

prompt_response_count.short_description = "Prompt responses"


admin.site.register(Response, ResponseAdmin)
7 changes: 7 additions & 0 deletions app/responses/apps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from django.apps import AppConfig


class ResponsesConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "app.responses"
verbose_name = "Responses"
30 changes: 30 additions & 0 deletions app/responses/factories.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
from factory.django import DjangoModelFactory

from .models import (
BinaryPromptResponse,
RangedPromptResponse,
Response,
TextPromptResponse,
)


class ResponseFactory(DjangoModelFactory):
class Meta:
model = Response

metadata = {}


class TextPromptResponseFactory(DjangoModelFactory):
class Meta:
model = TextPromptResponse


class BinaryPromptResponseFactory(DjangoModelFactory):
class Meta:
model = BinaryPromptResponse


class RangedPromptResponseFactory(DjangoModelFactory):
class Meta:
model = RangedPromptResponse
56 changes: 56 additions & 0 deletions app/responses/migrations/0001_initial.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Generated by Django 5.1.6 on 2025-02-28 16:58

import uuid

import django.db.models.deletion
from django.db import migrations, models


class Migration(migrations.Migration):

initial = True

dependencies = [
("feedback_forms", "0002_pathpattern"),
]

operations = [
migrations.CreateModel(
name="Response",
fields=[
(
"id",
models.BigAutoField(
auto_created=True,
primary_key=True,
serialize=False,
verbose_name="ID",
),
),
("created_at", models.DateTimeField(auto_now_add=True)),
("modified_at", models.DateTimeField(auto_now=True)),
(
"uuid",
models.UUIDField(
default=uuid.uuid4,
editable=False,
unique=True,
verbose_name="ID",
),
),
("url", models.TextField()),
("metadata", models.JSONField()),
(
"feedback_form",
models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name="+",
to="feedback_forms.feedbackform",
),
),
],
options={
"abstract": False,
},
),
]
131 changes: 131 additions & 0 deletions app/responses/migrations/0002_promptresponses.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Generated by Django 5.1.6 on 2025-03-04 17:28

import uuid

import django.db.models.deletion
from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
("prompts", "0003_rangedprompt_rangedpromptoption"),
("responses", "0001_initial"),
]

operations = [
migrations.CreateModel(
name="PromptResponse",
fields=[
(
"id",
models.BigAutoField(
auto_created=True,
primary_key=True,
serialize=False,
verbose_name="ID",
),
),
("created_at", models.DateTimeField(auto_now_add=True)),
("modified_at", models.DateTimeField(auto_now=True)),
(
"uuid",
models.UUIDField(
default=uuid.uuid4,
editable=False,
unique=True,
verbose_name="ID",
),
),
(
"prompt",
models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name="+",
to="prompts.prompt",
),
),
(
"response",
models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name="prompt_responses",
to="responses.response",
),
),
],
options={
"abstract": False,
},
),
migrations.CreateModel(
name="BinaryPromptResponse",
fields=[
(
"promptresponse_ptr",
models.OneToOneField(
auto_created=True,
on_delete=django.db.models.deletion.CASCADE,
parent_link=True,
primary_key=True,
serialize=False,
to="responses.promptresponse",
),
),
("value", models.BooleanField()),
],
options={
"abstract": False,
},
bases=("responses.promptresponse",),
),
migrations.CreateModel(
name="TextPromptResponse",
fields=[
(
"promptresponse_ptr",
models.OneToOneField(
auto_created=True,
on_delete=django.db.models.deletion.CASCADE,
parent_link=True,
primary_key=True,
serialize=False,
to="responses.promptresponse",
),
),
("value", models.TextField()),
],
options={
"abstract": False,
},
bases=("responses.promptresponse",),
),
migrations.CreateModel(
name="RangedPromptResponse",
fields=[
(
"promptresponse_ptr",
models.OneToOneField(
auto_created=True,
on_delete=django.db.models.deletion.CASCADE,
parent_link=True,
primary_key=True,
serialize=False,
to="responses.promptresponse",
),
),
(
"value",
models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name="+",
to="prompts.rangedpromptoption",
),
),
],
options={
"abstract": False,
},
bases=("responses.promptresponse",),
),
]
Empty file.
Loading