assignment-codeval 0.0.25__py3-none-any.whl → 0.0.26__py3-none-any.whl

assignment_codeval/evaluate.py

@@ -28,6 +28,7 @@ def get_testing_path(filename: str) -> str:
 test_args = ""
 cmps = []
 timeout_val = 10
+output_length_limit = 4096
 expected_exit_code = -1
 test_case_count = 0
 test_case_hint = ""
@@ -643,6 +644,19 @@ def timeout(timeout_sec):
     timeout_val = float(timeout_sec)
 
 
+def output_length(length):
+    """Specifies the maximum number of bytes of diff output to render. Defaults to 4096.
+
+    Arguments:
+        length: maximum output length in bytes
+
+    Returns:
+        None
+    """
+    global output_length_limit
+    output_length_limit = int(length)
+
+
 def exit_code(test_case_exit_code):
     """Specifies the expected exit code for a test case. Defaults to zero.
 
@@ -726,6 +740,7 @@ tag_func_map = {
     "EB": check_error_bare,
     "HINT": hint,
     "TO": timeout,
+    "OLEN": output_length,
     "X": exit_code,
     "SS": start_server,
 }
@@ -907,6 +922,72 @@ def parse_diff(diff_lines: list[str], testing_dir: str):
                     outfile.write(line)
 
 
+def _render_diff_output(raw_bytes: bytes) -> str:
+    """Render raw bytes for diff output, making unprintable characters visible.
+
+    Replaces the shell pipeline `cat -te | head -22` with pure Python.
+    """
+    result = []
+    i = 0
+    n = len(raw_bytes)
+
+    while i < n:
+        b = raw_bytes[i]
+
+        if b == 0x0A:  # newline
+            result.append("$\n")
+            i += 1
+        elif b == 0x20 or (0x21 <= b <= 0x7E):  # space or printable ASCII
+            result.append(chr(b))
+            i += 1
+        elif b <= 0x1F:  # control chars (except newline handled above)
+            result.append("^" + chr(b + 0x40))
+            i += 1
+        elif b == 0x7F:  # DEL
+            result.append("^?")
+            i += 1
+        elif b >= 0x80:
+            # Try to decode as UTF-8 multi-byte sequence
+            seq_len = 0
+            if (b & 0xE0) == 0xC0:
+                seq_len = 2
+            elif (b & 0xF0) == 0xE0:
+                seq_len = 3
+            elif (b & 0xF8) == 0xF0:
+                seq_len = 4
+
+            decoded_char = None
+            if seq_len >= 2 and i + seq_len <= n:
+                try:
+                    decoded_char = raw_bytes[i:i + seq_len].decode("utf-8")
+                except UnicodeDecodeError:
+                    pass
+
+            if decoded_char and len(decoded_char) == 1 and decoded_char.isprintable():
+                result.append(decoded_char)
+                i += seq_len
+            elif decoded_char and len(decoded_char) == 1:
+                # Valid UTF-8 but non-printable: render each byte as \xCC
+                for j in range(seq_len):
+                    result.append(f"\\x{raw_bytes[i + j]:02X}")
+                i += seq_len
+            else:
+                # Invalid UTF-8 byte
+                result.append(f"\\x{b:02X}")
+                i += 1
+        else:
+            result.append(chr(b))
+            i += 1
+
+    output = "".join(result)
+
+    # If output doesn't end with \n, append $ at the very end
+    if output and not output.endswith("\n"):
+        output += "$"
+
+    return output
+
+
 def _find_touched_files(pre_run_timestamp):
     """Find files touched (modified or accessed) since pre_run_timestamp.
 
@@ -960,24 +1041,22 @@ def check_test():
     # Difflog handling
     with open(get_testing_path("difflog"), "w") as outfile:
         diff_popen = subprocess.Popen(
-            f"diff -U1 -a ./{TESTING_DIR}/youroutput ./{TESTING_DIR}/expectedoutput | cat -te | head -22",
-            shell=True,
-            stdout=outfile,
-            stderr=outfile,
-            text=True,
+            ["diff", "-U1", "-a",
+             f"./{TESTING_DIR}/youroutput", f"./{TESTING_DIR}/expectedoutput"],
+            stdout=subprocess.PIPE, stderr=subprocess.PIPE,
         )
-        diff_popen.communicate()
+        raw_output, _ = diff_popen.communicate()
+        outfile.write(_render_diff_output(raw_output[:output_length_limit]))
 
     # Append to difflog second time around
     with open(get_testing_path("difflog"), "a") as outfile:
         diff_popen = subprocess.Popen(
-            f"diff -U1 -a ./{TESTING_DIR}/yourerror ./{TESTING_DIR}/expectederror | cat -te | head -22",
-            shell=True,
-            stdout=outfile,
-            stderr=outfile,
-            text=True,
+            ["diff", "-U1", "-a",
+             f"./{TESTING_DIR}/yourerror", f"./{TESTING_DIR}/expectederror"],
+            stdout=subprocess.PIPE, stderr=subprocess.PIPE,
         )
-        diff_popen.communicate()
+        raw_output, _ = diff_popen.communicate()
+        outfile.write(_render_diff_output(raw_output[:output_length_limit]))
 
     # Now read all the lines to accumulate both diffs
     with open(get_testing_path("difflog"), "r") as infile:

assignment_codeval/submissions.py

@@ -180,6 +180,37 @@ def delete_submission_comment(canvas, course_id, assignment_id, user_id, comment
     resp.raise_for_status()
 
 
+def _parse_substitutions_file(filepath):
+    """Parse a substitutions file where each line has the form /pattern/replacement/.
+
+    The first character of each line defines the delimiter. The delimiter must appear
+    exactly once in-between (separating pattern from replacement) and once at the end.
+    Returns a list of (pattern, replacement) tuples.
+    Raises click.ClickException on parse errors.
+    """
+    substitutions = []
+    with open(filepath, "r") as fd:
+        for lineno, line in enumerate(fd, start=1):
+            line = line.rstrip("\n")
+            if not line:
+                continue
+            delim = line[0]
+            parts = line[1:].split(delim)
+            if len(parts) != 3 or parts[2] != "":
+                raise click.ClickException(
+                    f"{filepath}:{lineno}: invalid substitution line: {line}"
+                )
+            substitutions.append((parts[0], parts[1]))
+    return substitutions
+
+
+def _apply_substitutions(comment, substitutions):
+    """Apply a list of (pattern, replacement) substitutions to comment text."""
+    for pattern, replacement in substitutions:
+        comment = comment.replace(pattern, replacement)
+    return comment
+
+
 @click.command()
 @click.argument("submissions_dir", metavar="SUBMISSIONS_DIR")
 @click.option("--codeval-prefix", help="prefix for codeval comments", default="codeval: ", show_default=True)
@@ -214,8 +245,12 @@ def upload_submission_comments(submissions_dir, codeval_prefix, delete):
                     write_html_file(dirpath)
                     file_id = upload_file_for_comment(canvas, course.id, assignment.id, student_id, f"{dirpath}/results.html")
                     with open(f"{dirpath}/comments.txt", "r") as fd:
-                        comment = fd.read()
-                        comment = comment.replace("\0", "\\0").strip()
+                        comment = fd.read(4096)
+                        comment = comment.replace("\0", "\\0").strip().replace("<", "&lt;")
+                    subs_file = f"{dirpath}/SUBSTITUTIONS.txt"
+                    if os.path.isfile(subs_file):
+                        substitutions = _parse_substitutions_file(subs_file)
+                        comment = _apply_substitutions(comment, substitutions)
                     if delete:
                         all_comments = sorted(submission.submission_comments, key=lambda c: c['created_at'])
                         if all_comments:
@@ -226,7 +261,7 @@ def upload_submission_comments(submissions_dir, codeval_prefix, delete):
                         f'{canvas_url}/api/v1/courses/{course.id}/assignments/{assignment.id}/submissions/{student_id}',
                         headers={'Authorization': f'Bearer {canvas_token}'},
                         data={
-                            'comment[text_comment]': f'{codeval_prefix.rstrip()}\n{comment}',
+                            'comment[text_comment]': f'{codeval_prefix.rstrip()}\n<pre>{comment}</pre>',
                             'comment[file_ids][]': file_id,
                         }
                     ).raise_for_status()
@@ -312,6 +347,9 @@ def evaluate_submissions(codeval_dir, submissions_dir):
         if not move_to_next_submission:
             for zf_name in zip_files:
                 with ZipFile(os.path.join(codeval_dir, zf_name)) as zf:
+                    if "SUBSTITUTIONS.txt" in zf.namelist():
+                        with open(os.path.join(dirpath, "SUBSTITUTIONS.txt"), "wb") as out_f:
+                            out_f.write(zf.read("SUBSTITUTIONS.txt"))
                     for f in zf.infolist():
                         dest_dir = os.path.join(submission_dir, assignment_working_dir)
                         zf.extract(f, dest_dir)

{assignment_codeval-0.0.25.dist-info → assignment_codeval-0.0.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: assignment-codeval
-Version: 0.0.25
+Version: 0.0.26
 Summary: CodEval for evaluating programming assignments
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown

{assignment_codeval-0.0.25.dist-info → assignment_codeval-0.0.26.dist-info}/RECORD

@@ -6,16 +6,16 @@ assignment_codeval/cli.py,sha256=Vl27zNI7kI0QEZoXTIE2aTrraEJWj9vgJiyVWou3vgU,135
 assignment_codeval/commons.py,sha256=rr09qHacHoLmmU8S9sBss4_utb0DH8-IyL9Dsj0ycE0,1412
 assignment_codeval/convertMD2Html.py,sha256=4yu41U4Up1oGI5vDZGelmuogwFmEZrRS55M4ZHbRfaE,6243
 assignment_codeval/create_assignment.py,sha256=oZ-0LadVb6R-rXVg0Lz5itziaalIvFoxd71cIxgMfow,10815
-assignment_codeval/evaluate.py,sha256=knUWxOmnQNeod1wKSoMBYIhqOp5q60BgOxAzZbp2xrs,33720
+assignment_codeval/evaluate.py,sha256=er21lA-eohP1BfHPYPWRw9m0a_IOeljMNtcidOYacJY,36253
 assignment_codeval/export_tests.py,sha256=IDAlGAp3zk-K5AFwLr85v4w9_WcYr6HXVF0joi4eYTg,5467
 assignment_codeval/file_utils.py,sha256=RDgAgmyIOLKvRlxbAr-zILz2A24zSr-r3--p-dxl4G8,2132
 assignment_codeval/github_connect.py,sha256=AP7mZPhzKKK8fxS-3JMfG6AQ-1wUutfsq-Bt-KG9WUs,4270
 assignment_codeval/install_assignment.py,sha256=HsXzTex4G-U3t4tb-HyQ2AobBDBPcKeR6oAUDFqBP-A,4599
 assignment_codeval/recent_comments.py,sha256=e8UQL2_9dsPlf-NYFrGSaM6h6XYnTf_MW2jWhtEsb38,9097
-assignment_codeval/submissions.py,sha256=fIhov4fdRVNDw5xjbRHs4zqBtyNM1f8cy220-G1Vqnk,26598
+assignment_codeval/submissions.py,sha256=YbwKynZwWsmcyytwRi3Kuxq3WN-V-vvshO9JrNJoxAs,28333
 assignment_codeval/test_template.html,sha256=lgWsin5sYE_Pwjp3xqa7_UT-yZ4dWrVqAvNlSBBiNMI,2584
-assignment_codeval-0.0.25.dist-info/METADATA,sha256=8Gn38IZ3P6JhWRjkPRG0keYNjq9GfgMBkv1u27Ha7iQ,15589
-assignment_codeval-0.0.25.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
-assignment_codeval-0.0.25.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
-assignment_codeval-0.0.25.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
-assignment_codeval-0.0.25.dist-info/RECORD,,
+assignment_codeval-0.0.26.dist-info/METADATA,sha256=CvKtHeb1kR3x4Sz0ojGIKui1v_Q1ejiColTIShfMOfg,15589
+assignment_codeval-0.0.26.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+assignment_codeval-0.0.26.dist-info/entry_points.txt,sha256=Pk0eAhsXBpCsgkv6HYLSHTRf5x_zUf-Lg8KK9KsK2B8,66
+assignment_codeval-0.0.26.dist-info/top_level.txt,sha256=a_P8W2IWjAELxKlTV2t4rLwWVoTxElxUMvWgWjR_1n4,19
+assignment_codeval-0.0.26.dist-info/RECORD,,