added visibility settings to API

Author: HarrySu123

in2lambda/api/set.py

@@ -160,3 +160,16 @@ def set_description(self, description: str) -> None:
             'This is my question set.'
         """
         self._description = description
+
+    def __repr__(self):
+        """Custom representation showing visibility status values instead of memory addresses."""
+        return (
+            f"Set("
+            f"_name={self._name!r}, "
+            f"_description={self._description!r}, "
+            f"_finalAnswerVisibility={str(self._finalAnswerVisibility)!r}, "
+            f"_workedSolutionVisibility={str(self._workedSolutionVisibility)!r}, "
+            f"_structuredTutorialVisibility={str(self._structuredTutorialVisibility)!r}, "
+            f"questions={self.questions!r}"
+            f")"
+        )

in2lambda/api/visibility_status.py

@@ -9,6 +9,10 @@ class VisibilityStatus(Enum):
     def __str__(self):
         return self.value
 
+    def __repr__(self) -> str:
+        """Return a string representation for debugging."""
+        return str(self)
+    
 class VisibilityController:
     """Controller for managing visibility status with easy-to-use methods."""
 
@@ -20,19 +24,45 @@ def status(self) -> VisibilityStatus:
         return self._status
 
     def to_open(self):
-        """Change status to OPEN."""
+        """Change status to OPEN.
+        
+        Example:
+            >>> vc = VisibilityController()
+            >>> vc.to_open()
+            >>> vc.status
+            OPEN
+        """
         self._status = VisibilityStatus.OPEN
-        return self
 
     def to_hide(self):
-        """Change status to HIDE."""
+        """Change status to HIDE.
+
+        Example:
+            >>> vc = VisibilityController()
+            >>> vc.to_hide()
+            >>> vc.status
+            HIDE
+        """
         self._status = VisibilityStatus.HIDE
-        return self
 
     def to_open_with_warnings(self):
-        """Change status to OPEN_WITH_WARNINGS."""
+        """Change status to OPEN_WITH_WARNINGS.
+
+        Example:
+            >>> vc = VisibilityController()
+            >>> vc.to_open_with_warnings()
+            >>> vc.status
+            OPEN_WITH_WARNINGS
+        """
         self._status = VisibilityStatus.OPEN_WITH_WARNINGS
-        return self
 
     def __str__(self):
-        return str(self._status)
+        return str(self._status)
+    
+    def __repr__(self) -> str:
+        """Return a string representation for debugging."""
+        return str(self)
+    
+    def to_dict(self):
+        """Convert VisibilityController to dictionary for JSON serialization."""
+        return {"status": str(self._status)}

in2lambda/json_convert/json_convert.py

@@ -55,6 +55,9 @@ def converter(
 
     set_template["name"] = set_name
     set_template["description"] = set_description
+    set_template["finalAnswerVisibility"] = str(SetQuestions._finalAnswerVisibility.status)
+    set_template["workedSolutionVisibility"] = str(SetQuestions._workedSolutionVisibility.status)
+    set_template["structuredTutorialVisibility"] = str(SetQuestions._structuredTutorialVisibility.status)
     # create the set file
     with open(f"{output_question}/set_{set_name}.json", "w") as file:
         json.dump(set_template, file)

in2lambda/main.py

@@ -100,9 +100,9 @@ def runner(
         >>> from in2lambda.main import runner
         >>> # Retrieve an example TeX file and run the given filter.
         >>> runner(f"{os.path.dirname(in2lambda.__file__)}/filters/PartsSepSol/example.tex", "PartsSepSol") # doctest: +ELLIPSIS
-        Set(_name='set', _description='', questions=[Question(title='', parts=[Part(text=..., worked_solution=''), ...], images=[], main_text='This is a sample question\n\n'), ...])
+        Set(_name='set', _description='', _finalAnswerVisibility='OPEN_WITH_WARNINGS', _workedSolutionVisibility='OPEN_WITH_WARNINGS', _structuredTutorialVisibility='OPEN', questions=[Question(title='', parts=[Part(text=..., worked_solution=''), ...], images=[], main_text='This is a sample question\n\n'), ...])
         >>> runner(f"{os.path.dirname(in2lambda.__file__)}/filters/PartsOneSol/example.tex", "PartsOneSol") # doctest: +ELLIPSIS
-        Set(_name='set', _description='', questions=[Question(title='', parts=[Part(text='This is part (a)\n\n', worked_solution=''), ...], images=[], main_text='Here is some preliminary question information that might be useful.'), ...)
+        Set(_name='set', _description='', _finalAnswerVisibility='OPEN_WITH_WARNINGS', _workedSolutionVisibility='OPEN_WITH_WARNINGS', _structuredTutorialVisibility='OPEN', questions=[Question(title='', parts=[Part(text=..., worked_solution=''), ...], images=[], main_text='Here is some preliminary question information that might be useful.'), ...])
     """
     # The list of questions for Lambda Feedback as a Python API.
     set_obj = Set()