ygrader 1.2.1__tar.gz → 1.2.2__tar.gz

{ygrader-1.2.1/ygrader.egg-info → ygrader-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ygrader
-Version: 1.2.1
+Version: 1.2.2
 Summary: Grading scripts used in BYU's Electrical and Computer Engineering Department
 Home-page: https://github.com/byu-cpe/ygrader
 Author: Jeff Goeders

{ygrader-1.2.1 → ygrader-1.2.2}/setup.py

@@ -4,7 +4,7 @@ setup(
     name="ygrader",
     packages=["ygrader"],
     package_data={"ygrader": ["*.ahk"]},
-    version="1.2.1",
+    version="1.2.2",
     description="Grading scripts used in BYU's Electrical and Computer Engineering Department",
     author="Jeff Goeders",
     author_email="jeff.goeders@gmail.com",

{ygrader-1.2.1 → ygrader-1.2.2}/ygrader/__init__.py

@@ -3,4 +3,5 @@
 from .grader import Grader, CodeSource, ScoreMode
 from .upstream_merger import UpstreamMerger
 from .utils import CallbackFailed
-from .sub_items import generate_subitem_csvs, ParentItem
+from .grading_item_config import generate_subitem_csvs, GradeItemConfig
+from .feedback import generate_feedback_zip

ygrader-1.2.2/ygrader/feedback.py

@@ -0,0 +1,223 @@
+"""Module for generating student feedback files."""
+
+import pathlib
+import zipfile
+from typing import Dict
+
+import pandas
+
+from .deductions import StudentDeductions
+from .grading_item_config import GradeItemConfig
+
+
+def generate_feedback_zip(
+    yaml_path: pathlib.Path,
+    subitem_feedback_paths: Dict[str, pathlib.Path],
+    output_zip_path: pathlib.Path = None,
+) -> pathlib.Path:
+    """Generate a zip file containing feedback files for each student.
+
+    Args:
+        yaml_path: Path to the YAML file that can be loaded by GradeItemConfig.
+        subitem_feedback_paths: Mapping from subitem name to feedback YAML file path.
+        output_zip_path: Path for the output zip file. If None, defaults to
+            <yaml_dir>/feedback.zip.
+
+    Returns:
+        Path to the generated zip file.
+    """
+    yaml_path = pathlib.Path(yaml_path)
+    grade_item_config = GradeItemConfig(yaml_path)
+
+    # Get the lab name from the YAML file's parent directory
+    lab_name = yaml_path.stem
+
+    # Default output path
+    if output_zip_path is None:
+        output_zip_path = yaml_path.parent / "feedback.zip"
+
+    # Load all student deductions for each subitem
+    subitem_deductions: Dict[str, StudentDeductions] = {}
+    for subitem in grade_item_config.subitems:
+        if subitem.name in subitem_feedback_paths:
+            feedback_path = subitem_feedback_paths[subitem.name]
+            if feedback_path.exists():
+                subitem_deductions[subitem.name] = StudentDeductions(feedback_path)
+            else:
+                subitem_deductions[subitem.name] = StudentDeductions()
+        else:
+            subitem_deductions[subitem.name] = StudentDeductions()
+
+    # Load the first subitem's CSV to get the list of students
+    # (all subitems should have the same students)
+    first_subitem = grade_item_config.subitems[0]
+    if not first_subitem.csv_path.exists():
+        raise FileNotFoundError(
+            f"CSV file for subitem '{first_subitem.name}' not found at {first_subitem.csv_path}"
+        )
+
+    students_df = pandas.read_csv(first_subitem.csv_path)
+
+    # Create the zip file
+    with zipfile.ZipFile(output_zip_path, "w", zipfile.ZIP_DEFLATED) as zip_file:
+        for _, student_row in students_df.iterrows():
+            first_name = str(student_row["First Name"]).strip()
+            last_name = str(student_row["Last Name"]).strip()
+            net_id = str(student_row["Net ID"]).strip()
+
+            # Generate feedback content for this student
+            feedback_content = _generate_student_feedback(
+                student_row=student_row,
+                grade_item_config=grade_item_config,
+                subitem_deductions=subitem_deductions,
+            )
+
+            # Generate filename
+            filename = (
+                first_name
+                + "_"
+                + last_name
+                + "_"
+                + net_id
+                + "_feedback-"
+                + lab_name
+                + ".txt"
+            )
+
+            # Add to zip file
+            zip_file.writestr(filename, feedback_content)
+
+    return output_zip_path
+
+
+def _generate_student_feedback(
+    student_row: pandas.Series,
+    grade_item_config: GradeItemConfig,
+    subitem_deductions: Dict[str, StudentDeductions],
+) -> str:
+    """Generate the feedback text content for a single student.
+
+    Args:
+        student_row: A row from the student DataFrame.
+        grade_item_config: The GradeItemConfig object.
+        subitem_deductions: Mapping from subitem name to StudentDeductions.
+
+    Returns:
+        The formatted feedback text.
+    """
+    net_id = str(student_row["Net ID"]).strip()
+    first_name = str(student_row["First Name"]).strip()
+    last_name = str(student_row["Last Name"]).strip()
+
+    lines = []
+    lines.append(f"Feedback for {first_name} {last_name} ({net_id})")
+    lines.append("=" * 60)
+    lines.append("")
+
+    total_points_possible = 0
+    total_points_deducted = 0
+
+    # Column widths for formatting
+    feedback_col_width = 45
+    points_col_width = 15
+
+    for subitem in grade_item_config.subitems:
+        subitem_points_possible = subitem.points
+        total_points_possible += subitem_points_possible
+
+        lines.append(f"{subitem.name} ({subitem_points_possible} points)")
+        lines.append("-" * 60)
+
+        # Header row
+        header = f"{'Feedback':<{feedback_col_width}} {'Points Deducted':>{points_col_width}}"
+        lines.append(header)
+        lines.append("-" * 60)
+
+        subitem_points_deducted = 0
+
+        # Get deductions for this student in this subitem
+        student_deductions_obj = subitem_deductions.get(subitem.name)
+        if student_deductions_obj:
+            # Find the student's deductions (try single net_id first, then tuple)
+            student_key = None
+            if (net_id,) in student_deductions_obj.deductions_by_students:
+                student_key = (net_id,)
+            else:
+                # Check for multi-student keys containing this net_id
+                for key in student_deductions_obj.deductions_by_students.keys():
+                    if net_id in key:
+                        student_key = key
+                        break
+
+            if student_key:
+                deductions = student_deductions_obj.deductions_by_students[student_key]
+                for deduction in deductions:
+                    feedback_text = deduction.message
+                    points = deduction.points
+
+                    # Wrap long feedback text
+                    wrapped_lines = _wrap_text(feedback_text, feedback_col_width)
+                    for i, line_text in enumerate(wrapped_lines):
+                        if i == 0:
+                            row = f"{line_text:<{feedback_col_width}} {points:>{points_col_width}.1f}"
+                        else:
+                            row = f"{line_text:<{feedback_col_width}} {'':{points_col_width}}"
+                        lines.append(row)
+
+                    subitem_points_deducted += points
+
+        if subitem_points_deducted == 0:
+            lines.append(
+                f"{'No deductions':<{feedback_col_width}} {'0.0':>{points_col_width}}"
+            )
+
+        lines.append("-" * 60)
+        subitem_score = subitem_points_possible - subitem_points_deducted
+        lines.append(
+            f"{'Subitem Total:':<{feedback_col_width}} {subitem_score:>{points_col_width}.1f} / {subitem_points_possible:.1f}"
+        )
+        lines.append("")
+
+        total_points_deducted += subitem_points_deducted
+
+    # Total score section
+    lines.append("=" * 60)
+    total_score = total_points_possible - total_points_deducted
+    lines.append(
+        f"{'TOTAL SCORE:':<{feedback_col_width}} {total_score:>{points_col_width}.1f} / {total_points_possible:.1f}"
+    )
+    lines.append("=" * 60)
+
+    return "\n".join(lines)
+
+
+def _wrap_text(text: str, width: int) -> list:
+    """Wrap text to fit within a given width.
+
+    Args:
+        text: The text to wrap.
+        width: Maximum width for each line.
+
+    Returns:
+        List of wrapped lines.
+    """
+    if len(text) <= width:
+        return [text]
+
+    words = text.split()
+    lines = []
+    current_line = ""
+
+    for word in words:
+        if not current_line:
+            current_line = word
+        elif len(current_line) + 1 + len(word) <= width:
+            current_line += " " + word
+        else:
+            lines.append(current_line)
+            current_line = word
+
+    if current_line:
+        lines.append(current_line)
+
+    return lines if lines else [""]

ygrader-1.2.1/ygrader/sub_items.py → ygrader-1.2.2/ygrader/grading_item_config.py

@@ -1,4 +1,4 @@
-"""Module for handling parent items and sub-items in the grading system."""
+"""Module for handling grade item configs and grade subitem configs in the grading system."""
 
 import pathlib
 
@@ -9,8 +9,8 @@ from . import grades_csv
 from .utils import sanitize_filename
 
 
-class ParentItem:
-    """Represents a parent item in the grading system."""
+class GradeItemConfig:
+    """Represents a grade column configuration in the grading system, with a one-to-one mapping to a LearningSuite column"""
 
     def __init__(self, yaml_path: pathlib.Path):
         self.subitems = []
@@ -59,7 +59,7 @@ class ParentItem:
             other_data = {
                 k: v for k, v in subitem_data.items() if k not in ("name", "points")
             }
-            self.subitems.append(SubItem(yaml_path.parent, name, points, other_data))
+            self.subitems.append(GradeSubitemConfig(yaml_path.parent, name, points, other_data))
 
         # Parse any other data in the YAML file beyond 'parent_column' and 'columns'
         self.other_data = {
@@ -74,8 +74,8 @@ class ParentItem:
         raise ValueError(f"Sub-item with name '{name}' not found.")
 
 
-class SubItem:
-    """Represents a sub-item in the grading system."""
+class GradeSubitemConfig:
+    """Represents a grade subitem configuration in the grading system."""
 
     def __init__(
         self, dir_path: pathlib.Path, name: str, points: float, other_data: dict = None
@@ -90,17 +90,17 @@ class SubItem:
 def generate_subitem_csvs(grades_csv_path, item_yaml_path) -> None:
     """Generate CSV files for sub-items based on the provided item YAML path."""
     item_yaml_path = pathlib.Path(item_yaml_path)
-    parent_item = ParentItem(item_yaml_path)
+    grade_item_config = GradeItemConfig(item_yaml_path)
     # grader = Grader("", grades_csv_path)
 
-    grades_df = grades_csv.parse_and_check(grades_csv_path, [parent_item.csv_col_name])
+    grades_df = grades_csv.parse_and_check(grades_csv_path, [grade_item_config.csv_col_name])
 
     # Create subitems subdirectory
     subitems_dir = item_yaml_path.parent / "subitems"
     subitems_dir.mkdir(exist_ok=True)
 
     overwrite_all = False
-    for subitem in parent_item.subitems:
+    for subitem in grade_item_config.subitems:
         subitem_csv_path = subitems_dir / f"{subitem.filename}.csv"
 
         # Check if file already exists and ask user if they want to overwrite

{ygrader-1.2.1 → ygrader-1.2.2/ygrader.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ygrader
-Version: 1.2.1
+Version: 1.2.2
 Summary: Grading scripts used in BYU's Electrical and Computer Engineering Department
 Home-page: https://github.com/byu-cpe/ygrader
 Author: Jeff Goeders

{ygrader-1.2.1 → ygrader-1.2.2}/ygrader.egg-info/SOURCES.txt

@@ -4,13 +4,14 @@ test/test_interactive.py
 test/test_unittest.py
 ygrader/__init__.py
 ygrader/deductions.py
+ygrader/feedback.py
 ygrader/grader.py
 ygrader/grades_csv.py
 ygrader/grading_item.py
+ygrader/grading_item_config.py
 ygrader/score_input.py
 ygrader/send_ctrl_backtick.ahk
 ygrader/student_repos.py
-ygrader/sub_items.py
 ygrader/upstream_merger.py
 ygrader/utils.py
 ygrader.egg-info/PKG-INFO