Merge pull request #8 from kangwonlee/feature/refactor-prompt-parts

Feature/refactor prompt parts

Author: kangwonlee

CHANGELOG.md

@@ -4,14 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased] - YYYY-MM-DD
 
 ### Added
-* Bahasa Indonesia, Nederands, and Vietnamese support
 
 
 ### Changed
+* move README before pytest longrepr
 
 
 ### Deprecated

ai_tutor.py

@@ -105,7 +105,7 @@ def gemini_qna(
     logging.info(f"Student files: {student_files}")
     logging.info(f"Readme file: {readme_file}")
 
-    consolidated_question = get_the_question(
+    consolidated_question = get_prompt(
         report_paths,
         student_files,
         readme_file,
@@ -117,22 +117,13 @@ def gemini_qna(
     return answers
 
 
-def get_the_question(
+def get_prompt(
         report_paths:Tuple[pathlib.Path],
         student_files:Tuple[pathlib.Path],
         readme_file:pathlib.Path,
         explanation_in:str,
     ) -> str:
-    questions = []
-
-    # Process each report file
-    for report_path in report_paths:
-        logging.info(f"Processing report file: {report_path}")
-        data = json.loads(report_path.read_text())
-
-        longrepr_list = collect_longrepr(data)
-
-        questions += longrepr_list
+    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
@@ -146,18 +137,42 @@ def get_initial_instruction(questions:List[str],language:str) -> str:
         return initial_instruction
 
 
-    questions = (
+    prompt_list = (
         # Add the initial instruction
-        [get_initial_instruction(questions, explanation_in), get_report_header(explanation_in)]
-        + questions
+        [
+            get_initial_instruction(pytest_longrepr_list, explanation_in),
+            get_instruction_block(readme_file, explanation_in,),
+        ]
+        + pytest_longrepr_list
         # Add the code and instructions
-        + [get_report_footer(explanation_in), get_code_instruction(student_files, readme_file, explanation_in)]
+        + [
+            get_student_code_block(student_files, explanation_in,),
+        ]
     )
 
     # Join all questions into a single string
-    consolidated_question = "\n\n".join(questions)
+    prompt_str = "\n\n".join(prompt_list)
+
+    return prompt_str
+
+
+def collect_longrepr_from_multiple_reports(pytest_json_report_paths:Tuple[pathlib.Path], explanation_in:str) -> List[str]:
+    questions = []
+
+    # Process each report file
+    for pytest_json_report_path in pytest_json_report_paths:
+        logging.info(f"Processing report file: {pytest_json_report_path}")
+        data = json.loads(pytest_json_report_path.read_text())
+
+        longrepr_list = collect_longrepr(data)
+
+        questions += longrepr_list
+
+    if questions:
+        questions.insert(0, get_report_header(explanation_in))
+        questions.append(get_report_footer(explanation_in))
 
-    return consolidated_question
+    return questions
 
 
 @functools.lru_cache
@@ -190,13 +205,6 @@ def collect_longrepr(data:Dict[str, str]) -> List[str]:
     return longrepr_list
 
 
-@functools.lru_cache
-def get_question(longrepr:str, explanation_in:str,) -> str:
-    return (
-        get_report_header(explanation_in) + f"{longrepr}\n" + get_report_footer(explanation_in)
-    )
-
-
 @functools.lru_cache
 def get_report_header(explanation_in:str) -> str:
     d = {
@@ -239,42 +247,7 @@ def get_report_footer(explanation_in:str) -> str:
     )
 
 
-@functools.lru_cache
-def get_code_instruction(
-        student_files:Tuple[pathlib.Path],
-        readme_file:pathlib.Path,
-        explanation_in:str,
-    ) -> str:
-
-    d_homework_start = {
-        'Korean': "숙제 제출 코드 시작",
-        'English': "Homework Submission Code Start",
-        'Bahasa Indonesia': "Kode Pengumpulan Tugas Dimulai",
-        'Chinese': "作业提交代码开始",
-        'French': '''Début du code de soumission des devoirs''',
-        'German': "Code für die Einreichung von Hausaufgaben von hier aus",
-        'Italian': "Inizio del codice di invio dei compiti",
-        'Japanese': "宿題提出コード開始",
-        'Nederlands': "Huiswerk inzendcode begint",
-        'Spanish': "Inicio del código de envío de tareas",
-        'Thai': "การส่งงานเริ่มต้น",
-        'Vietnamese': "Bắt đầu mã nộp bài tập",
-    }
-
-    d_homework_end = {
-        'Korean': "숙제 제출 코드 끝",
-        'English': "Homework Submission Code End",
-        'Bahasa Indonesia': "Kode Pengumpulan Tugas Berakhir",
-        'Chinese': "作业提交代码结束",
-        'French': '''Fin du code de soumission des devoirs''',
-        'German': "Ende der Hausaufgaben-Einreichungscodes",
-        'Italian': "Fine del codice di invio dei compiti",
-        'Japanese': "宿題提出コード終わり",
-        'Nederlands': "Huiswerk inzendcode eindigt",
-        'Spanish': "Fin del código de envío de tareas",
-        'Thai': "การส่งงานสิ้นสุด",
-        'Vietnamese': "Mã nộp bài tập kết thúc",
-    }
+def get_instruction_block(readme_file:pathlib.Path, explanation_in:str='Korean',) -> str:
 
     d_instruction_start = {
         'Korean': "과제 지침 시작",
@@ -307,15 +280,51 @@ def get_code_instruction(
     }
 
     return (
-        f"\n\n## {d_homework_start[explanation_in]}\n"
-        f"{assignment_code(student_files)}\n"
-        f"## {d_homework_end[explanation_in]}\n"
         f"## {d_instruction_start[explanation_in]}\n"
         f"{assignment_instruction(readme_file)}\n"
         f"## {d_instruction_end[explanation_in]}\n"
     )
 
 
+def get_student_code_block(student_files:Tuple[pathlib.Path], explanation_in:str) -> str:
+
+    d_homework_start = {
+        'Korean': "숙제 제출 코드 시작",
+        'English': "Homework Submission Code Start",
+        'Bahasa Indonesia': "Kode Pengumpulan Tugas Dimulai",
+        'Chinese': "作业提交代码开始",
+        'French': '''Début du code de soumission des devoirs''',
+        'German': "Code für die Einreichung von Hausaufgaben von hier aus",
+        'Italian': "Inizio del codice di invio dei compiti",
+        'Japanese': "宿題提出コード開始",
+        'Nederlands': "Huiswerk inzendcode begint",
+        'Spanish': "Inicio del código de envío de tareas",
+        'Thai': "เริ่มส่งรหัสการบ้าน",
+        'Vietnamese': "Bắt đầu mã nộp bài tập",
+    }
+
+    d_homework_end = {
+        'Korean': "숙제 제출 코드 끝",
+        'English': "Homework Submission Code End",
+        'Bahasa Indonesia': "Kode Pengumpulan Tugas Berakhir",
+        'Chinese': "作业提交代码结束",
+        'French': '''Fin du code de soumission des devoirs''',
+        'German': "Ende der Hausaufgaben-Einreichungscodes",
+        'Italian': "Fine del codice di invio dei compiti",
+        'Japanese': "宿題提出コード終わり",
+        'Nederlands': "Huiswerk inzendcode eindigt",
+        'Spanish': "Fin del código de envío de tareas",
+        'Thai': "จบรหัสส่งการบ้าน",
+        'Vietnamese': "Mã nộp bài tập kết thúc",
+    }
+
+    return (
+        f"\n\n## {d_homework_start[explanation_in]}\n"
+        f"{assignment_code(student_files)}\n"
+        f"## {d_homework_end[explanation_in]}\n"
+    )
+
+
 @functools.lru_cache
 def assignment_code(student_files:Tuple[pathlib.Path]) -> str:
     return '\n\n'.join([f"# begin : {str(f.name)} ======\n{f.read_text()}\n# end : {str(f.name)} ======\n" for f in student_files])

tests/test_ai_tutor.py

@@ -33,7 +33,7 @@ def json_dict(sample_report_path) -> Dict[str, Union[str, List]]:
     return result
 
 
-def test_collect_longrepr(json_dict):
+def test_collect_longrepr__returns_non_empty(json_dict):
     result = ai_tutor.collect_longrepr(json_dict)
 
     assert result
@@ -51,12 +51,29 @@ def json_dict_div_zero_try_except(div_zero_report_path:pathlib.Path) -> Dict[str
     return result
 
 
-def test_collect_longrepr(json_dict_div_zero_try_except:Dict):
+def test_collect_longrepr_div_zero_dict__returns_non_empty(json_dict_div_zero_try_except:Dict):
     result = ai_tutor.collect_longrepr(json_dict_div_zero_try_except)
 
     assert result
 
 
+def test_collect_longrepr_from_multiple_reports__returns_non_empty(
+        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,
+        explanation_in=explanation_in,
+    )
+
+    assert result
+
+
 @pytest.fixture(params=('Korean', 'English', 'Bahasa Indonesia', 'Chinese', 'French', 'German', 'Italian', 'Japanese', 'Nederlands', 'Spanish', 'Thai', 'Vietnamese'))
 def explanation_in(request) -> str:
     return request.param
@@ -173,36 +190,45 @@ def instruction(explanation_in:str) -> str:
     )
 
 
-def test_get_code_instruction(
-        sample_student_code_path:pathlib.Path,
+def test_get_instruction_block(
         sample_readme_path:pathlib.Path,
         explanation_in:str,
-        homework:Tuple[str],
         instruction:str,
     ):
 
-    result = ai_tutor.get_code_instruction(
-        student_files = (sample_student_code_path,),
+    result = ai_tutor.get_instruction_block(
         readme_file = sample_readme_path,
         explanation_in=explanation_in
     ).lower()
 
     assert any(
         map(
             lambda x: x in result,
-            homework
+            instruction
         )
-    )
+    ), f"Could not find instruction: {instruction} in result: {result}."
+
+
+def test_get_student_code_block(
+        sample_student_code_path:pathlib.Path,
+        explanation_in:str,
+        homework:Tuple[str],
+    ):
+
+    result = ai_tutor.get_student_code_block(
+        student_files = (sample_student_code_path,),
+        explanation_in=explanation_in
+    ).lower()
 
     assert any(
         map(
             lambda x: x in result,
-            instruction
+            homework
         )
-    ), f"Could not find instruction: {instruction} in result: {result}."
+    )
 
 
-def test_get_the_question(
+def test_get_prompt__has__homework__msg__instruction(
         sample_report_path:pathlib.Path,
         div_zero_report_path:pathlib.Path,
         sample_student_code_path:pathlib.Path,
@@ -212,7 +238,7 @@ def test_get_the_question(
         msg:str,
         instruction:str,
     ):
-    result = ai_tutor.get_the_question(
+    result = ai_tutor.get_prompt(
         report_paths=(sample_report_path,div_zero_report_path),
         student_files=(sample_student_code_path,),
         readme_file=sample_readme_path,