refactoring and now allows setting name and description for the set

Author: HarrySu123

in2lambda/api/module.py

@@ -6,13 +6,15 @@
 import panflute as pf
 
 from in2lambda.api.question import Question
-from in2lambda.json_convert import json_convert
 
 
 @dataclass
 class Set:
     """Represents a list of questions."""
 
+    _name: str = field(default="set")
+    _description: str = field(default="")
+
     questions: list[Question] = field(default_factory=list)
     _current_question_index = -1
 
@@ -122,4 +124,36 @@ def to_json(self, output_dir: str) -> None:
             Question 1's title: Question 1
 
         """
-        json_convert.main(self.questions, output_dir)
+        
+        from in2lambda.json_convert import json_convert
+        json_convert.main(self, output_dir)
+
+    def set_name(self, name: str) -> None:
+        """Sets the name of the set.
+
+        Args:
+            name: The name to set for the set.
+
+        Examples:
+            >>> from in2lambda.api.set import Set
+            >>> s = Set()
+            >>> s.set_name("My Question Set")
+            >>> s._name
+            'My Question Set'
+        """
+        self._name = name
+
+    def set_description(self, description: str) -> None:
+        """Sets the description of the set.
+
+        Args:
+            description: The description to set for the set.
+
+        Examples:
+            >>> from in2lambda.api.set import Set
+            >>> s = Set()
+            >>> s.set_description("This is my question set.")
+            >>> s._description
+            'This is my question set.'
+        """
+        self._description = description

in2lambda/api/set.py

@@ -8,49 +8,53 @@
 from pathlib import Path
 from typing import Any
 
+from in2lambda.api.set import Set
 from in2lambda.api.question import Question
 
 MINIMAL_QUESTION_TEMPLATE = "minimal_template_question.json"
 MINIMAL_SET_TEMPLATE = "minimal_template_set.json"
 
 
-def zip_sorted_folder(folder_path, zip_path):
+def _zip_sorted_folder(folder_path, zip_path):
     """Zips the contents of a folder, preserving the directory structure.
     Args:
         folder_path: The path to the folder to zip.
         zip_path: The path where the zip file will be created.
     """
     with zipfile.ZipFile(zip_path, 'w') as zf:
         for root, dirs, files in os.walk(folder_path):
-            # Sort files for deterministic order
+            # Sort files for deterministic, alphabetical order
             for file in sorted(files):
                 abs_path = os.path.join(root, file)
                 rel_path = os.path.relpath(abs_path, folder_path)
                 zf.write(abs_path, arcname=rel_path)
 
 def converter(
-    question_template: dict[str, Any], set_template: dict[str, Any], ListQuestions: list[Question], output_dir: str
+    question_template: dict[str, Any], set_template: dict[str, Any], SetQuestions: Set, output_dir: str
 ) -> None:
-    """Turns a list of question objects into Lambda Feedback JSON.
+    """Turns a set of question objects into Lambda Feedback JSON.
 
     Args:
         question_template: The loaded JSON from the minimal question template (it needs to be in sync).
         set_template: The loaded JSON from the minimal set template (it needs to be in sync).
-        ListQuestions: A list of question objects.
+        SetQuestions: A Set object containing questions.
         output_dir: The absolute path for where to produced the final JSON/zip files.
     """
-    # Create output by copying template
+    ListQuestions = SetQuestions.questions
+    set_name = SetQuestions._name
+    set_description = SetQuestions._description
 
     # create directory to put the questions
     os.makedirs(output_dir, exist_ok=True)
-    output_question = os.path.join(output_dir, "set_a_simple_example")
+    output_question = os.path.join(output_dir, set_name)
     os.makedirs(output_question, exist_ok=True)
 
+
+    set_template["name"] = set_name
+    set_template["description"] = set_description
     # create the set file
-    with open(f"{output_question}/set_a_simple_example.json", "w") as file:
+    with open(f"{output_question}/set_{set_name}.json", "w") as file:
         json.dump(set_template, file)
-    shutil.make_archive(output_question, "zip", output_question)
-
 
     for i in range(len(ListQuestions)):
         output = deepcopy(question_template)
@@ -97,16 +101,16 @@ def converter(
             shutil.copy(image_path, output_image)  # copies image into the directory
 
     # output zip file in destination folder
-    zip_sorted_folder(output_question, output_question + ".zip")
+    _zip_sorted_folder(output_question, output_question + ".zip")
 
 
-def main(questions: list[Question], output_dir: str) -> None:
+def main(set_questions: Set, output_dir: str) -> None:
     """Preliminary defensive programming before calling the main converter function.
 
     This ultimately then produces the Lambda Feedback JSON/ZIP files.
 
     Args:
-        questions: A list of question objects.
+        set_questions: A Set object containing questions.
         output_dir: Where to output the final Lambda Feedback JSON/ZIP files.
     """
     # Use path so minimal template can be found regardless of where the user is running python from.
@@ -122,4 +126,4 @@ def main(questions: list[Question], output_dir: str) -> None:
             shutil.rmtree(output_dir)
         except OSError as e:
             print("Error: %s : %s" % (output_dir, e.strerror))
-    converter(question_template, set_template, questions, output_dir)
+    converter(question_template, set_template, set_questions, output_dir)