def test_comp(typestr,
comptype,
index,
iter_vars_names,
not_called_msg,
insufficient_ifs_msg,
incorrect_iter_vars_msg,
comp_iter,
ifs,
key=None,
body=None,
value=None,
expand_message=True,
rep=None,
state=None):
MSG_NOT_CALLED = "FMT:The system wants to check the {typestr} but hasn't found it."
MSG_PREPEND = "FMT:Check the {typestr}. "
MSG_INCORRECT_ITER_VARS = "FMT:Have you used the correct iterator variables in the {parent[typestr]}? Be sure to use the correct names."
MSG_INCORRECT_NUM_ITER_VARS = "FMT:Have you used {num_vars} iterator variables in the {parent[typestr]}?"
MSG_INSUFFICIENT_IFS = "FMT:Have you used {sol_len} ifs inside the {parent[typestr]}?"
# if true, set expand_message to default (for backwards compatibility)
expand_message = MSG_PREPEND if expand_message is True else (expand_message
or "")
# make sure other messages are set to default if None
if insufficient_ifs_msg is None:
insufficient_ifs_msg = MSG_INSUFFICIENT_IFS
if not_called_msg is None: not_called_msg = MSG_NOT_CALLED
# TODO MSG: function was not consistent with prepending, so use state w/o expand_message
quiet_state = check_node(comptype,
index - 1,
typestr,
not_called_msg,
expand_msg="",
state=state)
# get comprehension
state = check_node(comptype,
index - 1,
typestr,
not_called_msg,
expand_msg=None if expand_message else "",
state=state)
# test comprehension iter and its variable names (or number of variables)
if comp_iter:
multi(comp_iter,
state=check_part("iter", "iterable part", state=state))
# test iterator variables
default_msg = MSG_INCORRECT_ITER_VARS if iter_vars_names else MSG_INCORRECT_NUM_ITER_VARS
has_context(incorrect_iter_vars_msg or default_msg,
iter_vars_names,
state=quiet_state)
# test the main expressions.
if body:
multi(body,
state=check_part("body",
"body",
expand_msg=None if expand_message else "",
state=state)) # list and gen comp
if key:
multi(key,
state=check_part("key",
"key part",
expand_msg=None if expand_message else "",
state=state)) # dict comp
if value:
multi(value,
state=check_part("value",
"value part",
expand_msg=None if expand_message else "",
state=state)) # ""
# test a list of ifs. each entry corresponds to a filter in the comprehension.
for i, if_test in enumerate(ifs or []):
# test that ifs are same length
has_equal_part_len('ifs', insufficient_ifs_msg, state=quiet_state)
# test individual ifs
multi(if_test,
state=check_part_index("ifs",
i,
utils.get_ord(i + 1) + " if",
state=state))
def test_with(
index,
context_vals=False, # whether to check number of context vals
context_tests=None, # check on context expressions
body=None,
undefined_msg=None,
context_vals_len_msg=None,
context_vals_msg=None,
expand_message=True,
state=None):
"""Test a with statement.
with open_file('...') as bla:
[ open_file('...').__enter__() ]
with open_file('...') as file:
[ ]
"""
MSG_MISSING = "Define more `with` statements."
MSG_PREPEND = "FMT:Check the {typestr}. "
MSG_NUM_CTXT = "Make sure to use the correct number of context variables. It seems you defined too many."
MSG_NUM_CTXT2 = "Make sure to use the correct number of context variables. It seems you defined too little."
MSG_CTXT_NAMES = "FMT:Make sure to use the correct context variable names. Was expecting `{sol_vars}` but got `{stu_vars}`."
check_with = partial(check_node,
'withs',
index - 1,
"{ordinal} `with` statement",
MSG_MISSING,
state=state)
child = check_with(MSG_PREPEND if expand_message else "")
child2 = check_with(MSG_PREPEND if expand_message else "")
if context_vals:
# test context var names ----
has_context(incorrect_msg=context_vals_msg or MSG_CTXT_NAMES,
exact_names=True,
state=child)
# test num context vars ----
has_equal_part_len('context', MSG_NUM_CTXT, state=child)
# Context sub tests ----
if context_tests and not isinstance(context_tests, list):
context_tests = [context_tests]
expand_msg = None if expand_message else ""
for i, context_test in enumerate(context_tests or []):
# partial the substate check, because the function uses two prepended messages
check_context = partial(check_part_index,
'context',
i,
"%s context" % utils.get_ord(i + 1),
missing_msg=MSG_NUM_CTXT2,
expand_msg=expand_msg)
check_context(state=child) # test exist
ctxt_state = check_context(state=child2) # sub tests
multi(context_test, state=ctxt_state)
# Body sub tests ----
if body is not None:
body_state = check_part('body',
'body',
expand_msg=expand_msg,
state=child2)
with_context(body, state=body_state)
def test_function_definition(name,
arg_names=True,
arg_defaults=True,
body=None,
results=None,
outputs=None,
errors=None,
not_called_msg=None,
nb_args_msg=None,
other_args_msg=None,
arg_names_msg=None,
arg_defaults_msg=None,
wrong_result_msg=None,
wrong_output_msg=None,
no_error_msg=None,
wrong_error_msg=None,
expand_message=True,
state=None):
"""Test a function definition.
This function helps you test a function definition. Generally four things can be tested:
1) The argument names of the function (including if the correct defaults are used)
2) The body of the functions (does it output correctly, are the correct functions used)
3) The return value with a certain input
4) The output value with a certain input
5) Whether certain inputs generate an error and what type of error
Custom feedback messages can be set for all these parts, default messages are generated
automatically if none are set.
Args:
name (str): the name of the function definition to be tested.
arg_names (bool): if True, the argument names will be tested, if False they won't be tested. Defaults
to True.
arg_defaults (bool): if True, the default values of the arguments will be tested, if False they won't
be tested. Defaults to True.
body: this arguments holds the part of the code that will be ran to check the body of the function
definition. It should be passed as a lambda expression or a function. The functions that are
ran should be other pythoncheck test functions, and they will be tested specifically on only the
body of the for loop. Defaults to None.
results (list(list)): a list of lists representing arguments that should be passed to the defined
function. These arguments are passed to the function in the student environment and the solution
environment, the results (what's returned) are compared.
outputs (list(list)): a list of lists representing arguments that should be passed to the defined
function. These arguments are passed to the function in the student environment and the solution
environment, the outpus are compared.
errors (list(list)): a list of lists representing arguments that should be passed to the defined
function. These arguments are passed to the function in the student environment and the solution
environment, the errors they generate are compared.
not_called_msg (str): message if the function is not defined.
nb_args_msg (str): message if the number of arguments do not matched.
arg_names_msg (str): message if the argument names do not match.
arg_defaults_msg (str): message if the argument default values do not match.
wrong_result_msg (str): message if one of the tested function calls' result did not match.
wrong_output_msg (str): message if one of the tested functions calls' output did not match.
no_error_msg (str): message if one of the tested function calls' result did not generate an error.
wrong_error_msg (str): message if the error that one of the tested function calls generated did not match.
expand_message (bool): only relevant if there is a body test. If True, feedback messages defined in the
body test will be preceded by 'In your definition of ___, '. If False, `test_function_definition()`
will generate no extra feedback if the body test fails. Defaults to True.
:Example:
Student code::
def shout( word, times = 3):
shout_word = not_word + '???'
print( shout_word )
return word * times
Solution code::
def shout( word = 'help', times = 3 ):
shout_word = word + '!!!'
print( shout_word )
return word * times
SCT::
test_function_definition('shout') # fail
test_function_definition('shout', arg_defaults = False) # pass
test_function_definition('shout', arg_defaults = False, # fail
outputs = [('help')])
test_function_definition('shout', arg_defaults = False, # pass
results = [('help', 2)])
test_function_definition('shout', args_defaults = False # pass
body = test_function('print', args = []]))
"""
MSG_MISSING = "FMT:You didn't define the following function: {typestr}."
MSG_PREPEND = "FMT:Check your definition of {typestr}. "
# what the function will be referred to as
typestr = "`{}()`".format(name)
get_func_child = partial(check_node,
'function_defs',
name,
typestr,
not_called_msg or MSG_MISSING,
state=state)
child = get_func_child(expand_msg=MSG_PREPEND if expand_message else "")
# make a temporary child state, to reflect that there were two types of
# messages prepended in the original function
quiet_child = get_func_child(expand_msg="")
prep_child2 = get_func_child(expand_msg=MSG_PREPEND)
test_args(arg_names, arg_defaults, nb_args_msg, arg_names_msg,
arg_defaults_msg, prep_child2, quiet_child)
multi(body,
state=check_part('body',
"",
expand_msg=None if expand_message else "",
state=child))
# Test function calls -----------------------------------------------------
#fun_name = ("`%s()`" % name)
for el in (results or []):
el = fix_format(el)
call(el,
'value',
incorrect_msg=wrong_result_msg,
error_msg=wrong_result_msg,
argstr='`{}{}`'.format(name, stringify(el)),
state=quiet_child)
for el in (outputs or []):
el = fix_format(el)
call(el,
'output',
incorrect_msg=wrong_output_msg,
error_msg=wrong_output_msg,
argstr='`{}{}`'.format(name, stringify(el)),
state=quiet_child)
for el in (errors or []):
el = fix_format(el)
call(el,
'error',
incorrect_msg=wrong_error_msg,
error_msg=no_error_msg,
argstr='`{}{}`'.format(name, stringify(el)),
state=quiet_child)
def test_while_loop(index=1,
test=None,
body=None,
orelse=None,
expand_message=True,
state=None):
"""Test parts of the while loop.
This test function will allow you to extract parts of a specific while loop and perform a set of tests
specifically on these parts. A while loop generally consists of two parts: the condition test, :code:`test`,
which is the condition that is tested each loop, and the :code:`body`. A for while can have a else part as well,
:code:`orelse`, but this is almost never used.::
a = 10
while a < 5:
print(a)
a -= 1
Has :code:`a < 5` as the condition test and `print(i)` as the body.
Args:
index (int): index of the function call to be checked. Defaults to 1.
test: this argument holds the part of code that will be ran to check the condition test of the while loop.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the condition test of
the while loop.
body: this argument holds the part of code that will be ran to check the body of the while loop.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the body of
the while loop.
orelse: this argument holds the part of code that will be ran to check the else part of the while loop.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the else part of
the while loop.
expand_message (bool): if true, feedback messages will be expanded with :code:`in the ___ of the while loop on
line ___`. Defaults to True. If False, `test_for_loop()` will generate no extra feedback.
:Example:
Student code::
a = 10
while a < 5:
print(a)
a -= 1
Solution code::
a = 20
while a < 5:
print(a)
a -= 1
SCT::
test_while_loop(1,
test = test_expression_result({"a": 5}),
body = test_expression_output({"a": 5}))
This SCT will evaluate to True as condition test will have thes same result in student
and solution code and `test_exression_output()` will pass on the body code.
"""
MSG_MISSING = "FMT:Define more while loops."
MSG_PREPEND = "FMT:Check the {typestr}. "
state = check_node('whiles',
index - 1,
"{ordinal} while loop",
MSG_MISSING,
MSG_PREPEND if expand_message else "",
state=state)
expand_msg = None if expand_message else ""
multi(test,
state=check_part('test',
'condition',
expand_msg=expand_msg,
state=state))
multi(body,
state=check_part('body', 'body', expand_msg=expand_msg, state=state))
multi(orelse,
state=check_part('orelse',
'else part',
expand_msg=expand_msg,
state=state))
def test_if_else(index=1,
test=None,
body=None,
orelse=None,
expand_message=True,
use_if_exp=False,
state=None):
"""Test parts of the if statement.
This test function will allow you to extract parts of a specific if statement and perform a set of tests
specifically on these parts. A for loop consists of three potential parts: the condition test, :code:`test`,
which specifies the condition of the if statement, the :code:`body`, which is what's executed if the condition is
True and a else part, :code:`orelse`, which will be executed if the condition is not True.::
if 5 == 3:
print("success")
else:
print("fail")
Has :code:`5 == 3` as the condition test, :code:`print("success")` as the body and :code:`print("fail")` as the else part.
Args:
index (int): index of the function call to be checked. Defaults to 1.
test: this argument holds the part of code that will be ran to check the condition test of the if statement.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the condition test of
the if statement.
body: this argument holds the part of code that will be ran to check the body of the if statement.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the body of
the if statement.
orelse: this argument holds the part of code that will be ran to check the else part of the if statement.
It should be passed as a lambda expression or a function definition. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the else part of
the if statement.
expand_message (bool): if true, feedback messages will be expanded with :code:`in the ___ of the if statement on
line ___`. Defaults to True. If False, :code:`test_if_else()` will generate no extra feedback.
:Example:
Student code::
a = 12
if a > 3:
print('test %d' % a)
Solution code::
a = 4
if a > 3:
print('test %d' % a)
SCT::
test_if_else(1,
body = test_expression_output(
extra_env = { 'a': 5 }
incorrect_msg = "Print out the correct things"))
This SCT will pass as :code:`test_expression_output()` is ran on the body of the if statement and it will output
the same thing in the solution as in the student code.
"""
MSG_MISSING = "FMT:The system wants to check the {typestr}, but it hasn't found it. Have another look at your code."
MSG_PREPEND = "FMT:Check the {typestr}. "
# get state with specific if block
node_name = 'if_exps' if use_if_exp else 'if_elses'
# TODO original typestr for check_node used if rather than `if`
state = check_node(node_name,
index - 1,
"{ordinal} if statement",
MSG_MISSING,
MSG_PREPEND if expand_message else "",
state=state)
# run sub tests
multi(test,
state=check_part('test',
'condition',
expand_msg=None if expand_message else "",
state=state))
multi(body,
state=check_part('body',
'body',
expand_msg=None if expand_message else "",
state=state))
multi(orelse,
state=check_part('orelse',
'else part',
expand_msg=None if expand_message else "",
state=state))
def test_for_loop(index=1,
for_iter=None,
body=None,
orelse=None,
expand_message=True,
state=None):
"""Test parts of the for loop.
This test function will allow you to extract parts of a specific for loop and perform a set of tests
specifically on these parts. A for loop consists of two parts: the sequence, `for_iter`, which is the
values over which are looped, and the `body`. A for loop can have a else part as well, `orelse`, but
this is almost never used.::
for i in range(10):
print(i)
Has :code:`range(10)` as the sequence and :code:`print(i)` as the body.
Args:
index (int): index of the function call to be checked. Defaults to 1.
for_iter: this argument holds the part of code that will be ran to check the sequence of the for loop.
It should be passed as a lambda expression or a function. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the sequence part of
the for loop.
body: this argument holds the part of code that will be ran to check the body of the for loop.
It should be passed as a lambda expression or a function. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the body of
the for loop.
orelse: this argument holds the part of code that will be ran to check the else part of the for loop.
It should be passed as a lambda expression or a function. The functions that are ran should
be other pythoncheck test functions, and they will be tested specifically on only the else part of
the for loop.
expand_message (bool): if true, feedback messages will be expanded with :code:`in the ___ of the for loop on
line ___`. Defaults to True. If False, :code:`test_for_loop()` will generate no extra feedback.
:Example:
Student code::
for i in range(10):
print(i)
Solution code::
for n in range(10):
print(n)
SCT::
test_for_loop(1,
for_iter = test_function("range"),
body = test_expression_output(context_val = [5])
This SCT will evaluate to True as the function :code:`range` is used in the sequence and the function
:code:`test_exression_output()` will pass on the body code.
"""
MSG_MISSING = "FMT:Define more for loops."
MSG_PREPEND = "FMT:Check the {typestr}. "
state = check_node('for_loops',
index - 1,
"{ordinal} for loop",
MSG_MISSING,
MSG_PREPEND,
state=state)
# TODO for_iter is a level up, so shouldn't have targets set, but this is done is check_node
multi(for_iter,
state=check_part('iter',
'sequence part',
expand_msg=None if expand_message else "",
state=state))
multi(body,
state=check_part('body',
'body',
expand_msg=None if expand_message else "",
state=state))
multi(orelse,
state=check_part('orelse',
'else part',
expand_msg=None if expand_message else "",
state=state))