Clean up reporting feedback

Author: hermansje

pythonwhat/Feedback.py

@@ -2,32 +2,16 @@
 
 
 class Feedback(ProtoFeedback):
-    def __init__(self, message, state=None):
-        self.message = message
-        self.highlight = None
-        self.highlighting_disabled = False
-        if state is not None:
-            self.highlight = state.highlight
-            self.highlighting_disabled = state.highlighting_disabled
-
-    def get_line_info(self):
-        try:
-            if (
-                self.highlight is not None
-                and hasattr(self.highlight, "first_token")
-                and hasattr(self.highlight, "last_token")
-                and not self.highlighting_disabled
-            ):
-                return {
-                    "line_start": self.highlight.first_token.start[0],
-                    "column_start": self.highlight.first_token.start[1],
-                    "line_end": self.highlight.last_token.end[0],
-                    "column_end": self.highlight.last_token.end[1],
-                }
-            else:
-                return {}
-        except:
-            return {}
+    def _line_info(self):
+        if hasattr(self.highlight, "first_token") and hasattr(
+            self.highlight, "last_token"
+        ):
+            return {
+                "line_start": self.highlight.first_token.start[0],
+                "column_start": self.highlight.first_token.start[1],
+                "line_end": self.highlight.last_token.end[0],
+                "column_end": self.highlight.last_token.end[1],
+            }
 
     def get_formatted_line_info(self):
         formatted_info = self.get_line_info()

pythonwhat/State.py

@@ -1,5 +1,3 @@
-import inspect
-from copy import copy
 from functools import partialmethod
 from pythonwhat.parsing import (
     TargetVars,
@@ -10,7 +8,6 @@
 from protowhat.State import State as ProtoState
 from protowhat.Feedback import InstructorError
 from pythonwhat.Feedback import Feedback
-from protowhat.Test import Fail
 from pythonwhat import signatures
 from pythonwhat.converters import get_manual_converters
 from collections.abc import Mapping
@@ -120,7 +117,11 @@ def to_child(self, append_message="", node_name="", **kwargs):
         student tree and solution tree. This is necessary when testing if statements or
         for loops for example.
         """
-        base_kwargs = {attr: getattr(self, attr) for attr in self.params if attr not in ['highlight']}
+        base_kwargs = {
+            attr: getattr(self, attr)
+            for attr in self.params
+            if attr not in ["highlight"]
+        }
 
         if not isinstance(append_message, dict):
             append_message = {"msg": append_message, "kwargs": {}}
@@ -202,33 +203,27 @@ def parse_external(self, code):
         except IndentationError as e:
             e.filename = "script.py"
             # no line info for now
-            self.do_test(
-                Fail(
-                    Feedback(
-                        "Your code could not be parsed due to an error in the indentation:<br>`%s.`"
-                        % str(e)
-                    )
+            self.report(
+                Feedback(
+                    "Your code could not be parsed due to an error in the indentation:<br>`%s.`"
+                    % str(e)
                 )
             )
 
         except SyntaxError as e:
             e.filename = "script.py"
             # no line info for now
-            self.do_test(
-                Fail(
-                    Feedback(
-                        "Your code can not be executed due to a syntax error:<br>`%s.`"
-                        % str(e)
-                    )
+            self.report(
+                Feedback(
+                    "Your code can not be executed due to a syntax error:<br>`%s.`"
+                    % str(e)
                 )
             )
 
         # Can happen, can't catch this earlier because we can't differentiate between
         # TypeError in parsing or TypeError within code (at runtime).
         except:
-            self.do_test(
-                Fail(Feedback("Something went wrong while parsing your code."))
-            )
+            self.report(Feedback("Something went wrong while parsing your code."))
 
         return res
 
@@ -244,10 +239,10 @@ def parse_internal(code):
     def parse(self, text, test=True):
         if test:
             parse_method = self.parse_external
-            token_attr = 'student_ast_tokens'
+            token_attr = "student_ast_tokens"
         else:
             parse_method = self.parse_internal
-            token_attr = 'solution_ast_tokens'
+            token_attr = "solution_ast_tokens"
 
         tokens, ast = parse_method(text)
         setattr(self, token_attr, tokens)

pythonwhat/Test.py

@@ -2,7 +2,7 @@
 import numpy as np
 import pandas as pd
 from pythonwhat.tasks import *
-from protowhat.Test import TestFail, Test
+from protowhat.Test import Test
 
 """
 This file contains all tests that can be done on specific objects. All tests are represented as

pythonwhat/checks/check_funcs.py

@@ -139,7 +139,7 @@ def check_node(
         stu_out[index]
     except (KeyError, IndexError):  # TODO comment errors
         _msg = state.build_message(missing_msg, fmt_kwargs)
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     # get node at index
     stu_part = stu_out[index]
@@ -167,23 +167,19 @@ def with_context(state, *args, child=None):
         process=state.student_process, context=state.student_parts["with_items"]
     )
     if isinstance(student_res, AttributeError):
-        state.do_test(
-            Test(
-                Feedback(
-                    "In your `with` statement, you're not using a correct context manager.",
-                    child.highlight,  # TODO
-                )
+        state.report(
+            Feedback(
+                "In your `with` statement, you're not using a correct context manager.",
+                child.highlight,  # TODO
             )
         )
 
     if isinstance(student_res, (AssertionError, ValueError, TypeError)):
-        state.do_test(
-            Test(
-                Feedback(
-                    "In your `with` statement, the number of values in your context manager "
-                    "doesn't correspond to the number of variables you're trying to assign it to.",
-                    child.highlight,
-                )
+        state.report(
+            Feedback(
+                "In your `with` statement, the number of values in your context manager "
+                "doesn't correspond to the number of variables you're trying to assign it to.",
+                child.highlight,
             )
         )
 
@@ -203,13 +199,11 @@ def with_context(state, *args, child=None):
 
         close_student_context = breakDownNewEnvInProcess(process=state.student_process)
         if isinstance(close_student_context, Exception):
-            state.do_test(
-                Test(
-                    Feedback(
-                        "Your `with` statement can not be closed off correctly, you're "
-                        + "not using the context manager correctly.",
-                        state,
-                    )
+            state.report(
+                Feedback(
+                    "Your `with` statement can not be closed off correctly, you're "
+                    + "not using the context manager correctly.",
+                    state,
                 )
             )
     return state

pythonwhat/checks/check_function.py

@@ -131,7 +131,7 @@ def check_function(
         stu_parts = {**stu_out[name][index]}
     except (KeyError, IndexError):
         _msg = state.build_message(missing_msg, fmt_kwargs, append=append_missing)
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     # Signatures -----
     if signature:
@@ -163,11 +163,9 @@ def check_function(
             _msg = state.build_message(
                 params_not_matched_msg, fmt_kwargs, append=append_params_not_matched
             )
-            state.do_test(
-                Test(
-                    Feedback(
-                        _msg, StubState(stu_parts["node"], state.highlighting_disabled)
-                    )
+            state.report(
+                Feedback(
+                    _msg, StubState(stu_parts["node"], state.highlighting_disabled)
                 )
             )
 

pythonwhat/checks/check_logic.py

@@ -1,7 +1,5 @@
 from protowhat.checks.check_logic import multi, check_not, check_or, check_correct, disable_highlighting, fail
-from protowhat.Test import Fail
 from protowhat.Feedback import InstructorError
-from pythonwhat.Feedback import Feedback
 import ast
 
 

pythonwhat/checks/has_funcs.py

@@ -53,7 +53,7 @@ def verify(part, index):
     try:
         verify(state.student_parts[name], index)
     except (KeyError, IndexError):
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     return state
 
@@ -101,7 +101,7 @@ def shout(word):
 
     if d["stu_len"] != d["sol_len"]:
         _msg = state.build_message(unequal_msg, d)
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     return state
 
@@ -195,7 +195,7 @@ def parse_tree(tree):
     if exact and not code:
         state.do_test(EqualTest(stu_rep, sol_rep, Feedback(_msg, state)))
     elif not sol_rep in stu_rep:
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     return state
 
@@ -348,12 +348,12 @@ def has_expr(
         fmt_kwargs["stu_str"] = str_stu
         _msg = state.build_message(error_msg, fmt_kwargs, append=append)
         feedback = Feedback(_msg, state)
-        state.do_test(Test(feedback))
+        state.report(feedback)
 
     # name is undefined after running expression
     if isinstance(eval_stu, UndefinedValue):
         _msg = state.build_message(undefined_msg, fmt_kwargs, append=append)
-        state.do_test(Test(Feedback(_msg, state)))
+        state.report(Feedback(_msg, state))
 
     # test equality of results
     _msg = state.build_message(incorrect_msg, fmt_kwargs, append=append)
@@ -449,7 +449,9 @@ def has_code(state, text, pattern=True, not_typed_msg=None):
     student_code = state.student_code
 
     _msg = state.build_message(not_typed_msg)
-    state.do_test(StringContainsTest(student_code, text, pattern, Feedback(_msg, state)))
+    state.do_test(
+        StringContainsTest(student_code, text, pattern, Feedback(_msg, state))
+    )
 
     return state
 
@@ -660,7 +662,9 @@ def has_printout(
         )
 
     try:
-        sol_call_ast = state.ast_dispatcher("function_calls", state.solution_ast)["print"][index]["node"]
+        sol_call_ast = state.ast_dispatcher("function_calls", state.solution_ast)[
+            "print"
+        ][index]["node"]
     except (KeyError, IndexError):
         raise InstructorError(
             "`has_printout({})` couldn't find the {} print call in your solution.".format(
@@ -748,8 +752,10 @@ def has_no_error(
     state.assert_root("has_no_error")
 
     if state.reporter.errors:
-        _msg = state.build_message(incorrect_msg, {"error": str(state.reporter.errors[0])})
-        state.do_test(Test(Feedback(_msg, state)))
+        _msg = state.build_message(
+            incorrect_msg, {"error": str(state.reporter.errors[0])}
+        )
+        state.report(Feedback(_msg, state))
 
     return state
 

pythonwhat/test_funcs/utils.py

@@ -134,7 +134,7 @@ def call(
     stu_state = StubState(stu_node, state.highlighting_disabled)
     if (test == "error") ^ isinstance(eval_stu, Exception):
         _msg = state.build_message(error_msg, fmt_kwargs)
-        state.do_test(Test(Feedback(_msg, stu_state)))
+        state.report(Feedback(_msg, stu_state))
 
     # incorrect result
     _msg = state.build_message(incorrect_msg, fmt_kwargs)