Bonus: Let’s create a quiz!

Creating our quiz

Of course Tiramisu is great to handle options, but here’s a little thing you can do if you’re just bored and don’t know what to do.

So, let’s create a quiz.

First, as always, let’s import everything we need from Tiramisu and create our options:

from sys import exit
from tiramisu import (MetaConfig, Config, OptionDescription,
                      BoolOption, ChoiceOption, StrOption, IntOption,
                      Calculation, Params, ParamOption,
                      default_storage, list_sessions)
from tiramisu.error import ConflictError

We make a dictionary with all questions, proposals and answer:

questions = [{'description': 'what does the cat say?',
              'proposal': ('woof', 'meow'),
              'answer': 'meow'},
             {'description': 'what do you get by mixing blue and yellow?',
              'proposal': ('green', 'red', 'purple'),
              'answer': 'green'},
             {'description': 'where is Bryan?',
              'proposal': ('at school', 'in his bedroom', 'in the kitchen'),
              'answer': 'in the kitchen'},
             {'description': 'which one has 4 legs and 2 wings?',
              'proposal': ('a wyvern', 'a dragon', 'a wyrm', 'a drake'),
              'answer': 'a dragon'},
             {'description': 'why life?',
              'proposal': ('because', 'I don\'t know', 'good question'),
              'answer': 'good question'},
            ]

Now build our Config.

We have to create question option.

Just after, we’re going to define the correct answer in a second option.

The answer is frozen so that when it is set, it cannot change.

And finally a last option that will verify if the answer is correct.

options_obj = []
results_obj = []
for idx, question in enumerate(questions):
    idx += 1
    choice = ChoiceOption('question',
                          question['description'],
                          question['proposal'])
    answer = StrOption('answer',
                       f'Answer {idx}',
                       default=question['answer'],
                       properties=('frozen',))
    boolean = BoolOption('verif',
                         f'Verif of question {idx}',
                         Calculation(verif,
                                     Params((ParamOption(choice),
                                             ParamOption(answer)))),
                         properties=('frozen',))
    optiondescription = OptionDescription(f'question_{idx}',
                                          f'Question {idx}',
                                          [choice, answer, boolean])
    options_obj.append(optiondescription)
    results_obj.append(ParamOption(boolean))

The verif option will us a function that will verify if the answer given by the user (which will become the value of question) is the same as the correct answer (which is the value of answer). Here is this function (of course you have to declare at the begining of your code, before your options) :

def verif(q: str, a: str):
    return q == a

Pretty simple.

At least we’re done with our questions. Let’s just create one last option. This option calculate the result of the students’ answers:

def results(*verif):
    return sum(verif)
options_obj.append(IntOption('res',
                             'Quiz results',
                             Calculation(results,
                                         Params(tuple(results_obj)))))

Now we just have to create our OptionDescription and Config (well it’s a MetaConfig here, but we’ll see this later)…

rootod = OptionDescription('root', '', options_obj)
default_storage.setting(engine="sqlite3")
meta_cfg = MetaConfig([], optiondescription=rootod, persistent=True, session_id="quiz")

… and add some loops to run our quiz!

def run_quiz(meta_cfg: MetaConfig):
    pseudo = input("Enter a name: ")
    try:
        cfg = meta_cfg.config.new(pseudo, persistent=True)
    except ConflictError:
        print(f'Hey {pseudo} you already answered the questionnaire')
        exit()
    cfg.property.read_write()

    for idx, question in enumerate(cfg.option.list(type='optiondescription')):
        question_id = question.option.doc()
        question_obj = question.option('question')
        question_doc = question_obj.option.doc()
        print(f'{question_id}: {question_doc}')
        print(*question_obj.value.list(), sep=" | ")
        while True:
            input_ans = input('Your answer: ')
            try:
                question_obj.value.set(input_ans)
            except ValueError as err:
                err.prefix = ''
                print(err)
            else:
                break
        if question.option('verif').value.get() is True:
            print('Correct answer!')
        else:
            print("Wrong answer... the correct answer was:", question.option('answer').value.get())
        print('')
    qno = idx + 1
    print("Correct answers:", cfg.option('res').value.get(), "out of", qno)
    if cfg.option('res').value.get() == 0 :
        print("Ouch... Maybe next time?")
    elif cfg.option('res').value.get() == qno :
        print("Wow, great job!")

Display results for teacher:

def quiz_results(meta_cfg: MetaConfig):
    for cfg in meta_cfg.config.list():
        print(f"==================== {cfg.config.name()} ==========================")
        for idx, question in enumerate(cfg.option.list(type='optiondescription')):
            if question.option('verif').value.get() is True:
                answer = "correct answer"
            else:
                answer = "wrong answer: " + str(question.option('question').value.get())
            print(question.option.doc() + ': ' + answer)
        qno = idx + 1
        print(f'{cfg.config.name()}\'s score: {cfg.option("res").value.get()} out of {qno}')

Now let’s play !

# reload old sessions
for session_id in list_sessions():
    # our meta config is just here to be a base, so we don't want its session id to be used
    if session_id != "quiz":
        meta_cfg.config.new(session_id, persistent=True)
while True:
    who = input("Who are you? (a student | a teacher): ")
    if who in ['a student', 'a teacher']:
        break
if who == 'a student':
    run_quiz(meta_cfg)
else:
    quiz_results(meta_cfg)

Download the full code

Hey, that was easy ! Almost like I already knew the answers… Oh wait…

Get players results

Now that you have your quiz, you can play with friends! And what’s better than playing with friends? Crushing them by comparing your scores of course! You may have noticed that the previous code had some storage instructions. Now we can create a score board that will give each player’s latest score with their errors !

We created a meta config that will be used as a base for all configs we will create : each time a new player name will be entered, a new config will be created, with the new player’s name as it’s session id. This way, we can see every player’s result !

So, earlier, we created a MetaConfig, and set the storage on sqlite3, so our data will not be deleted after the quiz stops to run.

Let’s run the script:

Who are you? (a student | a teacher): a student

Enter a name: my name

Question 1: what does the cat say?

woof | meow

Your answer: meow

Correct answer!

Question 2: what do you get by mixing blue and yellow?

green | red | purple

Your answer: green

Correct answer!

Question 3: where is Bryan?

at school | in his bedroom | in the kitchen

Your answer: at school

Wrong answer… the correct answer was: in the kitchen

Question 4: which one has 4 legs and 2 wings?

a wyvern | a dragon | a wyrm | a drake

Your answer: a dragon

Correct answer!

Question 5: why life?

because | I don’t know | good question

Your answer: good question

Correct answer!

Correct answers: 4 out of 5

When the quiz runs, we will create a new Config in our MetaConfig:

def run_quiz(meta_cfg: MetaConfig):
    pseudo = input("Enter a name: ")
    try:
        cfg = meta_cfg.config.new(pseudo, persistent=True)
    except ConflictError:
        print(f'Hey {pseudo} you already answered the questionnaire')

All results are store in this config (so in the database). So we need to reload those previous config:

# reload old sessions
for session_id in list_sessions():
    # our meta config is just here to be a base, so we don't want its session id to be used
    if session_id != "quiz":
        meta_cfg.config.new(session_id, persistent=True)

Later, a teacher ca display all those score:

Who are you? (a student | a teacher): a teacher

==================== my name ==========================

Question 1: correct answer

Question 2: correct answer

Question 3: wrong answer: at school

Question 4: correct answer

Question 5: correct answer

my name’s score: 4 out of 5

You’ve got everything now, so it’s your turn to create your own questions and play with your friends !