feat: add multi line code formatting for has_equal_ast

Author: BogdanFloris

pythonwhat/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "2.24.1"
+__version__ = "2.24.2"
 
 from .test_exercise import test_exercise, allow_errors

pythonwhat/checks/has_funcs.py

@@ -167,7 +167,11 @@ def has_equal_ast(state, incorrect_msg=None, code=None, exact=True, append=None)
     ):  # if not specified, set to False if incorrect_msg was manually specified
         append = incorrect_msg is None
     if incorrect_msg is None:
-        incorrect_msg = "Expected `{{sol_str}}`, but got `{{stu_str}}`."
+        incorrect_msg = (
+            "Expected \n```\n{{sol_str}}\n```\n, but got \n```\n{{stu_str}}\n```\n"
+            if utils.is_multiline_code(state.student_code, state.solution_code)
+            else "Expected `{{sol_str}}`, but got `{{stu_str}}`."
+        )
 
     def parse_tree(tree):
         # get contents of module.body if only 1 element
@@ -183,10 +187,18 @@ def parse_tree(tree):
     stu_rep = parse_tree(state.student_ast)
     sol_rep = parse_tree(state.solution_ast if not code else ast.parse(code))
 
-    fmt_kwargs = {
-        "sol_str": state.solution_code if not code else code,
-        "stu_str": state.student_code,
-    }
+    if utils.is_multiline_code(state.student_code, state.solution_code):
+        fmt_kwargs = {
+            "sol_str": utils.format_code(state.solution_code)
+            if not code
+            else utils.format_code(code),
+            "stu_str": utils.format_code(state.student_code),
+        }
+    else:
+        fmt_kwargs = {
+            "sol_str": state.solution_code if not code else code,
+            "stu_str": state.student_code,
+        }
 
     if exact and not code:
         state.do_test(
@@ -345,19 +357,20 @@ def has_expr(
     # wrap in quotes if eval_sol or eval_stu are strings
     if test == "value":
         if isinstance(eval_stu, str):
-            fmt_kwargs["stu_eval"] = '\'{}\''.format(fmt_kwargs["stu_eval"])
+            fmt_kwargs["stu_eval"] = "'{}'".format(fmt_kwargs["stu_eval"])
         if isinstance(eval_sol, str):
-            fmt_kwargs["sol_eval"] = '\'{}\''.format(fmt_kwargs["sol_eval"])
+            fmt_kwargs["sol_eval"] = "'{}'".format(fmt_kwargs["sol_eval"])
 
     # reformat student evaluation string if it is too long
     fmt_kwargs["stu_eval"] = utils.shorten_string(fmt_kwargs["stu_eval"])
 
     # check if student or solution evaluations are too long or contain newlines
     if incorrect_msg == DEFAULT_INCORRECT_MSG and (
-        len(fmt_kwargs["sol_eval"]) > 50 or
-        utils.has_newline(fmt_kwargs["stu_eval"]) or
-        utils.has_newline(fmt_kwargs["sol_eval"]) or
-        fmt_kwargs["stu_eval"] == fmt_kwargs["sol_eval"]):
+        len(fmt_kwargs["sol_eval"]) > 50
+        or utils.has_newline(fmt_kwargs["stu_eval"])
+        or utils.has_newline(fmt_kwargs["sol_eval"])
+        or fmt_kwargs["stu_eval"] == fmt_kwargs["sol_eval"]
+    ):
         fmt_kwargs["stu_eval"] = None
         fmt_kwargs["sol_eval"] = None
         incorrect_msg = "Expected something different."

pythonwhat/utils.py

@@ -1,6 +1,19 @@
 from types import ModuleType
 import copy
 import os
+import black
+
+
+def format_code(text):
+    mode = black.FileMode()
+    try:
+        return black.format_file_contents(text, fast=True, mode=mode)
+    except black.NothingChanged:
+        return text
+
+
+def is_multiline_code(stu_code: str, sol_code: str) -> bool:
+    return has_newline(stu_code) or has_newline(sol_code)
 
 
 def include_v1():
@@ -10,11 +23,13 @@ def include_v1():
 def v2_only():
     return not include_v1()
 
+
 def shorten_string(text):
     if len(text) > 50:
         text = text[0:45] + "..."
     return text
 
+
 def has_newline(text):
     return "\n" in text
 

requirements.txt

@@ -1,9 +1,12 @@
 # pythonwhat deps
-protowhat~=2.1.0
+protowhat~=2.1.3
 asttokens~=2.0.5
 dill~=0.3.4
-markdown2~=2.3.10
+markdown2~=2.4.6
 jinja2~=2.11.3
+markupsafe==2.0.1
+black==19.10b0
+Pygments==2.13.0
 
 numpy~=1.19.5
 pandas~=1.3.2

tests/test_spec.py

@@ -137,6 +137,60 @@ def test_has_equal_ast_simple_pass(data):
     assert sct_payload["correct"]
 
 
+def test_has_equal_ast_formatting(data):
+    data["DC_CODE"] = """
+def car_wash(env):
+    car_wash_num = 0
+    while True:
+        car_wash_num += 2
+        
+        # Get the current simulation time and clock-in the process time
+        yield env.timeout(5)
+
+a = 2
+b = 3
+"""
+    data["DC_SOLUTION"] = """
+def car_wash(env):
+    car_wash_num = 0
+    while True:
+        car_wash_num += 1
+        
+        # Get the current simulation time and clock-in the process time
+        yield env.timeout(5)
+
+a = 2
+b = 3
+"""
+    data["DC_SCT"] = """
+Ex().check_function_def("car_wash").multi(
+    check_body().check_while().has_equal_ast()
+)
+"""
+    sct_payload = helper.run(data)
+    assert not sct_payload["correct"]
+    incorrect_msg = """Did you correctly specify the body? Check the first <code>while</code> loop. Expected 
+
+<pre><code>while True:
+    car_wash_num += 1
+
+    # Get the current simulation time and clock-in the process time
+    yield env.timeout(5)
+
+</code></pre>
+
+, but got 
+
+<pre><code>while True:
+    car_wash_num += 2
+
+    # Get the current simulation time and clock-in the process time
+    yield env.timeout(5)
+
+</code></pre>"""
+    assert sct_payload["message"] == incorrect_msg
+
+
 def test_has_equal_ast_simple_fail(data):
     data["DC_SCT"] = "Ex().has_equal_ast()"
     failing_submission(data)