PyKubeGrader 0.1.11__py3-none-any.whl → 0.1.13__py3-none-any.whl

{PyKubeGrader-0.1.11.dist-info → PyKubeGrader-0.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyKubeGrader
-Version: 0.1.11
+Version: 0.1.13
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: jagar2

{PyKubeGrader-0.1.11.dist-info → PyKubeGrader-0.1.13.dist-info}/RECORD

@@ -1,10 +1,10 @@
 pykubegrader/__init__.py,sha256=AoAkdfIjDDZGWLlsIRENNq06L9h46kDGBIE8vRmsCfg,311
-pykubegrader/initialize.py,sha256=SREGdFK8kqnk8RYTtaTO5LKZiK2Y4YxBNjrALl5jaNo,1956
-pykubegrader/telemetry.py,sha256=Zkap_ml7hWz7akBVzE-zqri_K-AkBSTEhv0IE3VM9iY,3943
+pykubegrader/initialize.py,sha256=3mz-Zv1mlmHTRNktObmOIbBRsipg16JX6wg9-_vFQe4,3043
+pykubegrader/telemetry.py,sha256=4-YdfAepiKO8y9TFoU_ktI64iFTIuKK3RcAXIz0KmP0,3972
 pykubegrader/utils.py,sha256=dKw6SyRYU3DWRgD3xER7wq-C9e1daWPkqr901LpcwiQ,642
-pykubegrader/validate.py,sha256=PeT6Gx4ZOQYyogG4nb3TD9YfEkAmf__fR1aOOB3ZBWo,10705
-pykubegrader/build/api_notebook_builder.py,sha256=vtRA9lDCc-PXN-y56wEXS-h_aKXDU_ChS-1_ooiKCOk,18975
-pykubegrader/build/build_folder.py,sha256=m7PkiAvpC5kIcm9A2BLtTncWJo4S1fuup5ZCo35VZys,63323
+pykubegrader/validate.py,sha256=F0SuGGj236rFr0HFLhuF1R1whrs2vhbDrG5qu_0PojQ,10707
+pykubegrader/build/api_notebook_builder.py,sha256=DPxjBhqUmSVF3PVhvgBbZR2BaCpp6Zt9fDUFyR_CAX0,19126
+pykubegrader/build/build_folder.py,sha256=Iw20V65Eggli4noS4WaNJJcYmo185A01ofxQBtODYec,64366
 pykubegrader/widgets/__init__.py,sha256=s3ky3eJDa1RedFVdpKxmqv6mHBYpOSL9Z6qThSH9cbs,303
 pykubegrader/widgets/multiple_choice.py,sha256=NjD3-uXSnibpUQ0mO3hRp_O-rynFyl0Dz6IXE4tnCRI,2078
 pykubegrader/widgets/reading_question.py,sha256=y30_swHwzH8LrT8deWTnxctAAmR8BSxTlXAqMgUrAT4,3031
@@ -17,9 +17,9 @@ pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-
 pykubegrader/widgets_base/multi_select.py,sha256=u50IOhYxC_S_gq31VnFPLdbNajk_SUWhaqlMSJxhqVQ,3439
 pykubegrader/widgets_base/reading.py,sha256=4uTLmlPzCwxVzufFhPjM7W19uMGguRb6y4eAV3x-zAc,5314
 pykubegrader/widgets_base/select.py,sha256=h1S5StcbX8S-Wiyga4fVDhPbVvRxffwaqyVbiiuInRs,2743
-PyKubeGrader-0.1.11.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.1.11.dist-info/METADATA,sha256=as-usJZup_AKIA1HVysnVKuWs9XlZfAtWNUhFriar0s,2665
-PyKubeGrader-0.1.11.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-PyKubeGrader-0.1.11.dist-info/entry_points.txt,sha256=Kd4Bh-i3hc4qlnLU1p0nc8yPw9cC5AQGOtkk2eLGnQw,78
-PyKubeGrader-0.1.11.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.1.11.dist-info/RECORD,,
+PyKubeGrader-0.1.13.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.1.13.dist-info/METADATA,sha256=GMuh1zsIM9Ft5nioXmqsLiCT9tQqdCerweyPoiq8cig,2665
+PyKubeGrader-0.1.13.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+PyKubeGrader-0.1.13.dist-info/entry_points.txt,sha256=Kd4Bh-i3hc4qlnLU1p0nc8yPw9cC5AQGOtkk2eLGnQw,78
+PyKubeGrader-0.1.13.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.1.13.dist-info/RECORD,,

pykubegrader/build/api_notebook_builder.py

@@ -1,11 +1,12 @@
+import ast
+import json
+import re
+import shutil
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional
-import json
+
 import nbformat
-import json
-import re
-import shutil
 
 
 @dataclass
@@ -20,7 +21,6 @@ class FastAPINotebookBuilder:
         self.run()
 
     def run(self):
-
         # here for easy debugging
         if self.temp_notebook is not None:
             shutil.copy(
@@ -34,7 +34,6 @@ class FastAPINotebookBuilder:
         self.add_api_code()
 
     def add_api_code(self):
-
         for i, (cell_index, cell_dict) in enumerate(self.assertion_tests_dict.items()):
             print(
                 f"Processing cell {cell_index + 1}, {i} of {len(self.assertion_tests_dict)}"
@@ -77,7 +76,9 @@ class FastAPINotebookBuilder:
             )
             updated_cell_source.extend(["earned_points += score\n"])
             updated_cell_source.extend(
-                [f'log_variable(f"{{score}}, {{max_score}}", question_id)\n']
+                [
+                    f'log_variable(f"{{score}}, {{max_score}}", question_id, "{self.filename.split(".")[0]}")\n'
+                ]
             )
             updated_cell_source.extend(
                 ["os.environ['EARNED_POINTS'] = str(earned_points)\n"]
@@ -105,7 +106,6 @@ class FastAPINotebookBuilder:
     @staticmethod
     def construct_update_responses(cell_dict):
         update_responses = []
-        question_id = cell_dict["question"] + "-" + str(cell_dict["test_number"]) + "\n"
 
         logging_variables = cell_dict["logging_variables"]
 
@@ -141,7 +141,6 @@ class FastAPINotebookBuilder:
 
     @staticmethod
     def construct_graders(cell_dict):
-
         # Generate Python code
         added_code = [
             "if "
@@ -205,7 +204,7 @@ class FastAPINotebookBuilder:
             "    ensure_responses,\n",
             "    log_variable,\n",
             "    score_question,\n",
-            "    submit_question_new,\n",
+            "    submit_question,\n",
             "    telemetry,\n",
             "    update_responses,\n",
             ")\n",
@@ -283,7 +282,7 @@ class FastAPINotebookBuilder:
         """
         last_import_index = -1
         is_multiline_import = False  # Flag to track if we're inside a multiline import
-        
+
         for i, line in enumerate(cell_source):
             stripped_line = line.strip()
 
@@ -313,11 +312,15 @@ class FastAPINotebookBuilder:
         if "source" in cell:
             for line in cell["source"]:
                 # Look for the log_variables pattern
-                match = re.search(r"log_variables:\s*\[(.*?)\]", line)
+                match = re.search(r"log_variables:\s*(\[.*\])", line)
                 if match:
-                    # Split the variables by comma and strip whitespace
-                    log_variables = [var.strip() for var in match.group(1).split(",")]
-                    return log_variables
+                    # Parse the list using ast.literal_eval for safety
+                    try:
+                        log_variables = ast.literal_eval(match.group(1))
+                        if isinstance(log_variables, list):
+                            return [var.strip() for var in log_variables]
+                    except (SyntaxError, ValueError):
+                        pass
         return []
 
     def tag_questions(cells_dict):
@@ -363,7 +366,6 @@ class FastAPINotebookBuilder:
         return cells_dict
 
     def question_dict(self):
-
         notebook_path = Path(self.temp_notebook)
         if not notebook_path.exists():
             raise FileNotFoundError(f"The file {notebook_path} does not exist.")

pykubegrader/build/build_folder.py

@@ -8,7 +8,9 @@ import shutil
 import subprocess
 import sys
 from dataclasses import dataclass, field
+
 import nbformat
+
 from .api_notebook_builder import FastAPINotebookBuilder
 
 
@@ -278,26 +280,38 @@ class NotebookProcessor:
         self, temp_notebook_path, notebook_subfolder, notebook_name
     ):
         if self.has_assignment(temp_notebook_path, "# ASSIGNMENT CONFIG"):
-
             # TODO: This is hardcoded for now, but should be in a configuration file.
             client_private_key = os.path.join(
                 notebook_subfolder,
-                "client_private_key.bin",
+                ".client_private_key.bin",
             )
             server_public_key = os.path.join(
                 notebook_subfolder,
-                "server_public_key.bin",
+                ".server_public_key.bin",
             )
 
-            shutil.copy("./keys/client_private_key.bin", client_private_key)
-            shutil.copy("./keys/server_public_key.bin", server_public_key)
+            shutil.copy("./keys/.client_private_key.bin", client_private_key)
+            shutil.copy("./keys/.server_public_key.bin", server_public_key)
 
             FastAPINotebookBuilder(notebook_path=temp_notebook_path)
 
+            debug_notebook = os.path.join(
+                notebook_subfolder,
+                "dist",
+                "autograder",
+                os.path.basename(temp_notebook_path).replace("_temp", "_debugger"),
+            )
+
             self.run_otter_assign(
                 temp_notebook_path, os.path.join(notebook_subfolder, "dist")
             )
 
+            print(f"Copying {temp_notebook_path} to {debug_notebook}")
+
+            shutil.copy(temp_notebook_path, debug_notebook)
+
+            NotebookProcessor.remove_assignment_config_cells(debug_notebook)
+
             student_notebook = os.path.join(
                 notebook_subfolder, "dist", "student", f"{notebook_name}.ipynb"
             )
@@ -329,6 +343,23 @@ class NotebookProcessor:
             NotebookProcessor.add_initialization_code(temp_notebook_path)
             return None
 
+    @staticmethod
+    def remove_assignment_config_cells(notebook_path):
+        # Read the notebook
+        with open(notebook_path, "r", encoding="utf-8") as f:
+            notebook = nbformat.read(f, as_version=nbformat.NO_CONVERT)
+
+        # Filter out cells containing "# ASSIGNMENT CONFIG"
+        notebook.cells = [
+            cell
+            for cell in notebook.cells
+            if "# ASSIGNMENT CONFIG" not in cell.get("source", "")
+        ]
+
+        # Save the updated notebook
+        with open(notebook_path, "w", encoding="utf-8") as f:
+            nbformat.write(notebook, f)
+
     @staticmethod
     def add_initialization_code(notebook_path):
         # finds the first code cell
@@ -340,7 +371,6 @@ class NotebookProcessor:
         replace_cell_source(notebook_path, index, cell)
 
     def multiple_choice_parser(self, temp_notebook_path, new_notebook_path):
-
         ### Parse the notebook for multiple choice questions
         if self.has_assignment(temp_notebook_path, "# BEGIN MULTIPLE CHOICE"):
             self._print_and_log(

pykubegrader/initialize.py

@@ -1,68 +1,106 @@
-import json
 import os
-from typing import Optional
+import shutil
+from pathlib import Path
 
 import panel as pn
-from IPython import get_ipython
 import requests
-from .telemetry import telemetry, update_responses, ensure_responses
+from IPython import get_ipython
+
+from .telemetry import ensure_responses, telemetry, update_responses
+
+
+def initialize_assignment(
+    name: str,
+    url: str = "https://engr-131-api.eastus.cloudapp.azure.com/",
+    verbose: bool = False,
+) -> dict:
+    """
+    Initialize an assignment in a Jupyter environment.
 
+    Args:
+        name (str): The name of the assignment.
+        url (str): The URL of the API server.
+        verbose (bool): Whether to print detailed initialization information.
 
+    Returns:
+        dict: The responses dictionary after initialization.
 
-def initialize_assignment(name: str, 
-                          verbose: Optional[bool] = False,
-                          url: Optional[str] = "https://engr-131-api.eastus.cloudapp.azure.com/") -> None:
+    Raises:
+        Exception: If the environment is unsupported or initialization fails.
+    """
 
     ipython = get_ipython()
     if ipython is None:
-        print("Setup unsuccessful. Are you in a Jupyter environment?")
-        return
+        raise Exception("Setup unsuccessful. Are you in a Jupyter environment?")
 
     try:
+        move_dotfiles()
         ipython.events.register("pre_run_cell", telemetry)
-    except TypeError as e:
-        print(f"Failed to register telemetry: {e}")
-        return
+    except Exception as e:
+        raise Exception(f"Failed to register telemetry: {e}")
 
     jhub_user = os.getenv("JUPYTERHUB_USER")
     if jhub_user is None:
-        print("Setup unsuccessful. Are you on JupyterHub?")
-        return
+        raise Exception("Setup unsuccessful. Are you on JupyterHub?")
 
     try:
         seed = hash(jhub_user) % 1000
         update_responses(key="seed", value=seed)
+
         update_responses(key="assignment", value=name)
         update_responses(key="jhub_user", value=jhub_user)
 
-    except (TypeError, json.JSONDecodeError) as e:
-        print(f"Failed to initialize assignment: {e}")
-        return
-    
-    
-    # extract responses
-    responses = ensure_responses()
-    
-    # TODO: Add more checks here??        
-    assert isinstance(responses.get('seed'), int), "valid seed not found in responses"
+        responses = ensure_responses()
+        # TODO: Add more checks here?
+        assert isinstance(responses.get("seed"), int), "Seed not set"
+
+        pn.extension(silent=True)
 
-    pn.extension(silent=True)
+        # Check connection to API server
+        params = {"jhub_user": responses["jhub_user"]}
+        response = requests.get(url, params=params)
+        if verbose:
+            print(f"status code: {response.status_code}")
+            data = response.json()
+            for k, v in data.items():
+                print(f"{k}: {v}")
+    except Exception as e:
+        raise Exception(f"Failed to initialize assignment: {e}")
 
+    print("Assignment successfully initialized")
     if verbose:
-        print("Assignment successfully initialized")
         print(f"Assignment: {name}")
         print(f"Username: {jhub_user}")
-        
 
-    
-    # Checks connectivity to the API
-    params = { "jhub_user": responses["jhub_user"] }
-    response = requests.get(url, params=params)
-    if verbose:
-        print(f"status code: {response.status_code}")
-        data = response.json()
-        for k, v in data.items():
-            print(f"{k}: {v}")
-        
-    print("Assignment successfully initialized")
     return responses
+
+
+#
+# Helper functions
+#
+
+
+def move_dotfiles():
+    """
+    Move essential dotfiles from a fixed source directory to the current working directory.
+
+    Raises:
+        FileNotFoundError: If a source file is missing.
+        Exception: If copying fails for any other reason.
+    """
+    source_dir = Path("/opt/dotfiles")
+    target_dir = Path.cwd()
+
+    files_to_copy = [".client_private_key.bin", ".server_public_key.bin"]
+
+    for file_name in files_to_copy:
+        source_file = source_dir / file_name
+        target_file = target_dir / file_name
+
+        if not source_file.exists():
+            raise FileNotFoundError(f"Key file not found: {source_file}")
+
+        try:
+            shutil.copy2(source_file, target_file)
+        except Exception as e:
+            raise Exception(f"Failed to copy {source_file} to {target_file}: {e}")

pykubegrader/telemetry.py

@@ -20,11 +20,11 @@ logging.basicConfig(filename=".output.log", level=logging.INFO, force=True)
 
 
 def encrypt_to_b64(message: str) -> str:
-    with open("server_public_key.bin", "rb") as f:
+    with open(".server_public_key.bin", "rb") as f:
         server_pub_key_bytes = f.read()
     server_pub_key = nacl.public.PublicKey(server_pub_key_bytes)
 
-    with open("client_private_key.bin", "rb") as f:
+    with open(".client_private_key.bin", "rb") as f:
         client_private_key_bytes = f.read()
     client_priv_key = nacl.public.PrivateKey(client_private_key_bytes)
 
@@ -36,7 +36,6 @@ def encrypt_to_b64(message: str) -> str:
 
 
 def ensure_responses() -> dict:
-
     with open(".responses.json", "a") as _:
         pass
 
@@ -48,7 +47,7 @@ def ensure_responses() -> dict:
     except json.JSONDecodeError:
         with open(".responses.json", "w") as f:
             json.dump(responses, f)
-    
+
     return responses
 
 
@@ -57,9 +56,9 @@ def log_encrypted(message: str) -> None:
     logging.info(f"Encrypted Output: {encrypted_b64}")
 
 
-def log_variable(value, info_type) -> None:
+def log_variable(assignment_name, value, info_type) -> None:
     timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-    message = f"{info_type}, {value}, {timestamp}"
+    message = f"{info_type}, {value}, {timestamp}, {assignment_name}"
     log_encrypted(message)
 
 
@@ -120,7 +119,7 @@ def score_question(
     return res
 
 
-def submit_question_new(
+def submit_question(
     student_email: str,
     term: str,
     assignment: str,

pykubegrader/validate.py

@@ -252,11 +252,11 @@ def validate_logfile(
 
 
 def generate_keys() -> nacl.public.Box:
-    with open("server_private_key.bin", "rb") as priv_file:
+    with open(".server_private_key.bin", "rb") as priv_file:
         server_private_key_bytes = priv_file.read()
     server_priv_key = nacl.public.PrivateKey(server_private_key_bytes)
 
-    with open("client_public_key.bin", "rb") as pub_file:
+    with open(".client_public_key.bin", "rb") as pub_file:
         client_public_key_bytes = pub_file.read()
     client_pub_key = nacl.public.PublicKey(client_public_key_bytes)