Merge pull request #387 from datacamp/fix/run-file

[CX-354] Fix running file

Author: hermansje

.readthedocs.yml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.5
+  install:
+    - requirements: requirements.txt
+    - method: pip
+      path: .

docs/reference.rst

@@ -90,6 +90,12 @@ Checking files
 .. autofunction:: pythonwhat.checks.check_wrappers.has_dir
 .. autofunction:: pythonwhat.local.run
 
+Bash history checks
+-------------------
+
+.. automodule:: protowhat.checks.check_bash_history
+    :members:
+
 Electives
 ---------
 

pythonwhat/State.py

@@ -181,22 +181,14 @@ 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"):
+        if not (self.is_root or self.is_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):
+    def is_creator_type(self, type):
         return self.creator and self.creator.get("type") == type
 
     def assert_is(self, klasses, fun, prev_fun):

pythonwhat/checks/check_wrappers.py

@@ -1,5 +1,6 @@
 from protowhat.utils import _debug
 from protowhat.checks.check_simple import allow_errors
+from protowhat.checks.check_bash_history import has_command
 from protowhat.checks.check_files import check_file, has_dir
 from pythonwhat.checks.check_funcs import check_part, check_part_index, check_node
 from pythonwhat.checks.has_funcs import has_equal_part
@@ -775,6 +776,8 @@ def rename_function(func, name):
 
 scts["run"] = run
 
+scts["has_command"] = has_command
+
 scts["check_file"] = check_file
 scts["has_dir"] = has_dir
 

pythonwhat/local.py

@@ -205,7 +205,7 @@ def run_exercise(pec, sol_code, stu_code, sol_wd=None, stu_wd=None, **kwargs):
 #  e.g. `python -m project.run
 #  allow setting env vars? e.g. PYTHONPATH, could help running more complex setup
 #  allow prepending code? set_env? e.g. (automatically) setting __file__?
-def run(state, relative_working_dir=None, solution_dir="solution"):
+def run(state, relative_working_dir=None, solution_dir="../solution"):
     """Run the focused student and solution code in the specified location
 
     This function can be used after ``check_file`` to execute student and solution code.

requirements.txt

@@ -1,5 +1,5 @@
 # pythonwhat deps
-protowhat~=1.10.0
+protowhat~=1.11.0
 asttokens~=1.1.10
 dill~=0.2.7.1
 markdown2~=2.3.7

tests/test_local.py

@@ -126,28 +126,29 @@ def test_run_solution_dir():
 
     file_dir = "a/b"
     file_path = "a/b/c"
-    solution_location = "solution"
+    workspace_location = "workspace"
 
     with in_temp_dir():
-        write_file(file_dir, "c", code)
+        write_file("solution/" + file_dir, "c", code)
 
-        os.makedirs(solution_location)
-        with ChDir(solution_location):
+        os.makedirs(workspace_location)
+        with ChDir(workspace_location):
             write_file(file_dir, "c", code)
 
-        chain = setup_state("", "", pec="")
+            chain = setup_state("", "", pec="")
 
-        child = chain.check_file(file_path, solution_code=code)
+            child = chain.check_file(file_path, solution_code=code)
 
-        child.run(file_dir).check_object("c")
-        child.run().check_object("c")
+            child.run(file_dir).check_object("c")
+            child.run().check_object("c")
 
 
 def test_run_with_absolute_dir():
     code = 'from pathlib import Path; c = Path("c").read_text(encoding="utf-8")'
 
     file_dir = "a/b"
     solution_location = "solution"
+    workspace_location = "workspace"
 
     with in_temp_dir():
         os.makedirs(file_dir)
@@ -159,12 +160,14 @@ def test_run_with_absolute_dir():
 
         write_file(solution_location, "c", code)
 
-        chain = setup_state("", "", pec="")
+        os.makedirs(workspace_location)
+        with ChDir(workspace_location):
+            chain = setup_state("", "", pec="")
 
-        child = chain.check_file(abs_file_path, solution_code=code)
+            child = chain.check_file(abs_file_path, solution_code=code)
 
-        child.run(abs_dir).check_object("c")
-        child.run().check_object("c")
+            child.run(abs_dir).check_object("c")
+            child.run().check_object("c")
 
 
 def test_run_custom_solution_dir():