def check_file(
state: State,
path,
missing_msg="Did you create the file `{}`?",
is_dir_msg="Want to check the file `{}`, but found a directory.",
parse=True,
solution_code=None,
):
"""Test whether file exists, and make its contents the student code.
Args:
state: State instance describing student and solution code. Can be omitted if used with Ex().
path: expected location of the file
missing_msg: feedback message if no file is found in the expected location
is_dir_msg: feedback message if the path is a directory instead of a file
parse: If ``True`` (the default) the content of the file is interpreted as code in the main exercise technology.
This enables more checks on the content of the file.
solution_code: this argument can be used to pass the expected code for the file
so it can be used by subsequent checks.
Note:
This SCT fails if the file is a directory.
:Example:
To check if a user created the file ``my_output.txt`` in the subdirectory ``resources``
of the directory where the exercise is run, use this SCT::
Ex().check_file("resources/my_output.txt", parse=False)
"""
path_obj = Path(path)
if not path_obj.exists():
state.report(missing_msg.format(path)) # test file exists
if path_obj.is_dir():
state.report(is_dir_msg.format(path)) # test its not a dir
code = get_file_content(path_obj)
sol_kwargs = {"solution_code": solution_code, "solution_ast": None}
if solution_code:
solution_ast = False
if parse:
with debugger(state):
solution_ast = state.parse(solution_code)
sol_kwargs["solution_ast"] = solution_ast
child_state = state.to_child(
append_message="We checked the file `{}`. ".format(path),
student_code=code,
student_ast=state.parse(code) if parse else False,
**sol_kwargs)
child_state.path = path_obj # .parent + .name
return child_state
def has_dir(state: State, path, msg="Did you create a directory `{}`?"):
"""Test whether a directory exists.
Args:
state: State instance describing student and solution code. Can be omitted if used with Ex().
path: expected location of the directory
msg: feedback message if no directory is found in the expected location
:Example:
To check if a user created the subdirectory ``resources``
in the directory where the exercise is run, use this SCT::
Ex().has_dir("resources")
"""
if not Path(path).is_dir():
state.report(msg.format(path))
return state
