Skip to content

Question utils

question.utils:#

create_question_db(question) #

Creates experiment.actions.form.question object from a Question in the database with key

Parameters:

Name Type Description Default
key

Key of Question

 required
Retuns

experiment.actions.form.Question object

Source code in question/utils.py 
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def create_question_db(question: Question):
    """Creates experiment.actions.form.question object from a Question in the database with key

    Args:
        key: Key of Question

    Retuns:
        experiment.actions.form.Question object
    """

    choices = {}
    for choice in question.choice_set.all():
        choices[choice.key] = choice.text

    if question.type == "LikertQuestion":
        return LikertQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            scale_steps=question.scale_steps,
            choices=choices,
        )
    elif question.type == "LikertQuestionIcon":
        return LikertQuestionIcon(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            scale_steps=question.scale_steps,
        )
    elif question.type == "NumberQuestion":
        return NumberQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            min_value=question.min_value,
            max_value=question.max_value,
        )
    elif question.type == "TextQuestion":
        return TextQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            max_length=question.max_length,
        )
    elif question.type == "BooleanQuestion":
        return BooleanQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            choices=choices,
        )
    elif question.type == "ChoiceQuestion":
        return ChoiceQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            choices=choices,
            min_values=question.min_values,
            view=question.view,
        )
    elif question.type == "AutoCompleteQuestion":
        return AutoCompleteQuestion(
            key=question.key,
            question=question.question,
            explainer=question.explainer,
            choices=choices,
        )

get_unanswered_questions(participant, question_set) #

Return next unasked profile question and prepare its result

Parameters:

Name Type Description Default
participant Participant

participant who will be checked for unanswered questions

 required
questions list[Questions]

list of questions from which to select an unanswered question

 required
randomize bool

optionally, randomize order of questions

 required
cutoff_index int

Maximal index in a questions sequence to consider questions

 required

Yields:

Type Description
Generator

Next unasked profile question
Source code in question/utils.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def get_unanswered_questions(
    participant: Participant, question_set: QuerySet
) -> Generator:
    """Return next unasked profile question and prepare its result

    Args:
        participant (Participant): participant who will be checked for unanswered questions
        questions (list[Questions]): list of questions from which to select an unanswered question
        randomize (bool): optionally, randomize order of questions
        cutoff_index (int): Maximal index in a questions sequence to consider questions

    Yields:
        Next unasked profile question

    """
    keys_answered = participant.profile().values_list('question_key', flat=True)
    for question_obj in question_set:
        if question_obj.key in keys_answered:
            continue
        profile_result = prepare_profile_result(question_obj.key, participant)
        question = create_question_db(question_obj)
        question.result_id = profile_result.id
        yield question

question_by_key(key, questions) #

Return a copy of question with given key

Parameters:

Name Type Description Default
key str

Key of question

 required

Returns:

Type Description

the question, if it exists
Source code in question/utils.py 
20
21
22
23
24
25
26
27
28
29
def question_by_key(key: str, questions: list):
    """Return a copy of question with given key

    Args:
        key (str): Key of question

    Returns:
        the question, if it exists
    """
    return next((question for question in questions if question.key == key), None)