QuizGenerator 0.4.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

QuizGenerator/premade_questions/cst334/math_questions.py

@@ -3,8 +3,8 @@ import abc
 import logging
 import math
 
-from QuizGenerator.question import Question, QuestionRegistry, Answer
-from QuizGenerator.contentast import ContentAST
+from QuizGenerator.question import Question, QuestionRegistry
+from QuizGenerator.contentast import ContentAST, AnswerTypes
 from QuizGenerator.constants import MathRanges
 
 log = logging.getLogger(__name__)
@@ -31,11 +31,16 @@ class BitsAndBytes(MathQuestion):
     self.num_bytes = int(math.pow(2, self.num_bits))
     
     if self.from_binary:
-      self.answers = {"answer" : Answer.integer("num_bytes", self.num_bytes)}
+      self.answers = {"answer": AnswerTypes.Int(self.num_bytes,
+                                               label="Address space size", unit="Bytes")}
     else:
-      self.answers = {"answer" : Answer.integer("num_bits", self.num_bits)}
+      self.answers = {"answer": AnswerTypes.Int(self.num_bits,
+                                               label="Number of bits in address", unit="bits")}
   
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs):
+    """Build question body and collect answers."""
+    answers = [self.answers['answer']]
+
     body = ContentAST.Section()
     body.add_element(
       ContentAST.Paragraph([
@@ -45,31 +50,17 @@ class BitsAndBytes(MathQuestion):
         f"{'do we need to address our memory' if not self.from_binary else 'of memory can be addressed'}?"
       ])
     )
-    
-    if self.from_binary:
-      body.add_element(
-        ContentAST.AnswerBlock(
-          ContentAST.Answer(
-            answer=self.answers['answer'],
-            label="Address space size",
-            unit="Bytes"
-          ),
-        )
-      )
-    else:
-      body.add_element(
-        ContentAST.AnswerBlock(
-          ContentAST.Answer(
-            answer=self.answers['answer'],
-            label="Number of bits in address",
-            unit="bits"
-          ),
-        )
-      )
-      
+
+    body.add_element(ContentAST.AnswerBlock(self.answers['answer']))
+
+    return body, answers
+
+  def get_body(self, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
-  
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+
+  def _get_explanation(self, **kwargs):
     explanation = ContentAST.Section()
     
     explanation.add_element(
@@ -94,7 +85,12 @@ class BitsAndBytes(MathQuestion):
       explanation.add_element(
         ContentAST.Equation(f"log_{{2}}({self.num_bytes} \\text{{bytes}}) = \\textbf{{{self.num_bits}}}\\text{{bits}}")
       )
-    
+
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
 
 
@@ -115,13 +111,18 @@ class HexAndBinary(MathQuestion):
     self.binary_val = f"0b{self.value:0{4*self.number_of_hexits}b}"
     
     if self.from_binary:
-      self.answers['answer'] = Answer.string("hex_val", self.hex_val)
+      self.answers['answer'] = AnswerTypes.String(self.hex_val,
+                                             label="Value in hex")
     else:
-      self.answers['answer'] = Answer.string("binary_val", self.binary_val)
+      self.answers['answer'] = AnswerTypes.String(self.binary_val,
+                                             label="Value in binary")
   
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs):
+    """Build question body and collect answers."""
+    answers = [self.answers['answer']]
+
     body = ContentAST.Section()
-    
+
     body.add_element(
       ContentAST.Paragraph([
         f"Given the number {self.hex_val if not self.from_binary else self.binary_val} "
@@ -129,19 +130,17 @@ class HexAndBinary(MathQuestion):
         "Please include base indicator all padding zeros as appropriate (e.g. 0x01 should be 0b00000001)",
       ])
     )
-    
-    body.add_element(
-      ContentAST.AnswerBlock([
-        ContentAST.Answer(
-          answer = self.answers['answer'],
-          label=f"Value in {'hex' if self.from_binary else 'binary'}: ",
-        )
-      ])
-    )
-    
+
+    body.add_element(ContentAST.AnswerBlock(self.answers['answer']))
+
+    return body, answers
+
+  def get_body(self, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
-  
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+
+  def _get_explanation(self, **kwargs):
     explanation = ContentAST.Section()
     
     paragraph = ContentAST.Paragraph([
@@ -188,10 +187,15 @@ class HexAndBinary(MathQuestion):
           f"Which gives us our binary value of: 0b{binary_str}"
         ])
       )
-      
+
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
-  
-  
+
+
 @QuestionRegistry.register()
 class AverageMemoryAccessTime(MathQuestion):
   
@@ -219,7 +223,7 @@ class AverageMemoryAccessTime(MathQuestion):
     self.amat = self.hit_rate * self.hit_latency + (1 - self.hit_rate) * self.miss_latency
     
     self.answers = {
-      "amat": Answer.float_value("answer__amat", self.amat)
+      "amat": AnswerTypes.Float(self.amat, label="Average Memory Access Time", unit="cycles")
     }
     
     # Finally, do the self.rngizing of the question, to avoid these being non-deterministic
@@ -228,15 +232,18 @@ class AverageMemoryAccessTime(MathQuestion):
     # At this point, everything in the question should be set.
     pass
   
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs):
+    """Build question body and collect answers."""
+    answers = [self.answers["amat"]]
+
     body = ContentAST.Section()
-    
+
     # Add in background information
     body.add_element(
       ContentAST.Paragraph([
         ContentAST.Text("Please calculate the Average Memory Access Time given the below information. "),
         ContentAST.Text(
-          f"Please round your answer to {Answer.DEFAULT_ROUNDING_DIGITS} decimal points. ",
+          f"Please round your answer to {ContentAST.Answer.DEFAULT_ROUNDING_DIGITS} decimal points. ",
           hide_from_latex=True
         )
       ])
@@ -245,32 +252,31 @@ class AverageMemoryAccessTime(MathQuestion):
       ["Hit Latency", f"{self.hit_latency} cycles"],
       ["Miss Latency", f"{self.miss_latency} cycles"]
     ]
-    
+
     # Add in either miss rate or hit rate -- we only need one of them
     if self.show_miss_rate:
       table_data.append(["Miss Rate", f"{100 * (1 - self.hit_rate): 0.2f}%"])
     else:
       table_data.append(["Hit Rate", f"{100 * self.hit_rate: 0.2f}%"])
-    
+
     body.add_element(
       ContentAST.Table(
         data=table_data
       )
     )
-    
-    body.add_element(
-      ContentAST.AnswerBlock([
-        ContentAST.Answer(
-          answer=self.answers["amat"],
-          label="Average Memory Access Time",
-          unit="cycles"
-        )
-      ])
-    )
-    
+
+    body.add_element(ContentAST.LineBreak())
+
+    body.add_element(ContentAST.AnswerBlock(self.answers["amat"]))
+
+    return body, answers
+
+  def get_body(self, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(**kwargs)
     return body
-  
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+
+  def _get_explanation(self, **kwargs):
     explanation = ContentAST.Section()
     
     # Add in General explanation
@@ -288,10 +294,15 @@ class AverageMemoryAccessTime(MathQuestion):
         lhs="AMAT",
         rhs=[
           r"(hit\_rate)*(hit\_cost) + (1 - hit\_rate)*(miss\_cost)",
-          f"({self.hit_rate: 0.{Answer.DEFAULT_ROUNDING_DIGITS}f})*({self.hit_latency}) + ({1 - self.hit_rate: 0.{Answer.DEFAULT_ROUNDING_DIGITS}f})*({self.miss_latency}) = {self.amat: 0.{Answer.DEFAULT_ROUNDING_DIGITS}f}\\text{{cycles}}"
+          f"({self.hit_rate: 0.{ContentAST.Answer.DEFAULT_ROUNDING_DIGITS}f})*({self.hit_latency}) + ({1 - self.hit_rate: 0.{ContentAST.Answer.DEFAULT_ROUNDING_DIGITS}f})*({self.miss_latency}) = {self.amat: 0.{ContentAST.Answer.DEFAULT_ROUNDING_DIGITS}f}\\text{{cycles}}"
         ]
       )
     )
-    
+
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation