move report header & footer into collect_longrepr_from_multiple_reports()

more modular

Author: beachdweller

ai_tutor.py

@@ -123,7 +123,7 @@ def get_prompt(
         readme_file:pathlib.Path,
         explanation_in:str,
     ) -> str:
-    pytest_longrepr_list = collect_longrepr_from_multiple_reports(report_paths)
+    pytest_longrepr_list = collect_longrepr_from_multiple_reports(report_paths, explanation_in)
 
     def get_initial_instruction(questions:List[str],language:str) -> str:
         # Add the main directive or instruction based on whether there are failed tests
@@ -139,11 +139,10 @@ def get_initial_instruction(questions:List[str],language:str) -> str:
 
     prompt_list = (
         # Add the initial instruction
-        [get_initial_instruction(pytest_longrepr_list, explanation_in), get_report_header(explanation_in)]
+        [get_initial_instruction(pytest_longrepr_list, explanation_in),]
         + pytest_longrepr_list
         # Add the code and instructions
         + [
-            get_report_footer(explanation_in),
             get_student_code_block(student_files, explanation_in,),
             get_instruction_block(readme_file, explanation_in,)
         ]
@@ -155,7 +154,7 @@ def get_initial_instruction(questions:List[str],language:str) -> str:
     return prompt_str
 
 
-def collect_longrepr_from_multiple_reports(pytest_json_report_paths:Tuple[pathlib.Path]) -> List[str]:
+def collect_longrepr_from_multiple_reports(pytest_json_report_paths:Tuple[pathlib.Path], explanation_in:str) -> List[str]:
     questions = []
 
     # Process each report file
@@ -167,6 +166,10 @@ def collect_longrepr_from_multiple_reports(pytest_json_report_paths:Tuple[pathli
 
         questions += longrepr_list
 
+    if questions:
+        questions.insert(0, get_report_header(explanation_in))
+        questions.append(get_report_footer(explanation_in))
+
     return questions
 
 

tests/test_ai_tutor.py

@@ -58,15 +58,17 @@ def test_collect_longrepr_div_zero_dict__returns_non_empty(json_dict_div_zero_tr
 
 
 def test_collect_longrepr_from_multiple_reports__returns_non_empty(
-        sample_report_path,
-        div_zero_report_path,
+        sample_report_path:pathlib.Path,
+        div_zero_report_path:pathlib.Path,
+        explanation_in:str
     ):
     multiple_reports = (
         sample_report_path,
         div_zero_report_path
     )
     result = ai_tutor.collect_longrepr_from_multiple_reports(
-        multiple_reports
+        multiple_reports,
+        explanation_in=explanation_in,
     )
 
     assert result