set test_function highlighting to false by default

Author: machow

pythonwhat/test_funcs/test_function.py

@@ -19,6 +19,7 @@ def test_function(name,
                   args_not_specified_msg=None,
                   incorrect_msg=None,
                   add_more=False,
+                  highlight=False,
                   state=None):
     """Test if function calls match.
 
@@ -66,6 +67,8 @@ def test_function(name,
     rep = Reporter.active_reporter
     rep.set_tag("fun", "test_function")
 
+    if not highlight: state.highlight = None
+
     index = index - 1
 
     eq_map = {"equal": EqualTest}
@@ -128,7 +131,7 @@ def test_function(name,
                 if feedback is None:
                     if not args_not_specified_msg:
                         args_not_specified_msg = dflt
-                    feedback = Feedback(args_not_specified_msg, student_call)
+                    feedback = Feedback(args_not_specified_msg, student_call if highlight else None)
                 success = False
                 continue
 
@@ -148,7 +151,8 @@ def test_function(name,
 
                 test = build_test(arg_student, arg_solution,
                                   state,
-                                  do_eval, eq_fun, msg, add_more=add_more)
+                                  do_eval, eq_fun, msg, add_more=add_more,
+                                  highlight=arg_student if highlight else None)
                 test.test()
 
                 if not test.result:
@@ -170,7 +174,8 @@ def test_function(name,
 
                     test = build_test(key_student, key_solution,
                                       state,
-                                      do_eval, eq_fun, msg, add_more=add_more)
+                                      do_eval, eq_fun, msg, add_more=add_more,
+                                      highlight=key_student if highlight else None)
                     test.test()
 
                     if not test.result:
@@ -197,6 +202,7 @@ def test_print(index = 1,
                params_not_matched_msg="Have you correctly called `print()`?",
                params_not_specified_msg="Have you correctly called `print()`?",
                incorrect_msg="Have you printed out the correct object?",
+               highlight=True,
                state=None):
     test_function_v2("print",
                      index=index,
@@ -207,7 +213,8 @@ def test_print(index = 1,
                      not_called_msg=not_called_msg,
                      params_not_matched_msg=params_not_matched_msg,
                      params_not_specified_msg=params_not_specified_msg,
-                     incorrect_msg=incorrect_msg, state=state)
+                     incorrect_msg=incorrect_msg,
+                     highlight=highlight, state=state)
     """Test print() calls
 
     Utility function to test the print() function. For arguments, check test_function_v2()
@@ -224,6 +231,7 @@ def test_function_v2(name,
                      params_not_specified_msg=None,
                      incorrect_msg=None,
                      add_more=False,
+                     highlight=False,
                      state=None):
     """Test if function calls match (v2).
 
@@ -255,6 +263,11 @@ def test_function_v2(name,
     rep = Reporter.active_reporter
     rep.set_tag("fun", "test_function")
 
+    # Note that this mutates state, which is bad. The easiest way to avoid this
+    # would be to make a copy of state, but that would break blacklisting here,
+    # which also requires state mutation.
+    if not highlight: state.highlight = None
+
     index = index - 1
     eq_map = {"equal": EqualTest}
 
@@ -342,7 +355,7 @@ def test_function_v2(name,
         sub_tests = [partial(test_call, name, call_ind, signature, params, do_eval, solution_args, 
                              eq_fun, add_more, index,
                              params_not_specified_msg, params_not_matched_msg, incorrect_msg, 
-                             keywords, state=state)
+                             keywords, state=state, highlight = highlight)
                      for call_ind in call_indices]
         test_or(*sub_tests, state=state)
 
@@ -356,7 +369,7 @@ def test_call(name, call_ind, signature, params, do_eval, solution_args,
               eq_fun, add_more, index,
               params_not_specified_msg, params_not_matched_msg, incorrect_msg, 
               keywords,  # pulled from solution process
-              state):
+              state, highlight):
     #stud_name = get_mapped_name(name, state.student_mappings)
 
     rep = Reporter.active_reporter
@@ -374,7 +387,7 @@ def test_call(name, call_ind, signature, params, do_eval, solution_args,
             params_not_matched_msg = ("Something went wrong in figuring out how you specified the " + \
                 "arguments for `%s()`; have another look at your code and its output.") % stud_name
         _msg = state.build_message(params_not_matched_msg)
-        feedback = Feedback(_msg, student_call)
+        feedback = Feedback(_msg, student_call if highlight else None)
         # run subtest
         rep.do_test(Test(feedback))    # TODO: sub_call
 
@@ -392,7 +405,7 @@ def test_call(name, call_ind, signature, params, do_eval, solution_args,
         else:
             msg = params_not_specified_msg[param_ind]
         _msg = state.build_message(msg)
-        feedback = Feedback(_msg, student_call)
+        feedback = Feedback(_msg, student_call if highlight else None)
         # run subtest
         rep.do_test(Test(feedback))    # TODO: sub_call
 
@@ -405,15 +418,15 @@ def test_call(name, call_ind, signature, params, do_eval, solution_args,
         test_arg(param, do_eval[ind],
                  arg_student, arg_solution, param_kind, stud_name,
                  eq_fun, add_more,
-                 incorrect_msg[ind], state=state)
+                 incorrect_msg[ind], state=state, highlight = arg_student if highlight else None)
 
     # If all is still good, we have a winner!
     state.set_used(name, call_ind, index)
 
 def test_arg(param, do_eval, 
              arg_student, arg_solution, param_kind, stud_name,
              eq_fun, add_more,
-             incorrect_msg, state=None):
+             incorrect_msg, state=None, highlight = None):
     rep = Reporter.active_reporter
 
     if incorrect_msg is None:
@@ -426,7 +439,7 @@ def test_arg(param, do_eval,
 
     test = build_test(arg_student, arg_solution,
                         state,
-                        do_eval, eq_fun, msg, add_more = add_more)
+                        do_eval, eq_fun, msg, add_more = add_more, highlight=highlight)
     # TODO
     rep.do_test(test)
 
@@ -443,7 +456,7 @@ def bind_args(signature, arguments, keyws):
     bound_args = signature.bind(*arguments, **keyws)
     return(bound_args.arguments, signature.parameters)
 
-def build_test(stud, sol, state, do_eval, eq_fun, feedback_msg, add_more):
+def build_test(stud, sol, state, do_eval, eq_fun, feedback_msg, add_more, highlight = False):
     got_error = False
     if do_eval:
 
@@ -472,8 +485,8 @@ def build_test(stud, sol, state, do_eval, eq_fun, feedback_msg, add_more):
         eval_solution = ast.dump(sol)
 
     _msg = state.build_message(feedback_msg)
-    return(Test(Feedback(_msg, stud)) if got_error else
-        eq_fun(eval_student, eval_solution, Feedback(_msg, stud)))
+    return(Test(Feedback(_msg, stud if highlight else None)) if got_error else
+        eq_fun(eval_student, eval_solution, Feedback(_msg, stud if highlight else None)))
 
 
 

tests/test_test_function.py

@@ -626,6 +626,18 @@ def test_multiple_4(self):
         self.assertIn("Did you call <code>print()</code> with the correct arguments? The first argument seems to be incorrect.", sct_payload['message'])
         helper.test_lines(self, sct_payload, 1, 1, 7, 11)
 
+    def test_multiple_4_no_highlight(self):
+        self.data["DC_CODE"] = 'print("acb")\nprint(1234)\nprint([1, 2, 3])'
+        self.data["DC_SCT"] = """
+test_function("print", index = 1, highlight = False)
+test_function("print", index = 2)
+test_function("print", index = 3)
+        """
+        sct_payload = helper.run(self.data)
+        self.assertFalse(sct_payload['correct'])
+        self.assertIn("Did you call <code>print()</code> with the correct arguments? The first argument seems to be incorrect.", sct_payload['message'])
+        self.assertEqual(sct_payload.get('line_start'), None)
+
     def test_multiple_5(self):
         self.data["DC_CODE"] = 'print("abc")\nprint(1234)\nprint([1, 2, 3])'
         sct_payload = helper.run(self.data)
@@ -640,6 +652,13 @@ def test_multiple_6(self):
         self.assertIn("Did you call <code>print()</code> with the correct arguments? The first argument seems to be incorrect.", sct_payload['message'])
         helper.test_lines(self, sct_payload, 3, 3, 7, 18)
 
+    def test_nohighlight_too_few_calls(self):
+        self.data["DC_SCT"] = 'test_function("print", index = 3, args = [], keywords = [])\n' + self.data["DC_SCT"]
+        self.data["DC_CODE"] = 'print("abc")\nprint(1234)'
+        sct_payload = helper.run(self.data)
+        self.assertFalse(sct_payload['correct'])
+        self.assertEqual(sct_payload.get('line_start'), None)
+
 
 
 if __name__ == "__main__":

tests/test_test_function_v2.py

@@ -585,6 +585,19 @@ def test_multiple_4(self):
         self.assertIn("Did you call <code>print()</code> with the correct arguments?", sct_payload['message'])
         helper.test_lines(self, sct_payload, 1, 1, 7, 11)
 
+    def test_multiple_4_nohighlight(self):
+        self.data["DC_CODE"] = 'print("acb")\nprint(1234)\nprint([1, 2, 3])'
+
+        self.data["DC_SCT"] = '''
+test_function_v2("print", index = 1, params = ['value'], highlight = False)
+test_function_v2("print", index = 2, params = ['value'])
+test_function_v2("print", index = 3, params = ['value'])
+            '''
+        sct_payload = helper.run(self.data)
+        self.assertFalse(sct_payload['correct'])
+        self.assertIn("Did you call <code>print()</code> with the correct arguments?", sct_payload['message'])
+        self.assertEqual(sct_payload.get('line_start'), None)
+
     def test_multiple_5(self):
         self.data["DC_CODE"] = 'print("abc")\nprint(1234)\nprint([1, 2, 3])'
         sct_payload = helper.run(self.data)