#!/usr/bin/env python
"""
camcops_server/tasks/suppsp.py
===============================================================================
Copyright (C) 2012, University of Cambridge, Department of Psychiatry.
Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CamCOPS.
CamCOPS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CamCOPS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CamCOPS. If not, see <https://www.gnu.org/licenses/>.
===============================================================================
**Short UPPS-P Impulsive Behaviour Scale (SUPPS-P) task.**
"""
from camcops_server.cc_modules.cc_constants import CssClass
from camcops_server.cc_modules.cc_html import tr_qa, tr, answer
from camcops_server.cc_modules.cc_request import CamcopsRequest
from camcops_server.cc_modules.cc_sqla_coltypes import (
CamcopsColumn,
ONE_TO_FOUR_CHECKER,
)
from camcops_server.cc_modules.cc_summaryelement import SummaryElement
from camcops_server.cc_modules.cc_task import (
TaskHasPatientMixin,
Task,
get_from_dict,
)
from camcops_server.cc_modules.cc_text import SS
from cardinal_pythonlib.stringfunc import strseq
from sqlalchemy import Integer
from sqlalchemy.ext.declarative import DeclarativeMeta
from typing import List, Type, Tuple, Dict, Any
class SuppspMetaclass(DeclarativeMeta):
# noinspection PyInitNewSignature
def __init__(
cls: Type["Suppsp"],
name: str,
bases: Tuple[Type, ...],
classdict: Dict[str, Any],
) -> None:
comment_strings = [
"see to end",
"careful and purposeful",
"problem situations",
"unfinished bother",
"stop and think",
"do things regret",
"hate to stop",
"can't stop what I'm doing",
"enjoy risks",
"lose control",
"finish",
"rational sensible",
"act without thinking upset",
"new and exciting",
"say things regret",
"airplane",
"others shocked",
"skiing",
"think carefully",
"act without thinking excited",
]
reverse_questions = {3, 6, 8, 9, 10, 13, 14, 15, 16, 17, 18, 20}
for q_index in range(0, cls.N_QUESTIONS):
q_num = q_index + 1
q_field = "q{}".format(q_num)
score_comment = "(1 strongly agree - 4 strongly disagree)"
if q_num in reverse_questions:
score_comment = "(1 strongly disagree - 4 strongly agree)"
setattr(
cls,
q_field,
CamcopsColumn(
q_field,
Integer,
permitted_value_checker=ONE_TO_FOUR_CHECKER,
comment="Q{} ({}) {}".format(
q_num, comment_strings[q_index], score_comment
),
),
)
super().__init__(name, bases, classdict)
[docs]class Suppsp(TaskHasPatientMixin, Task, metaclass=SuppspMetaclass):
__tablename__ = "suppsp"
shortname = "SUPPS-P"
N_QUESTIONS = 20
MIN_SCORE_PER_Q = 1
MAX_SCORE_PER_Q = 4
MIN_SCORE = MIN_SCORE_PER_Q * N_QUESTIONS
MAX_SCORE = MAX_SCORE_PER_Q * N_QUESTIONS
N_Q_PER_SUBSCALE = 4 # always
MIN_SUBSCALE = MIN_SCORE_PER_Q * N_Q_PER_SUBSCALE
MAX_SUBSCALE = MAX_SCORE_PER_Q * N_Q_PER_SUBSCALE
ALL_QUESTIONS = strseq("q", 1, N_QUESTIONS)
NEGATIVE_URGENCY_QUESTIONS = Task.fieldnames_from_list("q", {6, 8, 13, 15})
LACK_OF_PERSEVERANCE_QUESTIONS = Task.fieldnames_from_list(
"q", {1, 4, 7, 11}
)
LACK_OF_PREMEDITATION_QUESTIONS = Task.fieldnames_from_list(
"q", {2, 5, 12, 19}
)
SENSATION_SEEKING_QUESTIONS = Task.fieldnames_from_list(
"q", {9, 14, 16, 18}
)
POSITIVE_URGENCY_QUESTIONS = Task.fieldnames_from_list(
"q", {3, 10, 17, 20}
)
[docs] @staticmethod
def longname(req: "CamcopsRequest") -> str:
_ = req.gettext
return _("Short UPPS-P Impulsive Behaviour Scale")
[docs] def get_summaries(self, req: CamcopsRequest) -> List[SummaryElement]:
subscale_range = f"[{self.MIN_SUBSCALE}–{self.MAX_SUBSCALE}]"
return self.standard_task_summary_fields() + [
SummaryElement(
name="total",
coltype=Integer(),
value=self.total_score(),
comment=f"Total score [{self.MIN_SCORE}–{self.MAX_SCORE}]",
),
SummaryElement(
name="negative_urgency",
coltype=Integer(),
value=self.negative_urgency_score(),
comment=f"Negative urgency {subscale_range}",
),
SummaryElement(
name="lack_of_perseverance",
coltype=Integer(),
value=self.lack_of_perseverance_score(),
comment=f"Lack of perseverance {subscale_range}",
),
SummaryElement(
name="lack_of_premeditation",
coltype=Integer(),
value=self.lack_of_premeditation_score(),
comment=f"Lack of premeditation {subscale_range}",
),
SummaryElement(
name="sensation_seeking",
coltype=Integer(),
value=self.sensation_seeking_score(),
comment=f"Sensation seeking {subscale_range}",
),
SummaryElement(
name="positive_urgency",
coltype=Integer(),
value=self.positive_urgency_score(),
comment=f"Positive urgency {subscale_range}",
),
]
[docs] def is_complete(self) -> bool:
if self.any_fields_none(self.ALL_QUESTIONS):
return False
if not self.field_contents_valid():
return False
return True
def total_score(self) -> int:
return self.sum_fields(self.ALL_QUESTIONS)
def negative_urgency_score(self) -> int:
return self.sum_fields(self.NEGATIVE_URGENCY_QUESTIONS)
def lack_of_perseverance_score(self) -> int:
return self.sum_fields(self.LACK_OF_PERSEVERANCE_QUESTIONS)
def lack_of_premeditation_score(self) -> int:
return self.sum_fields(self.LACK_OF_PREMEDITATION_QUESTIONS)
def sensation_seeking_score(self) -> int:
return self.sum_fields(self.SENSATION_SEEKING_QUESTIONS)
def positive_urgency_score(self) -> int:
return self.sum_fields(self.POSITIVE_URGENCY_QUESTIONS)
[docs] def get_task_html(self, req: CamcopsRequest) -> str:
normal_score_dict = {
None: None,
1: "1 — " + self.wxstring(req, "a0"),
2: "2 — " + self.wxstring(req, "a1"),
3: "3 — " + self.wxstring(req, "a2"),
4: "4 — " + self.wxstring(req, "a3"),
}
reverse_score_dict = {
None: None,
4: "4 — " + self.wxstring(req, "a0"),
3: "3 — " + self.wxstring(req, "a1"),
2: "2 — " + self.wxstring(req, "a2"),
1: "1 — " + self.wxstring(req, "a3"),
}
reverse_q_nums = {3, 6, 8, 9, 10, 13, 14, 15, 16, 17, 18, 20}
fullscale_range = f"[{self.MIN_SCORE}–{self.MAX_SCORE}]"
subscale_range = f"[{self.MIN_SUBSCALE}–{self.MAX_SUBSCALE}]"
rows = ""
for q_num in range(1, self.N_QUESTIONS + 1):
q_field = "q" + str(q_num)
question_cell = "{}. {}".format(q_num, self.wxstring(req, q_field))
score = getattr(self, q_field)
score_dict = normal_score_dict
if q_num in reverse_q_nums:
score_dict = reverse_score_dict
answer_cell = get_from_dict(score_dict, score)
rows += tr_qa(question_cell, answer_cell)
html = """
<div class="{CssClass.SUMMARY}">
<table class="{CssClass.SUMMARY}">
{tr_is_complete}
{total_score}
{negative_urgency_score}
{lack_of_perseverance_score}
{lack_of_premeditation_score}
{sensation_seeking_score}
{positive_urgency_score}
</table>
</div>
<table class="{CssClass.TASKDETAIL}">
<tr>
<th width="60%">Question</th>
<th width="40%">Score</th>
</tr>
{rows}
</table>
<div class="{CssClass.FOOTNOTES}">
[1] Sum for questions 1–20.
[2] Sum for questions 6, 8, 13, 15.
[3] Sum for questions 1, 4, 7, 11.
[4] Sum for questions 2, 5, 12, 19.
[5] Sum for questions 9, 14, 16, 18.
[6] Sum for questions 3, 10, 17, 20.
</div>
""".format(
CssClass=CssClass,
tr_is_complete=self.get_is_complete_tr(req),
total_score=tr(
req.sstring(SS.TOTAL_SCORE) + " <sup>[1]</sup>",
f"{answer(self.total_score())} {fullscale_range}",
),
negative_urgency_score=tr(
self.wxstring(req, "negative_urgency") + " <sup>[2]</sup>",
f"{answer(self.negative_urgency_score())} {subscale_range}",
),
lack_of_perseverance_score=tr(
self.wxstring(req, "lack_of_perseverance") + " <sup>[3]</sup>",
f"{answer(self.lack_of_perseverance_score())} {subscale_range}", # noqa: E501
),
lack_of_premeditation_score=tr(
self.wxstring(req, "lack_of_premeditation")
+ " <sup>[4]</sup>",
f"{answer(self.lack_of_premeditation_score())} {subscale_range}", # noqa: E501
),
sensation_seeking_score=tr(
self.wxstring(req, "sensation_seeking") + " <sup>[5]</sup>",
f"{answer(self.sensation_seeking_score())} {subscale_range}",
),
positive_urgency_score=tr(
self.wxstring(req, "positive_urgency") + " <sup>[6]</sup>",
f"{answer(self.positive_urgency_score())} {subscale_range}",
),
rows=rows,
)
return html