Merge branch 'refactor/extract-assignment-specific-instructions'

Author: beachdweller

CHANGELOG.md

@@ -7,9 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased] - YYYY-MM-DD
 
 ### Added
-* MECE principle in comment generation
-* if failed, assert the error message
-* fail-expected argument to fail the test if the expected fail count not correct
 
 
 ### Changed
@@ -24,6 +21,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 
+## [v0.1.6] - 2025-02-01
+
+### Added
+* MECE principle in comment generation
+* if failed, assert the error message
+* `fail-expected` argument to fail the test if the expected fail count not correct
+* Add a feature to exclude common content of README.md assignment instruction.
+    * Common content is marked by the starting marker ``From here is common to all assignments.`` and the ending marker ``Until here is common to all assignments.`` in the README.md file, surrounded by double backtick (ascii 96) characters.
+* Add start and end markers to mutable code block in the prompt for Gemini.
+
+
+### Changed
+* Update license to BSD 3-Clause + Do Not Harm.
+* Change the default value of `fail-expected` to `false`.
+* Improve prompt for Gemini.
+    * Add header and footer to the prompt.
+    * Modify instruction for failed tests to "Please generate comments mutually exclusive and collectively exhaustive for the following failed test cases.".
+    * Add start and end markers to mutable code block.
+
+
+### Removed
+* 'Currently Korean Only' from README.md.
+
+
 ## [v0.1.5] - 2024-10-20
 
 ### Added

README.md

@@ -26,8 +26,8 @@ Before using this action, ensure you have the following:
 
 ## Key Features
 
-* Provide feedback on Python code assignments.
-* Support multiple JSON files by pytest-json-report plugin.
+* Provide AI powered feedback on Python code assignments.
+* Support multiple JSON files by `pytest-json-report` plugin.
 * Support multiple student files.
 
 # Usage
@@ -61,6 +61,8 @@ jobs:
 
 ```
 * This action analyzes the JSON output generated by the `pytest-json-report` plugin to understand the test results of your Python code and provide AI-powered feedback. 
+* You can exclude common content of README.md assignment instruction to save AI API data usage.
+    * Please mark the common contents by the starting marker ``From here is common to all assignments.`` and the ending marker ``Until here is common to all assignments.`` in the README.md file, surrounded by double backtick (ascii 96) characters.
 
 ## Inputs
 * `report-files`: Comma-separated list of JSON report files generated by pytest-json-report. (Required)
@@ -80,12 +82,11 @@ with:
 ```
 
 ## Limitations
-* The action currently supports Korean only.
 * The action currently supports only Python code assignments.
 * The action requires the `pytest-json-report` plugin to generate JSON test reports.
 
 ## Future Work
-* Support multiple human languages.
+* Support more human languages.
     * Add language argument
     * Add language detection
 
@@ -96,10 +97,6 @@ with:
 * Support more programming languages.
     * Possibly in a different repository
 
-* Feedback on code passing all tests.
-    * Possible further analysis on the code.
-    * Provide suggestions for further improvements.
-
 * Add `verbose` argument to provide more detailed feedback.
     * More internal details
 
@@ -131,7 +128,7 @@ with:
 
 ## License
 
-This project is licensed under the BSD 3-Clause License + Do No Harm.
+This project is licensed under the BSD 3-Clause License + Do Not Harm.
 
 Copyright (c) 2024 Kangwon Lee
 

ai_tutor.py

@@ -2,8 +2,8 @@
 import json
 import logging
 import pathlib
+import re
 import time
-
 from typing import Dict, List, Tuple
 
 import requests
@@ -238,8 +238,64 @@ 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()
+def assignment_instruction(
+    readme_file: pathlib.Path,
+    common_content_start_marker: str = r"``From here is common to all assignments\.``",
+    common_content_end_marker: str = r"``Until here is common to all assignments\.``",
+) -> str:
+    """Extracts assignment-specific instructions from a README.md file.
+
+    This function reads a README.md file and removes content marked as common
+    to all assignments, returning only the assignment-specific instructions.
+
+    Args:
+        readme_file: Path to the README.md file.
+        common_content_start_marker: The marker indicating the start of common content.
+        common_content_end_marker: The marker indicating the end of common content.
+
+    Returns:
+        A string containing the assignment-specific instructions.
+    """
+
+    return exclude_common_contents(
+        readme_file.read_text(),
+        common_content_start_marker,
+        common_content_end_marker,
+    )  # Single exit point
+
+
+def exclude_common_contents(
+    readme_content:str,
+    common_content_start_marker: str = r"``From here is common to all assignments.``",
+    common_content_end_marker: str = r"``Until here is common to all assignments.``",
+) -> str:
+    """Removes common content from a string.
+
+    This function takes a string and removes the content between the specified
+    start and end markers.
+
+    Args:
+        readme_content: The input string containing the README content.
+        common_content_start_marker: The marker indicating the start of common content.
+        common_content_end_marker: The marker indicating the end of common content.
+
+    Returns:
+        A string with the common content removed.
+    """
+    # Include the markers in the pattern itself
+    pattern = rf"({common_content_start_marker}\s*.*?\s*{common_content_end_marker})"
+    found_list = re.findall(pattern, readme_content, re.DOTALL | re.IGNORECASE)
+
+    instruction = str(readme_content)
+
+    if not found_list:
+        logging.warning(f"Common content markers '{common_content_start_marker}' and '{common_content_end_marker}' not found in README.md. Returning entire file.")
+    else:
+        for found in found_list:
+            # Remove the common content
+            instruction = instruction.replace(found, "")
+
+    return instruction
 
 
 @functools.lru_cache(maxsize=None)

entrypoint.py

@@ -55,7 +55,7 @@ def main() -> None:
     elif b_fail_expected:
         assert n_failed > 0, 'No failed tests'
     else:
-        raise NotImplementedError('Unexpected value for INPUT_FAIL-EXPECTED')    
+        raise NotImplementedError('Unexpected value for INPUT_FAIL-EXPECTED')
 
 
 def get_path_tuple(report_files_str:str) -> Tuple[pathlib.Path]: