dlai-grader 1.19.0__tar.gz → 1.21.0__tar.gz

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dlai-grader
-Version: 1.19.0
+Version: 1.21.0
 Summary: Grading utilities for DLAI courses
 Home-page: https://github.com/https-deeplearning-ai/grader
 Author: Andres Zarta
@@ -11,6 +11,8 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: nbformat>=5.1.3
+Requires-Dist: jupytext>=1.13.0
 
 # grader
 Automatic grading for DLAI courses. Designed to be compatible with Coursera's grading requirements.

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/dlai_grader/__init__.py

@@ -6,6 +6,6 @@ from . import grading
 from . import types
 
 
-__version__ = "1.19.0"
+__version__ = "1.21.0"
 __author__ = "Andres Zarta"
 __credits__ = "DeepLearning.AI"

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/dlai_grader/compiler.py

@@ -1,7 +1,7 @@
 import ast
-import sys
 from types import ModuleType
 from contextlib import nullcontext
+from nbformat.notebooknode import NotebookNode
 from .io import suppress_stdout_stderr
 
 
@@ -32,6 +32,38 @@ def compile_module(
     with nullcontext() if verbose else suppress_stdout_stderr():
         module = ModuleType(module_name)
         code = compile(code_ast, f"{module_name}.py", "exec")
-        sys.modules[module_name] = module
         exec(code, module.__dict__)
         return module
+
+
+def compile_partial_module(
+    notebook: NotebookNode,
+    module_name: str,
+    verbose: bool = True,
+) -> ModuleType:
+    """Iterates over the code cells of a notebook and includes the ones that run to the compiled module.
+    Args:
+        notebook (NotebookNode): Notebook from learner.
+        module_name (str): Name of the module.
+        verbose (bool): Whether to print out streams as a result of compilation. Defaults to True.
+    Returns:
+        ModuleType: The actual module that can be used to call functions/variables/etc.
+    """
+    code_cells = [cell.source for cell in notebook.cells if cell.cell_type == "code"]
+    module = ModuleType(module_name)
+
+    for i, cell_code in enumerate(code_cells):
+        try:
+            compiled_code = compile(cell_code, f"<cell {i}>", "exec")
+
+            with nullcontext() if verbose else suppress_stdout_stderr():
+                exec(compiled_code, module.__dict__)
+
+        except Exception as e:
+            if verbose:
+                print(
+                    f"Error during execution of cell. Aborting full compilation.\n\nContents:\n\n{cell_code}\n\nException:\n\n{e}\n"
+                )
+            break
+
+    return module

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/dlai_grader/templates.py

@@ -17,6 +17,8 @@ def load_templates() -> Dict[str, str]:
         print("invalid option selected")
         exit(1)
 
+    unit_test_filename = input("Filename for unit tests (leave empty for unittests): ")
+    unit_test_filename = "unittests" if not unit_test_filename else unit_test_filename
     version = input("Version of the grader (leave empty for version 1): ")
     version = "1" if not version else version
 
@@ -56,6 +58,7 @@ def load_templates() -> Dict[str, str]:
 
     conf = f"""
     ASSIGNMENT_NAME=C{course}{W_OR_M}{W_OR_M_num}_Assignment
+    UNIT_TESTS_NAME={unit_test_filename}
     IMAGE_NAME={specialization}c{course}{W_OR_M.lower()}{W_OR_M_num}-grader
     GRADER_VERSION={version}
     TAG_ID=V$(GRADER_VERSION)
@@ -64,66 +67,66 @@ def load_templates() -> Dict[str, str]:
     """
 
     makefile = """
-    .PHONY: learner build entry submit-solution upgrade test grade mem zip clean upload move-zip move-learner tag undeletable uneditable versioning upgrade sync
+	.PHONY: learner build entry submit-solution upgrade test grade mem zip clean upload move-zip move-learner tag undeletable uneditable versioning upgrade sync
 
-    include .conf
+	include .conf
 
-    PARTIDS = ""
-    OS := $(shell uname)
+	PARTIDS = ""
+	OS := $(shell uname)
 
-    sync:
-        cp mount/submission.ipynb ../$(ASSIGNMENT_NAME)_Solution.ipynb
-        cp learner/$(ASSIGNMENT_NAME).ipynb ../$(ASSIGNMENT_NAME).ipynb
-        cp mount/unittests.py ../unittests.py
+	sync:
+		cp mount/submission.ipynb ../$(ASSIGNMENT_NAME)_Solution.ipynb
+		cp learner/$(ASSIGNMENT_NAME).ipynb ../$(ASSIGNMENT_NAME).ipynb
+		cp mount/$(UNIT_TESTS_NAME).py ../$(UNIT_TESTS_NAME).py
 
-    learner:
-        dlai_grader --learner --output_notebook=./learner/$(ASSIGNMENT_NAME).ipynb
+	learner:
+		dlai_grader --learner --output_notebook=./learner/$(ASSIGNMENT_NAME).ipynb
 
-    build:
-        docker build -t $(IMAGE_NAME):$(TAG_ID) .
+	build:
+		docker build -t $(IMAGE_NAME):$(TAG_ID) .
 
-    debug:
-        docker run -it --rm --mount type=bind,source=$(PWD)/mount,target=/shared/submission --mount type=bind,source=$(PWD),target=/grader/ --entrypoint ash $(IMAGE_NAME):$(TAG_ID)
+	debug:
+		docker run -it --rm --mount type=bind,source=$(PWD)/mount,target=/shared/submission --mount type=bind,source=$(PWD),target=/grader/ --entrypoint ash $(IMAGE_NAME):$(TAG_ID)
 
-    submit-solution:
-        cp solution/solution.ipynb mount/submission.ipynb
+	submit-solution:
+		cp solution/solution.ipynb mount/submission.ipynb
 
-    versioning:
-        dlai_grader --versioning
+	versioning:
+		dlai_grader --versioning
 
-    tag:
-        dlai_grader --tag
+	tag:
+		dlai_grader --tag
 
-    undeletable:
-        dlai_grader --undeletable
+	undeletable:
+		dlai_grader --undeletable
 
-    uneditable:
-        dlai_grader --uneditable
+	uneditable:
+		dlai_grader --uneditable
 
-    upgrade:
-        dlai_grader --upgrade
+	upgrade:
+		dlai_grader --upgrade
 
-    test:
-        docker run -it --rm --mount type=bind,source=$(PWD)/mount,target=/shared/submission --mount type=bind,source=$(PWD),target=/grader/ --entrypoint pytest $(IMAGE_NAME):$(TAG_ID)
+	test:
+		docker run -it --rm --mount type=bind,source=$(PWD)/mount,target=/shared/submission --mount type=bind,source=$(PWD),target=/grader/ --entrypoint pytest $(IMAGE_NAME):$(TAG_ID)
 
-    grade:
-        dlai_grader --grade --partids=$(PARTIDS) --docker=$(IMAGE_NAME):$(TAG_ID) --memory=$(MEMORY_LIMIT) --submission=$(SUB_DIR)
+	grade:
+		dlai_grader --grade --partids=$(PARTIDS) --docker=$(IMAGE_NAME):$(TAG_ID) --memory=$(MEMORY_LIMIT) --submission=$(SUB_DIR)
 
-    mem:
-        memthis $(PARTIDS)
+	mem:
+		memthis $(PARTIDS)
 
-    zip:
-        zip -r $(IMAGE_NAME)$(TAG_ID).zip .
+	zip:
+		zip -r $(IMAGE_NAME)$(TAG_ID).zip .
 
-    clean:
-        find . -maxdepth 1 -type f -name "*.zip" -exec rm {} +
-        docker rm $$(docker ps -qa --no-trunc --filter "status=exited")
-        docker rmi $$(docker images --filter "dangling=true" -q --no-trunc)
+	clean:
+		find . -maxdepth 1 -type f -name "*.zip" -exec rm {} +
+		docker rm $$(docker ps -qa --no-trunc --filter "status=exited")
+		docker rmi $$(docker images --filter "dangling=true" -q --no-trunc)
 
-    upload:
-        coursera_autograder --timeout 1800 upload --grader-memory-limit $(MEMORY_LIMIT) --grading-timeout 1800 $(IMAGE_NAME)$(TAG_ID).zip $(COURSE_ID) $(ITEM_ID) $(PART_ID)
+	upload:
+		coursera_autograder --timeout 1800 upload --grader-memory-limit $(MEMORY_LIMIT) --grading-timeout 1800 $(IMAGE_NAME)$(TAG_ID).zip $(COURSE_ID) $(ITEM_ID) $(PART_ID)
 
-    """
+	"""
 
     grader_py = """
     from types import ModuleType, FunctionType
@@ -162,7 +165,7 @@ def load_templates() -> Dict[str, str]:
 
     entry_py = """
     from dlai_grader.config import Config
-    from dlai_grader.compiler import compile_module
+    from dlai_grader.compiler import compile_partial_module
     from dlai_grader.io import read_notebook, copy_submission_to_workdir, send_feedback
 
     from dlai_grader.notebook import (
@@ -201,14 +204,13 @@ def load_templates() -> Dict[str, str]:
         for t in transformations:
             nb = t(nb)
 
-        script = notebook_to_script(nb)
-
         try:
-            learner_mod = compile_module(script, "learner_mod", verbose=False)
+            learner_mod = compile_partial_module(nb, "learner_mod", verbose=False)
         except Exception as e:
             send_feedback(
                 0.0,
                 f"There was a problem compiling the code from your notebook, please check that you saved before submitting. Details:\\n{str(e)}",
+                err=True,
             )
 
         solution_nb = read_notebook(c.solution_file_path)
@@ -237,7 +239,7 @@ def load_templates() -> Dict[str, str]:
 
             send_feedback(
                 0.0,
-                f"Unable to find object required for grading in your code.\\n{additional_msg}",
+                f"Object required for grading not found. If you haven't completed the exercise this is expected. Otherwise, check your solution as grader omits cells that throw errors.\n{additional_msg}",
                 err=True,
             )
 

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/dlai_grader.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dlai-grader
-Version: 1.19.0
+Version: 1.21.0
 Summary: Grading utilities for DLAI courses
 Home-page: https://github.com/https-deeplearning-ai/grader
 Author: Andres Zarta
@@ -11,6 +11,8 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: nbformat>=5.1.3
+Requires-Dist: jupytext>=1.13.0
 
 # grader
 Automatic grading for DLAI courses. Designed to be compatible with Coursera's grading requirements.

{dlai-grader-1.19.0 → dlai_grader-1.21.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as f:
 
 setup(
     name="dlai-grader",
-    version="1.19.0",
+    version="1.21.0",
     description="Grading utilities for DLAI courses",
     url="https://github.com/https-deeplearning-ai/grader",
     author="Andres Zarta",