Merge pull request #381 from datacamp/jh/run-python-files

Run code from Python files

Author: hermansje

README.md

@@ -34,7 +34,7 @@ _, ctxt = prep_context()
 globals().update(ctxt)
 
 # initialize state with student and solution submission
-from pythonwhat.local import setup_state
+from pythonwhat.test_exercise import setup_state
 setup_state(stu_code = "x = 5", sol_code = "x = 4")
 
 Ex().check_object('x')
@@ -64,4 +64,4 @@ Bugs? Questions? Suggestions? [Create an issue](https://github.com/datacamp/pyth
 
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fpythonwhat.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fpythonwhat?ref=badge_large)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fpythonwhat.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fpythonwhat?ref=badge_large)

docs/reference.rst

@@ -75,14 +75,21 @@ Loops
 .. autofunction:: pythonwhat.checks.check_wrappers.check_dict_comp
 .. autofunction:: pythonwhat.checks.check_wrappers.check_generator_exp
 
-State Management
+State management
 ----------------
 
 .. autofunction:: pythonwhat.checks.check_logic.override
 .. autofunction:: pythonwhat.checks.check_logic.disable_highlighting
 .. autofunction:: pythonwhat.checks.check_logic.set_context
 .. autofunction:: pythonwhat.checks.check_logic.set_env
 
+Checking files
+--------------
+
+.. autofunction:: pythonwhat.checks.check_wrappers.check_file
+.. autofunction:: pythonwhat.checks.check_wrappers.has_dir
+.. autofunction:: pythonwhat.local.run
+
 Electives
 ---------
 

pythonwhat/State.py

@@ -169,13 +169,24 @@ def has_different_processes(self):
             # play it safe (most common)
             return True
 
+    # todo: remove (deprecated)
     def assert_root(self, fun, extra_msg=""):
         if self.parent_state is not None:
             raise InstructorError(
                 "`%s()` should only be called from the root state, `Ex()`. %s"
                 % (fun, extra_msg)
             )
 
+    def assert_execution_root(self, fun, extra_msg=""):
+        if self.parent_state is not None and not self.assert_creator_type("run"):
+            raise InstructorError(
+                "`%s()` should only be called focusing on a full script, following `Ex()` or `run()`. %s"
+                % (fun, extra_msg)
+            )
+
+    def assert_creator_type(self, type):
+        return self.creator and self.creator.get("type") == type
+
     def assert_is(self, klasses, fun, prev_fun):
         if self.__class__.__name__ not in klasses:
             raise InstructorError(

pythonwhat/checks/check_object.py

@@ -158,7 +158,7 @@ def __init__(self, n):
     # Only do the assertion if PYTHONWHAT_V2_ONLY is set to '1'
     if v2_only():
         extra_msg = "If you want to check the value of an object in e.g. a for loop, use `has_equal_value(name = 'my_obj')` instead."
-        state.assert_root("check_object", extra_msg=extra_msg)
+        state.assert_execution_root("check_object", extra_msg=extra_msg)
 
     if missing_msg is None:
         missing_msg = "Did you define the {{typestr}} `{{index}}` without errors?"

pythonwhat/checks/check_wrappers.py

@@ -5,6 +5,7 @@
 from pythonwhat.checks import check_object, check_logic, check_funcs, has_funcs
 from pythonwhat.checks.check_function import check_function
 from pythonwhat.checks.check_has_context import has_context
+from pythonwhat.local import run
 
 from inspect import signature, Parameter
 from functools import partial, wraps
@@ -770,6 +771,7 @@ def rename_function(func, name):
 
 scts["has_context"] = has_context
 scts["check_function"] = check_function
+scts["run"] = run
 scts["check_file"] = check_file
 scts["has_dir"] = has_dir
 scts["_debug"] = _debug

pythonwhat/checks/has_funcs.py

@@ -652,7 +652,7 @@ def has_printout(
     """
 
     extra_msg = "If you want to check printouts done in e.g. a for loop, you have to use a `check_function('print')` chain instead."
-    state.assert_root("has_printout", extra_msg=extra_msg)
+    state.assert_execution_root("has_printout", extra_msg=extra_msg)
 
     if not_printed_msg is None:
         not_printed_msg = (
@@ -747,7 +747,7 @@ def has_no_error(
         leave of the ``has_no_error()`` step.
 
     """
-    state.assert_root("has_no_error")
+    state.assert_execution_root("has_no_error")
 
     if state.reporter.errors:
         _msg = state.build_message(