Format code

Author: hermansje

docs/conf.py

@@ -49,7 +49,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinxcontrib.jinja", 'sphinxprettysearchresults']
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinxcontrib.jinja",
+    "sphinxprettysearchresults",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

pythonwhat/State.py

@@ -210,8 +210,7 @@ def parse_external(self, code):
             e.filename = "script.py"
             # no line info for now
             self.report(
-                "Your code can not be executed due to a syntax error:<br>`%s.`"
-                % str(e)
+                "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
@@ -258,12 +257,10 @@ def __init__(self, context_code=""):
         self._parser_cache = dict()
         context_ast = getattr(self._context_cache, context_code, None)
         if context_ast is None:
-            context_ast = self._context_cache[context_code] = self.parse(
-                context_code
-            )[1]
-        self.context_mappings = self._getx(
-            FunctionParser, "mappings", context_ast
-        )
+            context_ast = self._context_cache[context_code] = self.parse(context_code)[
+                1
+            ]
+        self.context_mappings = self._getx(FunctionParser, "mappings", context_ast)
 
     def find(self, name, node, *args, **kwargs):
         return getattr(self, name)(node)

pythonwhat/checks/check_logic.py

@@ -1,9 +1,18 @@
-from protowhat.checks.check_logic import multi, check_not, check_or, check_correct, disable_highlighting, fail
+from protowhat.checks.check_logic import (
+    multi,
+    check_not,
+    check_or,
+    check_correct,
+    disable_highlighting,
+    fail,
+)
 from protowhat.Feedback import InstructorError
 import ast
 
 
-multi.__doc__ = str(multi.__doc__) + """
+multi.__doc__ = (
+    str(multi.__doc__)
+    + """
     :Example:
 
         Suppose we want to verify the following function call: ::
@@ -18,9 +27,12 @@
                 check_args('ndigits').has_equal_value()
             )
     """
+)
 
 
-check_not.__doc__ = str(check_not.__doc__) + """
+check_not.__doc__ = (
+    str(check_not.__doc__)
+    + """
     :Example:
         The SCT fails with feedback for a specific incorrect value, defined using an override: ::
 
@@ -52,9 +64,12 @@
         - This function can be considered a direct counterpart of multi.
 
     """
+)
 
 
-check_or.__doc__ = str(check_or.__doc__) + """
+check_or.__doc__ = (
+    str(check_or.__doc__)
+    + """
     :Example:
 
         The SCT below tests that the student typed either 'mean' or 'median': ::
@@ -68,9 +83,12 @@
         the first SCT, will be presented to the student.
 
     """
+)
 
 
-check_correct.__doc__ = str(check_correct.__doc__) + """
+check_correct.__doc__ = (
+    str(check_correct.__doc__)
+    + """
     :Example:
 
         The SCT below tests whether an object is correct. Only if the object is not correct, will
@@ -82,12 +100,15 @@
             )
 
     """
+)
 
 
 # utility functions -----------------------------------------------------------
 
 
-fail.__doc__ = str(fail.__doc__) + """
+fail.__doc__ = (
+    str(fail.__doc__)
+    + """
     :Example:
     
         As a trivial SCT example, ::
@@ -96,6 +117,7 @@
 
         This can also be helpful for debugging SCTs, as it can be used to stop testing as a given point.
     """
+)
 
 
 def override(state, solution):
@@ -271,7 +293,9 @@ def set_env(state, **kwargs):
     )
 
 
-disable_highlighting.__doc__ = str(disable_highlighting.__doc__) + """
+disable_highlighting.__doc__ = (
+    str(disable_highlighting.__doc__)
+    + """
     :Examples:
 
         SCT that will mark the 'number' portion if it is incorrect::
@@ -284,3 +308,4 @@ def set_env(state, **kwargs):
             Ex().check_function('round').disable_highlighting().check_args(0).has_equal_ast()
             Ex().check_function('round').check_args(0).disable_highlighting().has_equal_ast()
     """
+)

pythonwhat/checks/check_object.py

@@ -16,9 +16,7 @@
 import ast
 
 
-def check_object(
-    state, index, missing_msg=None, expand_msg=None, typestr="variable"
-):
+def check_object(state, index, missing_msg=None, expand_msg=None, typestr="variable"):
     """Check object existence (and equality)
 
     Check whether an object is defined in the student's process, and zoom in on its value in both
@@ -181,8 +179,12 @@ def __init__(self, n):
 
     # create child state, using either parser output, or create part from name
     fallback = lambda: ObjectAssignmentParser.get_part(index)
-    stu_part = state.ast_dispatcher.find("object_assignments", state.student_ast).get(index, fallback())
-    sol_part = state.ast_dispatcher.find("object_assignments", state.solution_ast).get(index, fallback())
+    stu_part = state.ast_dispatcher.find("object_assignments", state.student_ast).get(
+        index, fallback()
+    )
+    sol_part = state.ast_dispatcher.find("object_assignments", state.solution_ast).get(
+        index, fallback()
+    )
 
     # test object exists
     _msg = state.build_message(missing_msg, append_message["kwargs"])
@@ -242,9 +244,7 @@ def is_instance(state, inst, not_instance_msg=None):
     return state
 
 
-def check_df(
-    state, index, missing_msg=None, not_instance_msg=None, expand_msg=None
-):
+def check_df(state, index, missing_msg=None, not_instance_msg=None, expand_msg=None):
     """Check whether a DataFrame was defined and it is the right type
 
     ``check_df()`` is a combo of ``check_object()`` and ``is_instance()`` that checks whether the specified object exists

pythonwhat/local.py

@@ -38,7 +38,7 @@ def setup_state(stu_code="", sol_code="", pec="", pid=None):
         student_process=stu_process,
         solution_process=sol_process,
         raw_student_output=raw_stu_output,
-        reporter=Reporter()
+        reporter=Reporter(),
     )
 
     State.root_state = state

pythonwhat/probe.py

@@ -61,7 +61,8 @@ def str_branch(cls, node, str_func=lambda s: str(s)):
         # dict(getattr(s.data.get("bound_args", {}), 'arguments', {}))
         f = node.data.get("func")
         this_node = (
-            "  " * node.depth + "("
+            "  " * node.depth
+            + "("
             + getattr(f, "__name__", node.name)
             + str_func(node)
             + ")\n"
@@ -112,7 +113,9 @@ def __call__(self, state=None):
             return ba.arguments["state"]
 
     def __str__(self):
-        return pp.pformat(dict(getattr(self.data.get("bound_args", {}), 'arguments', {})))
+        return pp.pformat(
+            dict(getattr(self.data.get("bound_args", {}), "arguments", {}))
+        )
 
     def __iter__(self):
         for c in self.child_list:
@@ -187,7 +190,7 @@ def __call__(self, *args, **kwargs):
         """
         if (len(args) > 0 and not isinstance(args[0], State)) or len(args) == 0:
             # no state placeholder if a state is passed
-            args = ['state_placeholder'] + list(args)
+            args = ["state_placeholder"] + list(args)
 
         bound_args = inspect.signature(self.f).bind(*args, **kwargs)
 
@@ -200,7 +203,9 @@ def __call__(self, *args, **kwargs):
         arguments = bound_args.arguments
         for subtest in self.sub_tests:  # TODO: auto sub test detection
             if subtest in arguments and arguments[subtest]:
-                self.build_sub_test_nodes(arguments[subtest], self.tree, this_node, subtest)
+                self.build_sub_test_nodes(
+                    arguments[subtest], self.tree, this_node, subtest
+                )
 
         # Second pass to build node and all its children into a subtest
         for node in this_node.descend(include_me=True):

pythonwhat/test_exercise.py

@@ -43,7 +43,7 @@ def test_exercise(
             solution_process=check_process(solution_process),
             raw_student_output=check_str(raw_student_output),
             force_diagnose=force_diagnose,
-            reporter=Reporter(errors=[error] if error else [])
+            reporter=Reporter(errors=[error] if error else []),
         )
 
         State.root_state = state

pythonwhat/test_funcs/test_compound_statement.py

@@ -292,9 +292,7 @@ def shout( word = 'help', times = 3 ):
     """
 
     # what the function will be referred to as
-    child = check_node(
-        state, "function_defs", name, "definition of `{{index}}()`"
-    )
+    child = check_node(state, "function_defs", name, "definition of `{{index}}()`")
 
     test_args(
         child, arg_names, arg_defaults, nb_args_msg, arg_names_msg, arg_defaults_msg
@@ -339,7 +337,7 @@ def shout( word = 'help', times = 3 ):
 
 
 def test_args(
-        state, arg_names, arg_defaults, nb_args_msg, arg_names_msg, arg_defaults_msg
+    state, arg_names, arg_defaults, nb_args_msg, arg_names_msg, arg_defaults_msg
 ):
 
     MSG_NUM_ARGS = "You should define {{parent[typestr]}} with {{sol_len}} arguments, instead got {{stu_len}}."
@@ -446,7 +444,11 @@ def test_object_after_expression(
     pre_code=None,
     **kwargs
 ):
-    state.highlight = state.ast_dispatcher.find("object_assignments", state.student_ast).get(name, {}).get("highlight")
+    state.highlight = (
+        state.ast_dispatcher.find("object_assignments", state.student_ast)
+        .get(name, {})
+        .get("highlight")
+    )
     has_equal_value(
         state,
         incorrect_msg=incorrect_msg,
@@ -496,9 +498,7 @@ def test_with(
     if context_vals:
         # test context var names ----
         has_context(
-            child,
-            incorrect_msg=context_vals_msg or MSG_CTXT_NAMES,
-            exact_names=True,
+            child, incorrect_msg=context_vals_msg or MSG_CTXT_NAMES, exact_names=True
         )
 
         # test num context vars ----
@@ -511,7 +511,8 @@ def test_with(
     for i, context_test in enumerate(context_tests or []):
         # partial the substate check, because the function uses two prepended messages
         def check_context(state):
-            return check_part_index(state,
+            return check_part_index(
+                state,
                 "context",
                 i,
                 "%s context" % utils.get_ord(i + 1),
@@ -543,8 +544,8 @@ def test_list_comp(
 ):
     """Test list comprehension."""
     kwargs = locals().copy()
-    kwargs['typestr'] = "{{ordinal}} list comprehension"
-    kwargs['comptype'] = "list_comps"
+    kwargs["typestr"] = "{{ordinal}} list comprehension"
+    kwargs["comptype"] = "list_comps"
     test_comp(**kwargs)
 
 
@@ -574,9 +575,7 @@ def test_comp(
         insufficient_ifs_msg = MSG_INSUFFICIENT_IFS
 
     # get comprehension
-    child = check_node(
-        state, comptype, index - 1, typestr, missing_msg=not_called_msg
-    )
+    child = check_node(state, comptype, index - 1, typestr, missing_msg=not_called_msg)
 
     # test comprehension iter and its variable names (or number of variables)
     if comp_iter:
@@ -601,7 +600,4 @@ def test_comp(
         # test that ifs are same length
         has_equal_part_len(child, "ifs", insufficient_ifs_msg)
         # test individual ifs
-        multi(
-            check_part_index(child, "ifs", i, utils.get_ord(i + 1) + " if"),
-            if_test,
-        )
+        multi(check_part_index(child, "ifs", i, utils.get_ord(i + 1) + " if"), if_test)

pythonwhat/test_funcs/test_function.py

@@ -135,9 +135,7 @@ def test_function_v2(
     eligible = do_eval[0] if isinstance(do_eval, list) and len(do_eval) > 0 else do_eval
     if name == "print" and state.parent_state is None and eligible:
         try:
-            return has_printout(
-                state, index=index, not_printed_msg=incorrect_msg[0]
-            )
+            return has_printout(state, index=index, not_printed_msg=incorrect_msg[0])
         except TestFail:
             # The test didn't pass; just continue with the more strict check_function test.
             pass

pythonwhat/test_funcs/test_object_accessed.py

@@ -34,7 +34,9 @@ def test_object_accessed(state, name, times=1, not_accessed_msg=None):
         | ``test_object_accessed("arr.shape")``: pass.
         | ``test_object_accessed("arr.dtype")``: fail.
     """
-    student_object_accesses = state.ast_dispatcher.find("object_accesses", state.student_ast)
+    student_object_accesses = state.ast_dispatcher.find(
+        "object_accesses", state.student_ast
+    )
     student_mappings = state.ast_dispatcher.find("oa_mappings", state.student_ast)
 
     if not not_accessed_msg: