QuizGenerator 0.4.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

QuizGenerator/premade_questions/cst334/persistence_questions.py

@@ -54,7 +54,15 @@ class HardDriveAccessTime(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
       ),
     })
   
-  def get_body(self, *args, **kwargs) -> ContentAST.Section:
+  def _get_body(self, *args, **kwargs):
+    """Build question body and collect answers."""
+    answers = [
+      self.answers["answer__rotational_delay"],
+      self.answers["answer__access_delay"],
+      self.answers["answer__transfer_delay"],
+      self.answers["answer__disk_access_delay"],
+    ]
+
     # Create parameter info table using mixin
     parameter_info = {
       "Hard Drive Rotation Speed": f"{self.hard_drive_rotation_speed}RPM",
@@ -84,8 +92,8 @@ class HardDriveAccessTime(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
     intro_text = "Given the information below, please calculate the following values."
 
     instructions = (
-      f"Make sure your answers are rounded to {Answer.DEFAULT_ROUNDING_DIGITS} decimal points "
-      f"(even if they are whole numbers), and do so after you finish all your calculations! "
+      f"Make sure that if you round your answers you use the unrounded values for your final calculations, "
+      f"otherwise you may introduce error into your calculations."
       f"(i.e. don't use your rounded answers to calculate your overall answer)"
     )
 
@@ -96,9 +104,14 @@ class HardDriveAccessTime(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
       additional_instructions=instructions
     )
 
+    return body, answers
+
+  def get_body(self, *args, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(*args, **kwargs)
     return body
-  
-  def get_explanation(self) -> ContentAST.Section:
+
+  def _get_explanation(self):
     explanation = ContentAST.Section()
     
     explanation.add_element(
@@ -150,6 +163,11 @@ class HardDriveAccessTime(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
         f"= {self.number_of_reads} \\cdot {self.access_delay:0.2f} + {self.transfer_delay:0.2f} "
         f"= {self.disk_access_delay:0.2f}ms")
     ])
+    return explanation, []
+
+  def get_explanation(self) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation()
     return explanation
 
 
@@ -178,7 +196,15 @@ class INodeAccesses(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
       "answer__inode_index_in_block": Answer.integer("answer__inode_index_in_block", self.inode_index_in_block),
     })
   
-  def get_body(self) -> ContentAST.Section:
+  def _get_body(self):
+    """Build question body and collect answers."""
+    answers = [
+      self.answers["answer__inode_address"],
+      self.answers["answer__inode_block"],
+      self.answers["answer__inode_address_in_block"],
+      self.answers["answer__inode_index_in_block"],
+    ]
+
     # Create parameter info table using mixin
     parameter_info = {
       "Block Size": f"{self.block_size} Bytes",
@@ -206,21 +232,21 @@ class INodeAccesses(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
     # Use mixin to create complete body with both tables
     intro_text = "Given the information below, please calculate the following values."
 
-    instructions = (
-      "(hint: they should all be round numbers). "
-      "Remember, demonstrating you know the equations and what goes into them is generally sufficient."
-    )
-
     body = self.create_parameter_calculation_body(
       intro_text=intro_text,
       parameter_table=parameter_table,
       answer_table=answer_table,
-      additional_instructions=instructions
+      # additional_instructions=instructions
     )
 
+    return body, answers
+
+  def get_body(self) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body()
     return body
-  
-  def get_explanation(self) -> ContentAST.Section:
+
+  def _get_explanation(self):
     explanation = ContentAST.Section()
     
     explanation.add_element(
@@ -292,7 +318,12 @@ class INodeAccesses(IOQuestion, TableQuestionMixin, BodyTemplatesMixin):
         f"{self.inode_index_in_block}"
       ]
     ))
-    
+
+    return explanation, []
+
+  def get_explanation(self) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation()
     return explanation
 
 
@@ -330,40 +361,42 @@ class VSFS_states(IOQuestion):
       f"{operations[-1]['cmd']}",
       kind=Answer.AnswerKind.MULTIPLE_DROPDOWN,
       correct=True,
-      baffles=list(set([op['cmd'] for op in operations[:-1] if op != operations[-1]['cmd']]))
+      baffles=list(set([op['cmd'] for op in operations[:-1] if op != operations[-1]['cmd']])),
+      label="Command"
     )
   
-  def get_body(self) -> ContentAST.Section:
+  def _get_body(self):
+    """Build question body and collect answers."""
+    answers = [self.answers["answer__cmd"]]
+
     body = ContentAST.Section()
-    
+
     body.add_element(ContentAST.Paragraph(["What operation happens between these two states?"]))
-    
+
     body.add_element(
       ContentAST.Code(
         self.start_state,
         make_small=True
       )
     )
-    
-    body.add_element(
-      ContentAST.AnswerBlock(
-        ContentAST.Answer(
-          self.answers["answer__cmd"],
-          label="Command"
-        )
-      )
-    )
-    
+
+    body.add_element(ContentAST.AnswerBlock(self.answers["answer__cmd"]))
+
     body.add_element(
       ContentAST.Code(
         self.end_state,
         make_small=True
       )
     )
-    
+
+    return body, answers
+
+  def get_body(self) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body()
     return body
-  
-  def get_explanation(self) -> ContentAST.Section:
+
+  def _get_explanation(self):
     explanation = ContentAST.Section()
     
     log.debug(f"self.start_state: {self.start_state}")
@@ -446,6 +479,11 @@ class VSFS_states(IOQuestion):
         highlight_changes(self.start_state, self.end_state)
       )
     )
-    
+
+    return explanation, []
+
+  def get_explanation(self) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation()
     return explanation
   

QuizGenerator/premade_questions/cst334/process.py

@@ -368,18 +368,28 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
     self.answers.update({
       "answer__average_response_time": Answer.auto_float(
         "answer__average_response_time",
-        sum([job.response_time for job in jobs]) / len(jobs)
+        sum([job.response_time for job in jobs]) / len(jobs),
+        label="Overall average response time"
       ),
       "answer__average_turnaround_time": Answer.auto_float(
         "answer__average_turnaround_time",
-        sum([job.turnaround_time for job in jobs]) / len(jobs)
+        sum([job.turnaround_time for job in jobs]) / len(jobs),
+        label="Overall average TAT"
       )
     })
 
     # Return whether this workload is interesting
     return self.is_interesting()
   
-  def get_body(self, *args, **kwargs) -> ContentAST.Section:
+  def _get_body(self, *args, **kwargs):
+    """
+    Build question body and collect answers.
+    Returns:
+        Tuple of (body_ast, answers_list)
+    """
+    from typing import List
+    answers: List[Answer] = []
+
     # Create table data for scheduling results
     table_rows = []
     for job_id in sorted(self.job_stats.keys()):
@@ -390,6 +400,9 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
         "Response Time": f"answer__response_time_job{job_id}",  # Answer key
         "TAT": f"answer__turnaround_time_job{job_id}"  # Answer key
       })
+      # Collect answers for this job
+      answers.append(self.answers[f"answer__response_time_job{job_id}"])
+      answers.append(self.answers[f"answer__turnaround_time_job{job_id}"])
 
     # Create table using mixin
     scheduling_table = self.create_answer_table(
@@ -398,15 +411,18 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
       answer_columns=["Response Time", "TAT"]
     )
 
+    # Collect average answers
+    avg_response_answer = self.answers["answer__average_response_time"]
+    avg_tat_answer = self.answers["answer__average_turnaround_time"]
+    answers.append(avg_response_answer)
+    answers.append(avg_tat_answer)
+
     # Create average answer block
-    average_block = ContentAST.AnswerBlock([
-      ContentAST.Answer(self.answers["answer__average_response_time"], label="Overall average response time"),
-      ContentAST.Answer(self.answers["answer__average_turnaround_time"], label="Overall average TAT")
-    ])
+    average_block = ContentAST.AnswerBlock([avg_response_answer, avg_tat_answer])
 
     # Use mixin to create complete body
     intro_text = (
-      f"Given the below information, compute the required values if using <b>{self.scheduler_algorithm}</b> scheduling. "
+      f"Given the below information, compute the required values if using **{self.scheduler_algorithm}** scheduling. "
       f"Break any ties using the job number."
     )
 
@@ -418,18 +434,28 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
 
     body = self.create_fill_in_table_body(intro_text, instructions, scheduling_table)
     body.add_element(average_block)
+    return body, answers
+
+  def get_body(self, *args, **kwargs) -> ContentAST.Section:
+    """Build question body (backward compatible interface)."""
+    body, _ = self._get_body(*args, **kwargs)
     return body
   
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+  def _get_explanation(self, **kwargs):
+    """
+    Build question explanation.
+    Returns:
+        Tuple of (explanation_ast, answers_list)
+    """
     explanation = ContentAST.Section()
-    
+
     explanation.add_element(
       ContentAST.Paragraph([
         f"To calculate the overall Turnaround and Response times using {self.scheduler_algorithm} "
         f"we want to first start by calculating the respective target and response times of all of our individual jobs."
       ])
     )
-    
+
     explanation.add_elements([
       ContentAST.Paragraph([
         "We do this by subtracting arrival time from either the completion time or the start time.  That is:"
@@ -437,13 +463,13 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
       ContentAST.Equation("Job_{TAT} = Job_{completion} - Job_{arrival\_time}"),
       ContentAST.Equation("Job_{response} = Job_{start} - Job_{arrival\_time}"),
     ])
-    
+
     explanation.add_element(
       ContentAST.Paragraph([
         f"For each of our {len(self.job_stats.keys())} jobs, we can make these calculations.",
       ])
     )
-    
+
     ## Add in TAT
     explanation.add_element(
       ContentAST.Paragraph([
@@ -456,7 +482,7 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
         for job_id in sorted(self.job_stats.keys())
       ])
     )
-    
+
     summation_line = ' + '.join([
       f"{self.job_stats[job_id]['TAT']:0.{self.ROUNDING_DIGITS}f}" for job_id in sorted(self.job_stats.keys())
     ])
@@ -467,8 +493,8 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
         f"= {self.overall_stats['TAT']:0.{self.ROUNDING_DIGITS}f}",
       ])
     )
-    
-    
+
+
     ## Add in Response
     explanation.add_element(
       ContentAST.Paragraph([
@@ -481,7 +507,7 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
       for job_id in sorted(self.job_stats.keys())
     ])
     )
-    
+
     summation_line = ' + '.join([
       f"{self.job_stats[job_id]['Response']:0.{self.ROUNDING_DIGITS}f}" for job_id in sorted(self.job_stats.keys())
     ])
@@ -494,7 +520,7 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
         "\n",
       ])
     )
-    
+
     explanation.add_element(
       ContentAST.Table(
         headers=["Time", "Events"],
@@ -504,14 +530,19 @@ class SchedulingQuestion(ProcessQuestion, RegenerableChoiceMixin, TableQuestionM
         ]
       )
     )
-    
+
     explanation.add_element(
       ContentAST.Picture(
         img_data=self.make_image(),
         caption="Process Scheduling Overview"
       )
     )
-    
+
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
   
   def is_interesting(self) -> bool:

QuizGenerator/premade_questions/cst463/gradient_descent/gradient_calculation.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import abc
 import logging
-from typing import List
+from typing import List, Tuple
 import sympy as sp
 
 from QuizGenerator.contentast import ContentAST
@@ -39,6 +39,9 @@ class DerivativeQuestion(Question, abc.ABC):
     # Evaluate gradient at the specified point
     subs_map = dict(zip(self.variables, evaluation_point))
 
+    # Format evaluation point for label
+    eval_point_str = ", ".join([f"x_{i} = {evaluation_point[i]}" for i in range(self.num_variables)])
+
     # Create answer for each partial derivative
     for i in range(self.num_variables):
       answer_key = f"partial_derivative_{i}"
@@ -52,7 +55,9 @@ class DerivativeQuestion(Question, abc.ABC):
         raise ValueError("Complex number encountered - need to regenerate")
 
       # Use auto_float for Canvas compatibility with integers and decimals
-      self.answers[answer_key] = Answer.auto_float(answer_key, gradient_value)
+      # Label includes the partial derivative notation
+      label = f"∂f/∂x_{i} at ({eval_point_str})"
+      self.answers[answer_key] = Answer.auto_float(answer_key, gradient_value, label=label)
 
   def _create_gradient_vector_answer(self) -> None:
     """Create a single gradient vector answer for PDF format."""
@@ -72,8 +77,10 @@ class DerivativeQuestion(Question, abc.ABC):
     vector_str = format_vector(gradient_values)
     self.answers["gradient_vector"] = Answer.string("gradient_vector", vector_str, pdf_only=True)
 
-  def get_body(self, **kwargs) -> ContentAST.Section:
+  def _get_body(self, **kwargs) -> Tuple[ContentAST.Section, List[Answer]]:
+    """Build question body and collect answers."""
     body = ContentAST.Section()
+    answers = []
 
     # Display the function
     body.add_element(
@@ -103,6 +110,8 @@ class DerivativeQuestion(Question, abc.ABC):
 
     # For Canvas: Use OnlyHtml to show individual partial derivatives
     for i in range(self.num_variables):
+      answer = self.answers[f"partial_derivative_{i}"]
+      answers.append(answer)
       body.add_element(
         ContentAST.OnlyHtml([
           ContentAST.Paragraph([
@@ -110,14 +119,20 @@ class DerivativeQuestion(Question, abc.ABC):
               f"\\left. {self._format_partial_derivative(i)} \\right|_{{{eval_point_str}}} = ",
               inline=True
             ),
-            ContentAST.Answer(self.answers[f"partial_derivative_{i}"])
+            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) -> Tuple[ContentAST.Section, List[Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     # Show the function and its gradient
@@ -165,6 +180,11 @@ class DerivativeQuestion(Question, abc.ABC):
         ])
       )
 
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation
 
 
@@ -264,7 +284,8 @@ class DerivativeChain(DerivativeQuestion):
     f = sp.Function('f')
     self.equation = sp.Eq(f(*self.variables), self.function)
 
-  def get_explanation(self, **kwargs) -> ContentAST.Section:
+  def _get_explanation(self, **kwargs) -> Tuple[ContentAST.Section, List[Answer]]:
+    """Build question explanation."""
     explanation = ContentAST.Section()
 
     # Show the composed function structure
@@ -366,4 +387,9 @@ class DerivativeChain(DerivativeQuestion):
         ])
       )
 
+    return explanation, []
+
+  def get_explanation(self, **kwargs) -> ContentAST.Section:
+    """Build question explanation (backward compatible interface)."""
+    explanation, _ = self._get_explanation(**kwargs)
     return explanation