PyKubeGrader 0.3.4__py3-none-any.whl → 0.3.5__py3-none-any.whl

{PyKubeGrader-0.3.4.dist-info → PyKubeGrader-0.3.5.dist-info}/METADATA

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

{PyKubeGrader-0.3.4.dist-info → PyKubeGrader-0.3.5.dist-info}/RECORD

@@ -5,7 +5,7 @@ pykubegrader/telemetry.py,sha256=ooLK-dY_hJQ7t4r83hWyO8wx6F_7TfWJS7tCp_nH7r8,130
 pykubegrader/utils.py,sha256=jlJklKvRhY3O7Hz2aaU1m0y3p_n9eMAXNnAF7LUEaPY,1275
 pykubegrader/validate.py,sha256=OKnItGyd-L8QPKcsE0KRuwBI_IxKiJzMLJKZiA2j3II,11184
 pykubegrader/build/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/build/api_notebook_builder.py,sha256=dlcVrGgsvxnt6GlAUN3e-FrpsPNJKXSHni1fstRCBik,20311
+pykubegrader/build/api_notebook_builder.py,sha256=320aFB1-6KLQt0OMmKD0FJtE17JKZaK5neA0mTD-Y8M,22960
 pykubegrader/build/build_folder.py,sha256=Asc-VdhXgxQfOfFIWJShhXrF2EITJOIZQ5Dz_2y-P2I,85358
 pykubegrader/build/clean_folder.py,sha256=8N0KyL4eXRs0DCw-V_2jR9igtFs_mOFMQufdL6tD-38,1323
 pykubegrader/build/collate.py,sha256=cVvF7tf2U3iiH4R_dbghTcieedIx5w3Fyw9L_llInM8,6754
@@ -29,12 +29,12 @@ pykubegrader/widgets/style.py,sha256=fVBMYy_a6Yoz21avNpiORWC3f5FD-OrVpaZ3npmunvs
 pykubegrader/widgets/true_false.py,sha256=QllIhHuJstJft_RuShkxI_fFFTaDAlzNZOFNs00HLIM,2842
 pykubegrader/widgets/types_question.py,sha256=kZdRRXyFzOtYTmGdC7XWb_2oaxqg1WSuLcQn_sTj6Qc,2300
 pykubegrader/widgets_base/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-pykubegrader/widgets_base/multi_select.py,sha256=JgjhHQJL8Pf0-1T_wdZCecAK1IgVJrZBCbR6b3jvDtk,4181
+pykubegrader/widgets_base/multi_select.py,sha256=KtfAP0PyEbcjWlKNpI5_5-PLMtcUbbNX0Es_-w-H34Q,4226
 pykubegrader/widgets_base/reading.py,sha256=ChUS3NOTa_HLtNpxR8hGX80LPKMvYMypnR6dFknfxus,5430
-pykubegrader/widgets_base/select.py,sha256=tEDg7GEjsZnz1646YTthTeamujVRS5jDJWMsXhmOQbI,2705
-PyKubeGrader-0.3.4.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
-PyKubeGrader-0.3.4.dist-info/METADATA,sha256=6aq3PWnDPR8lNxPMmWvDkbd2GvZNfLkpYNcpOLSbHqc,2729
-PyKubeGrader-0.3.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-PyKubeGrader-0.3.4.dist-info/entry_points.txt,sha256=RR57KvzDRJrP4omy5heS5cZ3E7g56YxcxJhDnp57ZU0,253
-PyKubeGrader-0.3.4.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
-PyKubeGrader-0.3.4.dist-info/RECORD,,
+pykubegrader/widgets_base/select.py,sha256=uMncmVIqjvJkffMQY1L_PokrFCidK1PeVITX0i70fho,2750
+PyKubeGrader-0.3.5.dist-info/LICENSE.txt,sha256=YTp-Ewc8Kems8PJEE27KnBPFnZSxoWvSg7nnknzPyYw,1546
+PyKubeGrader-0.3.5.dist-info/METADATA,sha256=a5vrrGdf4XTTSfKPAuQ-2HaHISFczwu6uSy6KkrrQv4,2729
+PyKubeGrader-0.3.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+PyKubeGrader-0.3.5.dist-info/entry_points.txt,sha256=RR57KvzDRJrP4omy5heS5cZ3E7g56YxcxJhDnp57ZU0,253
+PyKubeGrader-0.3.5.dist-info/top_level.txt,sha256=e550Klfze6higFxER1V62fnGOcIgiKRbsrl9CC4UdtQ,13
+PyKubeGrader-0.3.5.dist-info/RECORD,,

pykubegrader/build/api_notebook_builder.py

@@ -5,6 +5,8 @@ import shutil
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional
+import base64
+from typing import Any, Optional
 
 import nbformat
 
@@ -16,14 +18,14 @@ class FastAPINotebookBuilder:
     assignment_tag: Optional[str] = ""
     require_key: Optional[bool] = False
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.root_path, self.filename = FastAPINotebookBuilder.get_filename_and_root(
             self.notebook_path
         )
         self.total_points = 0
         self.run()
 
-    def run(self):
+    def run(self) -> None:
         # here for easy debugging
         if self.temp_notebook is not None:
             shutil.copy(
@@ -36,7 +38,46 @@ class FastAPINotebookBuilder:
         self.assertion_tests_dict = self.question_dict()
         self.add_api_code()
 
+    @staticmethod
+    def conceal_tests(cell_source):
+        """
+        Takes a list of code lines, detects blocks between `# BEGIN HIDE` and `# END HIDE`,
+        encodes them in Base64, and replaces them with an `exec()` statement.
+
+        Returns a new list of lines with the concealed blocks.
+        """
+
+        concealed_lines = []
+        hide_mode = False
+        hidden_code = []
+
+        for line in cell_source:
+            if "# BEGIN HIDE" in line:
+                hide_mode = True
+                hidden_code = []  # Start a new hidden block
+                concealed_lines.append(line)  # Keep the marker for clarity
+                continue
+            elif "# END HIDE" in line:
+                hide_mode = False
+                # Encode the entire block
+                encoded_block = base64.b64encode(
+                    "\n".join(hidden_code).encode()
+                ).decode()
+                concealed_lines.append(
+                    f'exec(base64.b64decode("{encoded_block}").decode())  # Obfuscated\n'
+                )
+                concealed_lines.append(line)  # Keep the marker for clarity
+                continue
+
+            if hide_mode:
+                hidden_code.append(line.strip())  # Collect hidden code
+            else:
+                concealed_lines.append(line)
+
+        return concealed_lines
+
     def add_api_code(self):
+    def add_api_code(self) -> None:
         self.compute_max_points_free_response()
 
         for i, (cell_index, cell_dict) in enumerate(self.assertion_tests_dict.items()):
@@ -48,6 +89,8 @@ class FastAPINotebookBuilder:
             cell_source = FastAPINotebookBuilder.add_import_statements_to_tests(
                 cell["source"]
             )
+            
+            cell_source = FastAPINotebookBuilder.conceal_tests(cell_source)
 
             last_import_line_ind = FastAPINotebookBuilder.find_last_import_line(
                 cell_source
@@ -94,7 +137,7 @@ class FastAPINotebookBuilder:
 
             self.replace_cell_source(cell_index, updated_cell_source)
 
-    def compute_max_points_free_response(self):
+    def compute_max_points_free_response(self) -> None:
         for cell_dict in self.assertion_tests_dict.values():
             # gets the question name from the first cell to not double count
             if cell_dict["is_first"]:
@@ -107,7 +150,7 @@ class FastAPINotebookBuilder:
 
                 self.total_points += max_question_points
 
-    def construct_first_cell_question_header(self, cell_dict):
+    def construct_first_cell_question_header(self, cell_dict: dict) -> list[str]:
         max_question_points = sum(
             cell["points"]
             for cell in self.assertion_tests_dict.values()
@@ -136,7 +179,7 @@ class FastAPINotebookBuilder:
         return first_cell_header
 
     @staticmethod
-    def construct_update_responses(cell_dict):
+    def construct_update_responses(cell_dict: dict) -> list[str]:
         update_responses = []
 
         logging_variables = cell_dict["logging_variables"]
@@ -149,7 +192,9 @@ class FastAPINotebookBuilder:
         return update_responses
 
     @staticmethod
-    def split_list_at_marker(input_list, marker="""# END TEST CONFIG"""):
+    def split_list_at_marker(
+        input_list: list[str], marker: str = """# END TEST CONFIG"""
+    ) -> tuple[list[str], list[str]]:
         """
         Splits a list into two parts at the specified marker string.
 
@@ -172,7 +217,7 @@ class FastAPINotebookBuilder:
             )  # If the marker is not in the list, return the original list and an empty list
 
     @staticmethod
-    def construct_graders(cell_dict):
+    def construct_graders(cell_dict: dict) -> list[str]:
         # Generate Python code
         added_code = [
             "if "
@@ -184,7 +229,7 @@ class FastAPINotebookBuilder:
         return added_code
 
     @staticmethod
-    def construct_question_info(cell_dict):
+    def construct_question_info(cell_dict: dict) -> list[str]:
         question_info = []
 
         question_id = cell_dict["question"] + "-" + str(cell_dict["test_number"])
@@ -197,8 +242,12 @@ class FastAPINotebookBuilder:
 
     @staticmethod
     def insert_list_at_index(
-        original_list, insert_list, index, line_break=True, inplace_line_break=True
-    ):
+        original_list: list[str],
+        insert_list: list[str],
+        index: int,
+        line_break: bool = True,
+        inplace_line_break: bool = True,
+    ) -> list[str]:
         """
         Inserts a list into another list at a specific index.
 
@@ -223,7 +272,7 @@ class FastAPINotebookBuilder:
         return original_list[:index] + insert_list + original_list[index:]
 
     @staticmethod
-    def add_import_statements_to_tests(cell_source):
+    def add_import_statements_to_tests(cell_source: list[str]) -> list[str]:
         """
         Adds the necessary import statements to the first cell of the notebook.
         """
@@ -241,6 +290,7 @@ class FastAPINotebookBuilder:
             "    update_responses,\n",
             ")\n",
             "import os\n",
+            "import base64\n",
         ]
 
         for i, line in enumerate(cell_source):
@@ -251,7 +301,12 @@ class FastAPINotebookBuilder:
                 ] + imports  # Add a blank line for readability
                 return cell_source  # Exit the loop once the imports are inserted
 
-    def extract_first_cell(self):
+        raise ValueError("End of test configuration not found")
+
+    # TODO: `Any` return not good; would be better to specify return type(s)
+    def extract_first_cell(self) -> Any:
+        if not self.temp_notebook:
+            raise ValueError("No temporary notebook file path provided")
         with open(self.temp_notebook, "r", encoding="utf-8") as f:
             notebook = json.load(f)
         if "cells" in notebook and len(notebook["cells"]) > 0:
@@ -260,13 +315,16 @@ class FastAPINotebookBuilder:
             return None
 
     @staticmethod
-    def get_filename_and_root(path):
+    def get_filename_and_root(path: str) -> tuple[Path, str]:
         path_obj = Path(path).resolve()  # Resolve the path to get an absolute path
         root_path = path_obj.parent  # Get the parent directory
         filename = path_obj.name  # Get the filename
         return root_path, filename
 
-    def get_cell(self, cell_index):
+    # TODO: `Any` return not good; would be better to specify return type(s)
+    def get_cell(self, cell_index: int) -> Any:
+        if not self.temp_notebook:
+            raise ValueError("No temporary notebook file path provided")
         with open(self.temp_notebook, "r", encoding="utf-8") as f:
             notebook = json.load(f)
         if "cells" in notebook and len(notebook["cells"]) > cell_index:
@@ -274,7 +332,7 @@ class FastAPINotebookBuilder:
         else:
             return None
 
-    def replace_cell_source(self, cell_index, new_source):
+    def replace_cell_source(self, cell_index: int, new_source: str | list[str]) -> None:
         """
         Replace the source code of a specific Jupyter notebook cell.
 
@@ -283,6 +341,8 @@ class FastAPINotebookBuilder:
             new_source (str): New source code to replace the cell's content.
         """
         # Load the notebook
+        if not self.temp_notebook:
+            raise ValueError("No temporary notebook file path provided")
         with open(self.temp_notebook, "r", encoding="utf-8") as f:
             notebook = nbformat.read(f, as_version=4)
 
@@ -301,7 +361,7 @@ class FastAPINotebookBuilder:
         print(f"Updated notebook saved to {self.temp_notebook}")
 
     @staticmethod
-    def find_last_import_line(cell_source):
+    def find_last_import_line(cell_source: list[str]) -> int:
         """
         Finds the index of the last line with an import statement in a list of code lines,
         including multiline import statements.
@@ -339,7 +399,7 @@ class FastAPINotebookBuilder:
         return last_import_index
 
     @staticmethod
-    def extract_log_variables(cell):
+    def extract_log_variables(cell: dict) -> list[str]:
         """Extracts log variables from the first cell."""
         if "source" in cell:
             for line in cell["source"]:
@@ -355,7 +415,8 @@ class FastAPINotebookBuilder:
                         pass
         return []
 
-    def tag_questions(cells_dict):
+    @staticmethod
+    def tag_questions(cells_dict: dict) -> dict:
         """
         Adds 'is_first' and 'is_last' boolean flags to the cells based on their position
         within the group of the same question. All cells will have both flags.
@@ -377,7 +438,7 @@ class FastAPINotebookBuilder:
                 raise KeyError(f"Cell {key} is missing the 'question' key.")
 
         # Group the keys by question name
-        question_groups = {}
+        question_groups: dict = {}
         for key, cell in cells_dict.items():
             question = cell.get(
                 "question"
@@ -397,7 +458,9 @@ class FastAPINotebookBuilder:
 
         return cells_dict
 
-    def question_dict(self):
+    def question_dict(self) -> dict:
+        if not self.temp_notebook:
+            raise ValueError("No temporary notebook file path provided")
         notebook_path = Path(self.temp_notebook)
         if not notebook_path.exists():
             raise FileNotFoundError(f"The file {notebook_path} does not exist.")
@@ -406,15 +469,14 @@ class FastAPINotebookBuilder:
             notebook = json.load(f)
 
         results_dict = {}
+        question_name = None  # At least define the variable up front
 
         for cell_index, cell in enumerate(notebook.get("cells", [])):
             if cell.get("cell_type") == "raw":
                 source = "".join(cell.get("source", ""))
                 if source.strip().startswith("# BEGIN QUESTION"):
-                    question_name = re.search(r"name:\s*(.*)", source)
-                    question_name = (
-                        question_name.group(1).strip() if question_name else None
-                    )
+                    name_match = re.search(r"name:\s*(.*)", source)
+                    question_name = name_match.group(1).strip() if name_match else None
 
             elif cell.get("cell_type") == "code":
                 source = "".join(cell.get("source", ""))

pykubegrader/widgets_base/multi_select.py

@@ -2,6 +2,7 @@ import time
 from typing import Callable, Optional, Tuple
 
 import panel as pn
+import numpy as np
 
 from ..telemetry import ensure_responses, score_question, update_responses
 from ..utils import shuffle_options, shuffle_questions
@@ -70,7 +71,7 @@ class MultiSelectQuestion:
 
         # Panel layout
         question_header = pn.pane.HTML(
-            f"<h2>Question {self.question_number}: {title}</h2>"
+            f"<h2>Question {self.question_number} (Points {np.sum(points)}): {title}</h2>"
         )
 
         question_body = pn.Column(

pykubegrader/widgets_base/select.py

@@ -2,6 +2,7 @@ import time
 from typing import Callable, Optional, Tuple
 
 import panel as pn
+import numpy as np
 
 from ..telemetry import ensure_responses, score_question, update_responses
 from ..utils import shuffle_options, shuffle_questions
@@ -57,7 +58,7 @@ class SelectQuestion:
         widget_pairs = shuffle_questions(desc_widgets, self.widgets, seed)
 
         self.layout = pn.Column(
-            f"# Question {self.question_number}: {title}",
+            f"# Question {self.question_number} (Points {np.sum(points)}): {title}",
             *(
                 pn.Column(desc_widget, pn.Row(dropdown))
                 for desc_widget, dropdown in widget_pairs