Question

question.models:

Choice

Bases: Model

Choice model for Question with choices

Attributes:

Name	Type	Description
key	slug	Unique identifier
text	str	Choice text
index	int	Index of choice within Question
question	Question	Question that contains the Choice

Source code in question/models.py

class Choice(models.Model):
    """ Choice model for Question with choices

    Attributes:
        key (slug): Unique identifier
        text (str): Choice text
        index (int): Index of choice within Question
        question (Question): Question that contains the Choice

    """

    key = models.SlugField(max_length=128)
    text = models.CharField()
    index = models.PositiveIntegerField(default=0)
    question = models.ForeignKey(Question, on_delete=models.CASCADE)

    class Meta:
        ordering = ["index"]

Question

Bases: Model

Model for question asked during experiment

Attributes:

Name	Type	Description
key	slug	Unique identifier
question	str	Question text
editable	bool	False for built-in questions. Key and type of a built-in question cannot be changed.
explainer	str	Question explainer text
type	str	Question type {“BooleanQuestion”, “ChoiceQuestion”, “NumberQuestion”, “TextQuestion”, “LikertQuestion”, “LikertQuestionIcon”, “AutoCompleteQuestion”}
scale_steps	int	Number of scale steps {5, 7} (applies to LikertQuestion, LikertQuestionIcon)
profile_scoring_rule	str	Profile scoring rule {“”, “LIKERT”, “REVERSE_LIKERT”, “CATEGORIES_TO_LIKERT”} (ChoiceQuestion, LikertQuestion)
min_value	float	Minimal value (NumberQuestion)
max_value	float	Maximal value (NumberQuestion)
max_length	int	Maximal length (TextQuestion)
min_values	int	Minimum number of values to choose (ChoiceQuestion)
view	int	Question view {“BUTTON_ARRAY”, “CHECKBOXES”, “RADIOS”, “DROPDOWN”} (ChoiceQuestion)
is_skippable	bool	If question can be skipped during experiment

Source code in question/models.py

class Question(models.Model):
    """Model for question asked during experiment

    Attributes:
        key (slug): Unique identifier
        question (str): Question text
        editable (bool): False for built-in questions. Key and type of a built-in question cannot be changed.
        explainer (str): Question explainer text
        type (str): Question type {"BooleanQuestion", "ChoiceQuestion", "NumberQuestion", "TextQuestion", "LikertQuestion", "LikertQuestionIcon", "AutoCompleteQuestion"}
        scale_steps (int): Number of scale steps {5, 7} (applies to LikertQuestion, LikertQuestionIcon)
        profile_scoring_rule (str): Profile scoring rule {"", "LIKERT", "REVERSE_LIKERT", "CATEGORIES_TO_LIKERT"} (ChoiceQuestion, LikertQuestion)
        min_value (float): Minimal value (NumberQuestion)
        max_value (float): Maximal value (NumberQuestion)
        max_length (int): Maximal length (TextQuestion)
        min_values (int): Minimum number of values to choose (ChoiceQuestion)
        view (int): Question view {"BUTTON_ARRAY", "CHECKBOXES", "RADIOS", "DROPDOWN"} (ChoiceQuestion)
        is_skippable (bool): If question can be skipped during experiment

    """

    key = models.SlugField(primary_key=True, max_length=128)
    question = models.CharField(max_length=1024)
    editable = models.BooleanField(default=True, editable=False)

    explainer=models.TextField(blank=True, default="")

    TYPES = [
        ("", "---------"),
        ("BooleanQuestion", "BooleanQuestion"),
        ("ChoiceQuestion", "ChoiceQuestion"),
        ("NumberQuestion", "NumberQuestion"),
        ("TextQuestion", "TextQuestion"),
        ("LikertQuestion", "LikertQuestion"),
        ("LikertQuestionIcon", "LikertQuestionIcon"),
        ("AutoCompleteQuestion", "AutoCompleteQuestion"),
    ]
    type = models.CharField(max_length=128, default="", choices=TYPES)

    SCALE_STEPS = [(5,5),(7,7)]
    scale_steps = models.IntegerField(choices=SCALE_STEPS, default=7)

    PROFILE_SCORING_RULES = [
        ("LIKERT", "LIKERT"),
        ("REVERSE_LIKERT", "REVERSE_LIKERT"),
        ("CATEGORIES_TO_LIKERT", "CATEGORIES_TO_LIKERT"),
    ]
    profile_scoring_rule = models.CharField(blank = True, max_length=128,  default="", choices=PROFILE_SCORING_RULES)

    # NumberQuestion
    min_value = models.FloatField(default=0)
    max_value = models.FloatField(default=120)

    # TextQuestion
    max_length = models.IntegerField(default=64)

    # ChoiceQuestion
    min_values = models.IntegerField(default=1)
    VIEWS = [
        ("BUTTON_ARRAY", "BUTTON_ARRAY"),
        ("CHECKBOXES", "CHECKBOXES"),
        ("RADIOS", "RADIOS"),
        ("DROPDOWN", "DROPDOWN"),
    ]
    view = models.CharField(max_length=128, default="", choices=VIEWS)

    is_skippable = models.BooleanField(default=False)

    def __str__(self):
        return "(" + self.key + ") " + self.question

    class Meta:
        ordering = ["key"]

QuestionGroup

Bases: Model

Convenience model for groups of questions to add at once to Block QuestionSeries from admin

Attributes:

Name	Type	Description
key	str	Unique identifier
questions	Queryset[Question]	ManyToManyField to Questions that the QuestionGroup contains
editable	bool	QuestionGroup can be edited if True

Source code in question/models.py

class QuestionGroup(models.Model):
    """Convenience model for groups of questions to add at once to Block QuestionSeries from admin

    Attributes:
        key (str): Unique identifier
        questions (Queryset[Question]): ManyToManyField to Questions that the QuestionGroup contains
        editable (bool): QuestionGroup can be edited if True

    """

    key = models.CharField(primary_key=True, max_length=128)
    questions = models.ManyToManyField(Question)
    editable = models.BooleanField(default=True, editable=False)

    class Meta:
        ordering = ["key"]
        verbose_name_plural = "Question Groups"

    def __str__(self):
        return self.key

QuestionInSeries

Bases: Model

Question with its index in QuestionSeries

Attributes:

Name	Type	Description
question_series	QuestionSeries	QuestionSeries that contains the Question
question	Question	Question linked to question_series
index	int	Index of Question within QuestionSeries

Source code in question/models.py

class QuestionInSeries(models.Model):
    """Question with its index in QuestionSeries

    Attributes:
        question_series (QuestionSeries): QuestionSeries that contains the Question
        question (Question): Question linked to question_series
        index (int): Index of Question within QuestionSeries
    """

    question_series = models.ForeignKey(QuestionSeries, on_delete=models.CASCADE)
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    index = models.PositiveIntegerField(default=0)

    class Meta:
        unique_together = ("question_series", "question")
        ordering = ["index"]
        verbose_name_plural = "Question In Series objects"

QuestionSeries

Bases: Model

Series of Questions asked in a Block

Attributes:

Name	Type	Description
name	str	Name of the QuestionSeries
block	Block	Block that contains QuestionSeries
index	int	Index of QuestionSeries within Block
questions	Queryset[Question]	ManyToManyField to Questions that the QuestionSeries contains
randomize	bool	Randomize questions within QuestionSeries

Source code in question/models.py

class QuestionSeries(models.Model):
    """Series of Questions asked in a Block

    Attributes:
        name (str): Name of the QuestionSeries
        block (Block): Block that contains QuestionSeries
        index (int):  Index of QuestionSeries within Block
        questions (Queryset[Question]): ManyToManyField to Questions that the QuestionSeries contains
        randomize (bool): Randomize questions within QuestionSeries
    """

    name = models.CharField(default="", max_length=128)
    block = models.ForeignKey(Block, on_delete=models.CASCADE)
    index = models.PositiveIntegerField()  # index of QuestionSeries within Block
    questions = models.ManyToManyField(Question, through="QuestionInSeries")
    randomize = models.BooleanField(default=False)  # randomize questions within QuestionSeries

    class Meta:
        ordering = ["index"]
        verbose_name_plural = "Question Series"

    def __str__(self):
        return "QuestionSeries object ({}): {} questions".format(self.id, self.questioninseries_set.count() if self.pk else 0)