pymoxquizz.py 5.46 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
#!/usr/bin/env python
## -*- coding: utf-8 -*-
from __future__ import unicode_literals, print_function
from io import open


class Question:
    """
    Represents one MoxQuizz question.
    """

    category = None
    question = None
    answer = None
    regexp = None
    author = None
    level = None
    comment = None
    score = 0
    tip = list()
    tipcycle = 0

    TRIVIAL = 1
    EASY = 2
    NORMAL = 3
    HARD = 4
    EXTREME = 5

    LEVELS = (TRIVIAL, EASY, NORMAL, HARD, EXTREME)

    def __init__(self, attributes_dict):
        self.parse(attributes_dict)

    def parse(self, attributes_dict):
        """
        Populate fields from a dictionary of attributes (from a question bank).
        """

        ## Valid keys:
        #  ----------
        #  Category?                              (should always be on top!)
        #  Question                               (should always stand after Category)
        #  Answer                                 (will be matched if no regexp is provided)
        #  Regexp?                                (use UNIX-style expressions)
        #  Author?                                (the brain behind this question)
        #  Level? [baby|easy|normal|hard|extreme] (difficulty)
        #  Comment?                               (comment line)
        #  Score? [#]                             (credits for answering this question)
        #  Tip*                                   (provide one or more hints)
        #  TipCycle? [#]                          (Specify number of generated tips)

        if 'Question' in attributes_dict.keys():
            self.question = attributes_dict['Question']
        else:
            raise Exception("Cannot instantiate Question: 'Question' attribute required.")

        if 'Category' in attributes_dict.keys():
            self.category = attributes_dict['Category']

        if 'Answer' in attributes_dict.keys():
            self.answer = attributes_dict['Answer']
        else:
            raise Exception("Cannot instantiate Question: 'Answer' attribute required.")

        if 'Regexp' in attributes_dict.keys():
            self.regexp = attributes_dict['Regexp']

        if 'Author' in attributes_dict.keys():
            self.category = attributes_dict['Author']

        if 'Level' in attributes_dict.keys() and attributes_dict['Level'] in self.LEVELS:
            self.level = attributes_dict['level']

        if 'Comment' in attributes_dict.keys():
            self.comment = attributes_dict['Comment']

        if 'Score' in attributes_dict.keys():
            self.score = attributes_dict['Score']

        if 'Tip' in attributes_dict.keys():
            self.tip = attributes_dict['Tip']

        if 'Tipcycle' in attributes_dict.keys():
            self.tipcycle = attributes_dict['Tipcycle']


class QuestionBank:
    """
    Represents a MoxQuizz question bank.
    """

    filename = ''
    questions = list()

    # Case sensitive, to remain backwards-compatible with MoxQuizz.
    KEYS = ('Answer',
            'Author',
            'Category',
            'Comment',
            'Level',
            'Question',
            'Regexp',
            'Score',
            'Tip',
            'Tipcycle',
            )

    def __init__(self, filename):
        """
        Construct a question bank from a file.
        """
        self.filename = filename
        self.questions = self.parse(filename)

    def parse(self, filename):
        """
        Read a Moxquizz question bank file into a list.
        """
        questions = list()

        with open(filename) as f:
            key = ''
            i = 0

            # new question
            q = dict()
            q['Tip'] = list()

            for line in f:
                line = line.strip()
                i += 1

                # Ignore comments.
                if line.startswith('#'):
                    continue

                # A blank line starts a new question.
                if line == '':
                    # Store the previous question, if valid.
                    if 'Question' in q.keys() and 'Answer' in q.keys():
                        question = Question(q)
                        questions.append(question)

                    # Start a new question.
                    q = dict()
                    q['Tip'] = list()
                    continue

                # Fetch the next parameter.
                try:
                    (key, value) = line.split(':', 1)
                except ValueError:
                    print("Unexpected weirdness in MoxQuizz questionbank '%s', line %s." % (self.filename, i))
                    continue
                    # break  # TODO: is it appropriate to bail on broken bank files?

                # Ignore bad parameters.
                if key not in self.KEYS:
                    print("Unexpected key '%s' in MoxQuizz questionbank '%s', line %s." % (key, self.filename, i))
                    continue

                # Enumerate the Tips.
                if key == 'Tip':
                    q['Tip'].append(value.strip())
                else:
                    q[key] = value.strip()

        return questions


# A crappy test.
if __name__ == '__main__':
    qb = QuestionBank('questions.doctorlard.en')
    for q in qb.questions:
        print(q.question)
        a = unicode(raw_input('A: '), 'utf8')
        #a = input('A: ')  # Python 3
        if a.lower() == q.answer.lower():
            print("Correct!")
        else:
            print("Incorrect - the answer is '%s'" % q.answer)