Merge branch 'xml-tag-clean' of https://github.com/Rolland-He/ai-autograding-feedback into xml-tag-clean

Author: Rolland-He

ai_feedback/helpers/template_utils.py

@@ -85,46 +85,48 @@ def gather_file_references(submission: Optional[Path], solution: Optional[Path],
     return "\n".join(references)
 
 
-def gather_xml_file_contents(submission: Path, solution: Optional[Path] = None, test_output: Optional[Path] = None) -> str:
+def gather_xml_file_contents(
+    submission: Path, solution: Optional[Path] = None, test_output: Optional[Path] = None
+) -> str:
     """Generate file contents with XML tags for prompt templates.
 
     Args:
         submission (Path): Student's submission file path
-        solution (Path, optional): Instructor's solution file path  
+        solution (Path, optional): Instructor's solution file path
         test_output (Path, optional): Student's test output file path
 
     Returns:
         str: File contents formatted with XML tags and line numbers
     """
     file_contents = ""
-    
+
     file_contents += _format_file_with_xml_tag(submission, "submission")
 
     if solution:
         file_contents += _format_file_with_xml_tag(solution, "solution")
 
     if test_output:
         file_contents += _format_file_with_xml_tag(test_output, "test_output")
-    
+
     return file_contents
 
 
 def _format_file_with_xml_tag(file_path: Path, tag_name: str) -> str:
     """Format a single file with XML tags and line numbers.
-    
+
     Args:
         file_path (Path): Path to the file to format
         tag_name (str): The XML tag name (submission, solution, test_output)
-    
+
     Returns:
         str: Formatted file content with XML tags
     """
     if not file_path:
         return ""
-        
+
     filename = os.path.basename(file_path)
     content = ""
-    
+
     try:
         # Handle PDF files separately
         if filename.lower().endswith('.pdf'):
@@ -276,7 +278,7 @@ def _get_question_contents(assignment_files: List[Optional[Path]], question_num:
     """
     file_contents = ""
     task_found = False
-    
+
     semantic_tags = ["submission", "solution"]
 
     for index, file_path in enumerate(assignment_files):

tests/open_ai_model_tests/integration_test.py

@@ -95,20 +95,20 @@ def test_xml_formatting_code_scope(capsys, mock_and_capture):
     args = [
         "--prompt_text",
         "File references: {file_references}\n\nFile contents:\n{file_contents}",
-        "--scope", 
+        "--scope",
         "code",
         "--submission",
         str(parent / "test_submissions/csc108/correct_submission/correct_submission.py"),
         "--solution",
         str(parent / "test_submissions/csc108/solution.py"),
         "--model",
-        "openai"
+        "openai",
     ]
     output = run_cli_and_capture(args, capsys)
-    
+
     assert "The student's submission file is correct_submission.py." in output
     assert "The instructor's solution file is solution.py." in output
-    
+
     assert '<submission file="correct_submission.py">' in output
     assert '</submission>' in output
     assert '<solution file="solution.py">' in output
@@ -130,19 +130,19 @@ def test_xml_formatting_text_scope_with_test_output(capsys, mock_and_capture):
         "--submission_type",
         "python",
         "--scope",
-        "text", 
+        "text",
         "--submission",
         str(parent / "test_submissions/ggr274_homework5/test1/student_submission.txt"),
         "--solution",
         str(parent / "test_submissions/ggr274_homework5/test1/Homework_5_solution.txt"),
         "--model",
-        "openai"
+        "openai",
     ]
     output = run_cli_and_capture(args, capsys)
-    
+
     assert "The student's submission file is student_submission.txt." in output
-    assert "The instructor's solution file is Homework_5_solution.txt." in output  
-    
+    assert "The instructor's solution file is Homework_5_solution.txt." in output
+
     assert '<submission file="student_submission.txt">' in output
     assert '</submission>' in output
     assert '<solution file="Homework_5_solution.txt">' in output