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
182
183
184
185
186
187
188
189
190
191
192
193
|
import time
from collections.abc import Iterable
from random import randrange
from string import ascii_uppercase
from typing import NamedTuple, TypedDict
DEFAULT_QUESTION_POINTS = 10
DEFAULT_QUESTION_TIME = 20
class QuestionData(TypedDict):
"""Representing the different 'keys' of the question taken from the JSON."""
number: str
description: str
answers: list[str]
correct: str
points: int | None
time: int | None
class UserGuess(NamedTuple):
"""Represents the user's guess for a question."""
answer: str
editable: bool
elapsed: float
class QuestionClosedError(RuntimeError):
"""Exception raised when the question is not open for guesses anymore."""
class AlreadyUpdatedError(RuntimeError):
"""Exception raised when the user has already updated their guess once."""
class AllQuestionsVisitedError(RuntimeError):
"""Exception raised when all of the questions have been visited."""
class Question:
"""Interface for one question in a trivia night game."""
def __init__(self, data: QuestionData):
self._data = data
self._guesses: dict[int, UserGuess] = {}
self._started = None
# These properties are mostly proxies to the underlying data:
@property
def number(self) -> str:
"""The number of the question."""
return self._data["number"]
@property
def description(self) -> str:
"""The description of the question."""
return self._data["description"]
@property
def answers(self) -> list[tuple[str, str]]:
"""
The possible answers for this answer.
This is a property that returns a list of letter, answer pairs.
"""
return [(ascii_uppercase[i], q) for (i, q) in enumerate(self._data["answers"])]
@property
def correct(self) -> str:
"""The correct answer for this question."""
return self._data["correct"]
@property
def max_points(self) -> int:
"""The maximum points that can be awarded for this question."""
return self._data.get("points") or DEFAULT_QUESTION_POINTS
@property
def time(self) -> float:
"""The time allowed to answer the question."""
return self._data.get("time") or DEFAULT_QUESTION_TIME
def start(self) -> float:
"""Start the question and return the time it started."""
self._started = time.perf_counter()
return self._started
def _update_guess(self, user: int, answer: str) -> UserGuess:
"""Update an already existing guess."""
if self._started is None:
raise QuestionClosedError("Question is not open for answers.")
if self._guesses[user][1] is False:
raise AlreadyUpdatedError(f"User({user}) has already updated their guess once.")
self._guesses[user] = (answer, False, time.perf_counter() - self._started)
return self._guesses[user]
def guess(self, user: int, answer: str) -> UserGuess:
"""Add a guess made by a user to the current question."""
if user in self._guesses:
return self._update_guess(user, answer)
if self._started is None:
raise QuestionClosedError("Question is not open for answers.")
self._guesses[user] = (answer, True, time.perf_counter() - self._started)
return self._guesses[user]
def stop(self) -> dict[int, UserGuess]:
"""Stop the question and return the guesses that were made."""
guesses = self._guesses
self._started = None
self._guesses = {}
return guesses
class TriviaNightGame:
"""Interface for managing a game of trivia night."""
def __init__(self, data: list[QuestionData]) -> None:
self._questions = [Question(q) for q in data]
# A copy of the questions to keep for `.trivianight list`
self._all_questions = list(self._questions)
self.current_question: Question | None = None
self._points = {}
self._speed = {}
def __iter__(self) -> Iterable[Question]:
return iter(self._questions)
def next_question(self, number: str | None = None) -> Question:
"""
Consume one random question from the trivia night game.
One question is randomly picked from the list of questions which is then removed and returned.
"""
if self.current_question is not None:
raise RuntimeError("Cannot call next_question() when there is a current question.")
if number is not None:
try:
question = next(q for q in self._all_questions if q.number == int(number))
except IndexError:
raise ValueError(f"Question number {number} does not exist.")
elif len(self._questions) == 0:
raise AllQuestionsVisitedError("All of the questions have been visited.")
else:
question = self._questions.pop(randrange(len(self._questions)))
self.current_question = question
return question
def end_question(self) -> None:
"""
End the current question.
This method should be called when the question has been answered, it must be called before
attempting to call `next_question()` again.
"""
if self.current_question is None:
raise RuntimeError("Cannot call end_question() when there is no current question.")
self.current_question.stop()
self.current_question = None
def list_questions(self) -> str:
"""
List all the questions.
This method should be called when `.trivianight list` is called to display the following information:
- Question number
- Question description
- Visited/not visited
"""
question_list = []
visited = ":white_check_mark:"
not_visited = ":x:"
for question in self._all_questions:
formatted_string = (
f"**Q{question.number}** {not_visited if question in self._questions else visited}"
f"\n{question.description}\n\n"
)
question_list.append(formatted_string.rstrip())
return question_list
|
