feat(api): add to_json method to module

Also includes formatting changes from black’s version bump

Author: harens

in2lambda/api/module.py

@@ -6,6 +6,7 @@
 import panflute as pf
 
 from in2lambda.api.question import Question
+from in2lambda.json_convert import json_convert
 
 
 @dataclass
@@ -89,3 +90,33 @@ def increment_current_question(self) -> None:
  Question(title='Question 2', parts=[Part(text='', worked_solution='Question 2 answer')], images=[], _main_text='')]
         """
         self._current_question_index += 1
+
+    def to_json(self, output_dir: str) -> None:
+        """Turns this module into Lambda Feedback JSON/ZIP files.
+
+        WARNING: This will overwrite any existing files in the directory.
+
+        Args:
+            output_dir: Where to output the final Lambda Feedback JSON/ZIP files.
+
+        Examples:
+            >>> import tempfile
+            >>> import os
+            >>> import json
+            >>> # Create a module with two questions
+            >>> module = Module()
+            >>> module.add_question("Question 1")
+            >>> module.add_question("Question 2")
+            >>> with tempfile.TemporaryDirectory() as temp_dir:
+            ...     # Write the JSON files to the temporary directory
+            ...     module.to_json(temp_dir)
+            ...     # Check the contents of the directory
+            ...     sorted(os.listdir(temp_dir))
+            ...     # Check the title of the first question
+            ...     with open(f"{temp_dir}/Question 1/Question 1.json") as file:
+            ...         print(f"Question 1's title: {json.load(file)['title']}")
+            ['Question 1', 'Question 1.zip', 'Question 2', 'Question 2.zip']
+            Question 1's title: Question 1
+
+        """
+        json_convert.main(self.questions, output_dir)

in2lambda/filters/PartsSepSol/filter.py

@@ -72,7 +72,9 @@ def pandoc_filter(
             # Add each part solution/text
             # For the solution, prepend any top level answer text to each part answer
             for part in lettered_parts:
-                module.current_question.add_solution(
-                    spaced_blurb + part
-                ) if parsing_answers else module.current_question.add_part_text(part)
+                (
+                    module.current_question.add_solution(spaced_blurb + part)
+                    if parsing_answers
+                    else module.current_question.add_part_text(part)
+                )
     return None

in2lambda/filters/markdown.py

@@ -120,7 +120,10 @@ def filter(
         [pf.Element, pf.elements.Doc, Module, bool],
         Optional[pf.Str],
     ]
-) -> Callable[[pf.Element, pf.elements.Doc, Module, str, bool], Optional[pf.Str],]:
+) -> Callable[
+    [pf.Element, pf.elements.Doc, Module, str, bool],
+    Optional[pf.Str],
+]:
     """Python decorator to make generic LaTeX elements markdown readable.
 
     As an example, part of the process involves putting dollar signs around maths

in2lambda/main.py

@@ -9,7 +9,6 @@
 
 import in2lambda.filters
 from in2lambda.api.module import Module
-from in2lambda.json_convert import json_convert
 
 
 def file_type(file: str) -> str:
@@ -40,7 +39,17 @@ def file_type(file: str) -> str:
     match (extension := file.split(".")[-1].lower()):
         case "tex" | "latex" | "ltx":
             return "latex"
-        case "md" | "rmd" | "markdown" | "mdown" | "mdwn" | "mkd" | "mkdn" | "text" | "txt":
+        case (
+            "md"
+            | "rmd"
+            | "markdown"
+            | "mdown"
+            | "mdwn"
+            | "mkd"
+            | "mkdn"
+            | "text"
+            | "txt"
+        ):
             return "markdown"
         case "docx":
             return "docx"  # Pandoc doesn't seem to support doc
@@ -112,7 +121,7 @@ def runner(
 
     # Read the Python API format and convert to JSON.
     if output_dir is not None:
-        json_convert.main(module.questions, output_dir)
+        module.to_json(output_dir)
 
     return module