Merge pull request #10 from kangwonlee/feature/locale-json

Feature/locale json

Author: kangwonlee

.dockerignore

@@ -3,3 +3,4 @@
 !entrypoint.py
 !requirements.txt
 !ai_tutor.py
+!locale/*.json

CHANGELOG.md

@@ -10,7 +10,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ### Changed
-* move README before pytest longrepr
 
 
 ### Deprecated
@@ -22,6 +21,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 
+## [v0.1.5] - 2024-10-20
+
+### Added
+* Swedish support
+
+### Changed
+* move README before pytest longrepr
+
+
 ## [v0.1.4] - 2024-10-09
 
 ### Added

Dockerfile

@@ -15,6 +15,7 @@ FROM cicirello/pyaction:4
 COPY entrypoint.py /entrypoint.py
 COPY requirements.txt /requirements.txt
 COPY ai_tutor.py /ai_tutor.py
+COPY locale/ /locale/
 
 RUN python3 -m pip install --upgrade pip
 RUN python3 -m pip install -r /requirements.txt

ai_tutor.py

@@ -177,21 +177,7 @@ def collect_longrepr_from_multiple_reports(pytest_json_report_paths:Tuple[pathli
 
 @functools.lru_cache
 def get_directive(explanation_in:str) -> str:
-    d = {
-        'Korean': '숙제 답안으로 제출한 코드가 오류를 일으킨 원인을 입문자 용어만으로 중복 없는 간결한 문장으로 설명하시오.',
-        'English': 'Explain in beginner terms, without duplicates, the cause of the error in the code submitted as homework.',
-        'Bahasa Indonesia': 'Jelaskan dalam istilah pemula, tanpa duplikat, penyebab kesalahan dalam kode yang dikirim sebagai pekerjaan rumah.',
-        'Chinese': '请用初学者术语简洁地解释作业提交的代码出错的原因，不要重复。',
-        'French': '''Expliquez en termes de débutant, sans doublons, la cause de l'erreur dans le code soumis comme devoir.''',
-        'German': 'Erklären Sie in Anfängerterminologie ohne Duplikate die Ursache des Fehlers im als Hausaufgabe eingereichten Code.',
-        'Italian': 'Spiega in termini per principianti, senza duplicati, la causa dell\'errore nel codice inviato come compito.',
-        'Japanese': '宿題の回答として提出されたコードがエラーの原因を、初心者向けの用語で重複なく簡潔に説明してください。',
-        'Nederlands': 'Leg in beginners termen, zonder duplicaten, de oorzaak van de fout in de code die als huiswerk is ingediend uit.',
-        'Spanish': 'Explique en términos para principiantes, sin duplicados, la causa del error en el código enviado como tarea.',
-        'Thai': 'อธิบายด้วยภาษาของผู้เริ่มต้นโดยไม่ซ้ำซ้อนว่าสาเหตุของข้อผิดพลาดในรหัสที่ส่งเป็นการบ้านคืออะไร',
-        'Vietnamese': 'Hãy giải thích lỗi trong đoạn mã bài tập đã nộp bằng ngôn ngữ dễ hiểu dành cho người mới bắt đầu, và đừng lặp lại thông tin.',
-    }
-    return f"{d[explanation_in]}\n"
+    return f"{load_locale(explanation_in)['directive']}\n"
 
 
 def collect_longrepr(data:Dict[str, str]) -> List[str]:
@@ -207,121 +193,35 @@ def collect_longrepr(data:Dict[str, str]) -> List[str]:
 
 @functools.lru_cache
 def get_report_header(explanation_in:str) -> str:
-    d = {
-        'Korean': "오류 메시지 시작",
-        'English': "Error Message Start",
-        'Bahasa Indonesia': "Pesan Kesalahan Dimulai",
-        'Chinese': "错误消息开始",
-        'French': '''Message d'erreur commence''',
-        'German': "Fehlermeldung beginnt",
-        'Italian': "Messaggio di errore inizia",
-        'Japanese': "エラーメッセージ開始",
-        'Nederlands': "Foutmelding begint",
-        'Spanish': "Mensaje de error comienza",
-        'Thai': "ข้อความผิดพลาดเริ่มต้น",
-        'Vietnamese': "Thông báo lỗi bắt đầu",
-    }
+
     return (
-        f"## {d[explanation_in]}\n"
+        f"## {load_locale(explanation_in)['report_header']}\n"
     )
 
 
 @functools.lru_cache
 def get_report_footer(explanation_in:str) -> str:
-    d = {
-        'Korean': "오류 메시지 끝",
-        'English': "Error Message End",
-        'Bahasa Indonesia': "Pesan Kesalahan Berakhir",
-        'Chinese': "错误消息结束",
-        'French': '''Message d'erreur fin''',
-        'German': "Fehlermeldung endet",
-        'Italian': "Messaggio di errore finisce",
-        'Japanese': "エラーメッセージ終わり",
-        'Nederlands': "Foutmelding eindigt",
-        'Spanish': "Mensaje de error termina",
-        'Thai': "ข้อความผิดพลาดสิ้นสุด",
-        'Vietnamese': "Thông báo lỗi kết thúc",
-    }
+
     return (
-        f"## {d[explanation_in]}\n"
+        f"## {load_locale(explanation_in)['report_footer']}\n"
     )
 
 
 def get_instruction_block(readme_file:pathlib.Path, explanation_in:str='Korean',) -> str:
 
-    d_instruction_start = {
-        'Korean': "과제 지침 시작",
-        'English': "Assignment Instruction Start",
-        'Bahasa Indonesia': "Instruksi Tugas Dimulai",
-        'Chinese': "作业说明开始",
-        'French': '''Début de l'instruction de la tâche''',
-        'German': "Start der Aufgabenanweisung",
-        'Italian': "Inizio dell'istruzione dell'assegnazione",
-        'Japanese': "課題指示開始",
-        'Nederlands': "Start van de taakinstructie",
-        'Spanish': "Inicio de la instrucción de la tarea",
-        'Thai': "คำแนะนำการบ้านเริ่มต้น",
-        'Vietnamese': "Bắt đầu hướng dẫn nhiệm vụ",
-    }
-
-    d_instruction_end = {
-        'Korean': "과제 지침 끝",
-        'English': "Assignment Instruction End",
-        'Bahasa Indonesia': "Instruksi Tugas Berakhir",
-        'Chinese': "作业说明结束",
-        'French': '''Fin de l'instruction de la tâche''',
-        'German': "Ende der Aufgabenanweisung",
-        'Italian': "Fine dell'istruzione dell'assegnazione",
-        'Japanese': "課題指示終わり",
-        'Nederlands': "Einde van de taakinstructie",
-        'Spanish': "Fin de la instrucción de la tarea",
-        'Thai': "คำแนะนำการบ้านสิ้นสุด",
-        'Vietnamese': "Kết thúc hướng dẫn nhiệm vụ",
-    }
-
     return (
-        f"## {d_instruction_start[explanation_in]}\n"
+        f"## {load_locale(explanation_in)['instruction_start']}\n"
         f"{assignment_instruction(readme_file)}\n"
-        f"## {d_instruction_end[explanation_in]}\n"
+        f"## {load_locale(explanation_in)['instruction_end']}\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"\n\n## {load_locale(explanation_in)['homework_start']}\n"
         f"{assignment_code(student_files)}\n"
-        f"## {d_homework_end[explanation_in]}\n"
+        f"## {load_locale(explanation_in)['homework_end']}\n"
     )
 
 
@@ -333,3 +233,16 @@ def assignment_code(student_files:Tuple[pathlib.Path]) -> str:
 @functools.lru_cache
 def assignment_instruction(readme_file:pathlib.Path) -> str:
     return readme_file.read_text()
+
+
+@functools.lru_cache(maxsize=None)
+def load_locale(explain_in:str) -> Dict[str, str]:
+    locale_folder = pathlib.Path(__file__).parent/'locale'
+    assert locale_folder.exists(), f"Locale folder not found: {locale_folder}"
+    assert locale_folder.is_dir(), f"Locale folder is not a directory: {locale_folder}"
+
+    locale_file = locale_folder/f'{explain_in}.json'
+    assert locale_file.exists(), f"Locale file not found: {locale_file}"
+    assert locale_file.is_file(), f"Locale file is not a file: {locale_file}"
+
+    return json.loads(locale_file.read_text())

locale/Bahasa Indonesia.json

@@ -0,0 +1,9 @@
+{
+    "directive": "Jelaskan dalam istilah pemula, tanpa duplikat, penyebab kesalahan dalam kode yang dikirim sebagai pekerjaan rumah.",
+    "report_header": "Pesan Kesalahan Dimulai",
+    "report_footer": "Pesan Kesalahan Berakhir",
+    "instruction_start": "Instruksi Tugas Dimulai",
+    "instruction_end": "Instruksi Tugas Berakhir",
+    "homework_start": "Kode Pengumpulan Tugas Dimulai",
+    "homework_end": "Kode Pengumpulan Tugas Berakhir"
+}

locale/Chinese.json

@@ -0,0 +1,9 @@
+{
+    "directive": "请用初学者术语简洁地解释作业提交的代码出错的原因，不要重复。",
+    "report_header": "错误消息开始",
+    "report_footer": "错误消息结束",
+    "instruction_start": "作业说明开始",
+    "instruction_end": "作业说明结束",
+    "homework_start": "作业提交代码开始",
+    "homework_end": "作业提交代码结束"
+}

locale/English.json

@@ -0,0 +1,9 @@
+{
+    "directive": "Explain in beginner terms, without duplicates, the cause of the error in the code submitted as homework.",
+    "report_header": "Error Message Start",
+    "report_footer": "Error Message End",
+    "instruction_start": "Assignment Instruction Start",
+    "instruction_end": "Assignment Instruction End",
+    "homework_start": "Homework Submission Code Start",
+    "homework_end": "Homework Submission Code End"
+}

locale/French.json

@@ -0,0 +1,9 @@
+{
+    "directive": "Expliquez en termes de débutant, sans doublons, la cause de l'erreur dans le code soumis comme devoir.",
+    "report_header": "Message d'erreur commence",
+    "report_footer": "Message d'erreur fin",
+    "instruction_start": "Début de l'instruction de la tâche",
+    "instruction_end": "Fin de l'instruction de la tâche",
+    "homework_start": "Début du code de soumission des devoirs",
+    "homework_end": "Fin du code de soumission des devoirs"
+}

locale/German.json

@@ -0,0 +1,9 @@
+{
+    "directive": "Erklären Sie in Anfängerterminologie ohne Duplikate die Ursache des Fehlers im als Hausaufgabe eingereichten Code.",
+    "report_header": "Fehlermeldung beginnt",
+    "report_footer": "Fehlermeldung endet",
+    "instruction_start": "Start der Aufgabenanweisung",
+    "instruction_end": "Ende der Aufgabenanweisung",
+    "homework_start": "Code für die Einreichung von Hausaufgaben von hier aus",
+    "homework_end": "Ende der Hausaufgaben-Einreichungscodes"
+}

locale/Italian.json

@@ -0,0 +1,9 @@
+{
+    "directive": "Spiega in termini per principianti, senza duplicati, la causa dell'errore nel codice inviato come compito.",
+    "report_header": "Messaggio di errore inizia",
+    "report_footer": "Messaggio di errore finisce",
+    "instruction_start": "Inizio dell'istruzione dell'assegnazione",
+    "instruction_end": "Fine dell'istruzione dell'assegnazione",
+    "homework_start": "Inizio del codice di invio dei compiti",
+    "homework_end": "Fine del codice di invio dei compiti"
+}