Skip to content

E
edx-platform
Commit 6bed6f88 by Matt Drayer Committed by Xavier Antoviaque
Options

Added hinting/feedback mechanism for multiple choice problem type

parent def8ee7e
Showing with 210 additions and 45 deletions
common/lib/capa/capa/responsetypes.py
...@@ -344,7 +344,10 @@ class LoncapaResponse(object): ...@@ -344,7 +344,10 @@ class LoncapaResponse(object):
hintmode = hintgroup.get('mode', 'always') hintmode = hintgroup.get('mode', 'always')
for hintpart in hintgroup.findall('hintpart'): for hintpart in hintgroup.findall('hintpart'):
if hintpart.get('on') in hints_to_show: if hintpart.get('on') in hints_to_show:
hint_text = hintpart.find('text').text if hintpart.find('text') is not None:
hint_text = hintpart.find('text').text
elif hintpart.text:
hint_text = hintpart.text
# make the hint appear after the last answer box in this # make the hint appear after the last answer box in this
# response # response
aid = self.answer_ids[-1] aid = self.answer_ids[-1]
...@@ -715,9 +718,14 @@ class ChoiceResponse(LoncapaResponse): ...@@ -715,9 +718,14 @@ class ChoiceResponse(LoncapaResponse):
@registry.register @registry.register
class MultipleChoiceResponse(LoncapaResponse): class MultipleChoiceResponse(LoncapaResponse):
"""
MultipleChoiceResponse is a specialized ChoiceResponse type responsible
for handling all aspects of MCQ behavior, including hinting
"""
# TODO: handle direction and randomize # TODO: handle direction and randomize
tags = ['multiplechoiceresponse'] tags = ['multiplechoiceresponse']
hint_tag = 'choicehint'
max_inputfields = 1 max_inputfields = 1
allowed_inputfields = ['choicegroup'] allowed_inputfields = ['choicegroup']
correct_choices = None correct_choices = None
...@@ -771,6 +779,29 @@ class MultipleChoiceResponse(LoncapaResponse): ...@@ -771,6 +779,29 @@ class MultipleChoiceResponse(LoncapaResponse):
def get_answers(self): def get_answers(self):
return {self.answer_id: self.correct_choices} return {self.answer_id: self.correct_choices}
def check_string(self, expected, given):
"""
Attempt to match the given value with what the caller expects
For now we ignore the case -- at some point we might add a switch
We're also a bit lenient in terms of matching at the present time
"""
flags = re.IGNORECASE
regexp = re.compile('^' + '|'.join(expected) + '$', flags=flags | re.UNICODE)
result = re.search(regexp, given)
return bool(result)
def check_hint_condition(self, hxml_set, student_answers):
# stolen from StringResponse.check_hint_condition
given = student_answers[self.answer_id].strip()
hints_to_show = []
for hxml in hxml_set:
name = hxml.get('name')
hinted_answer = contextualize_text(hxml.get('answer'), self.context).strip()
if self.check_string([hinted_answer], given):
hints_to_show.append(name)
return hints_to_show
@registry.register @registry.register
class TrueFalseResponse(MultipleChoiceResponse): class TrueFalseResponse(MultipleChoiceResponse):
......
common/lib/capa/capa/templates/choicegroup.html
<%
fieldset_width = 775
fieldset_message_width = 0
if (not msg is UNDEFINED) and (len(msg) > 0):
fieldset_width = 480
fieldset_message_width = 295
%>
<form class="choicegroup capa_inputtype" id="inputtype_${id}"> <form class="choicegroup capa_inputtype" id="inputtype_${id}">
<style>
#fieldset_container_${id} {
margin: 0 auto;
overflow: hidden;
position: relative;
height: 100;
width: 100%;
}
#fieldset_${id} {
float: left;
margin: 0 auto;
word-wrap: normal;
height: 100%;
width:${fieldset_width}px;
}
#fieldset_message_${id} {
background: #99CCFF;
color: #FFFFFF;
font-family: arial;
float: right;
height: 250px;
margin: 5 auto;
padding: 10px;
position: absolute;
right: 0;
width:${fieldset_message_width}px;
}
#fieldset_message_title_${id} {
color: #FFFFFF;
font-family: arial;
font-size: 18pt;
}
</style>
<div class="indicator_container"> <div class="indicator_container">
% if input_type == 'checkbox' or not value: % if input_type == 'checkbox' or not value:
% if status == 'unsubmitted' or show_correctness == 'never': % if status == 'unsubmitted' or show_correctness == 'never':
...@@ -12,54 +58,67 @@ ...@@ -12,54 +58,67 @@
% endif % endif
% endif % endif
</div> </div>
<div id="fieldset_container_${id}">
<div id="fieldset_${id}">
<fieldset role="radiogroup" aria-label="${label}">
<fieldset role="radiogroup" aria-label="${label}"> % for choice_id, choice_description in choices:
<label for="input_${id}_${choice_id}"
## If the student has selected this choice...
% if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ):
<%
if status == 'correct':
correctness = 'correct'
elif status == 'incorrect':
correctness = 'incorrect'
else:
correctness = None
%>
% if correctness and not show_correctness=='never':
class="choicegroup_${correctness}"
% endif
% endif
>
<input type="${input_type}" name="input_${id}${name_array_suffix}" id="input_${id}_${choice_id}" aria-role="radio" aria-describedby="answer_${id}" value="${choice_id}"
## If the student selected this choice...
% if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ):
checked="true"
% elif input_type != 'radio' and choice_id in value:
checked="true"
% endif
% for choice_id, choice_description in choices: /> ${choice_description}
<label for="input_${id}_${choice_id}"
## If the student has selected this choice...
% if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ):
<%
if status == 'correct':
correctness = 'correct'
elif status == 'incorrect':
correctness = 'incorrect'
else:
correctness = None
%>
% if correctness and not show_correctness=='never':
class="choicegroup_${correctness}"
% endif
% endif
>
<input type="${input_type}" name="input_${id}${name_array_suffix}" id="input_${id}_${choice_id}" aria-role="radio" aria-describedby="answer_${id}" value="${choice_id}"
## If the student selected this choice...
% if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ):
checked="true"
% elif input_type != 'radio' and choice_id in value:
checked="true"
% endif
/> ${choice_description} % if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ):
<%
% if input_type == 'radio' and ( (isinstance(value, basestring) and (choice_id == value)) or (not isinstance(value, basestring) and choice_id in value) ): if status == 'correct':
<% correctness = 'correct'
if status == 'correct': elif status == 'incorrect':
correctness = 'correct' correctness = 'incorrect'
elif status == 'incorrect': else:
correctness = 'incorrect' correctness = None
else: %>
correctness = None % if correctness and not show_correctness=='never':
%> <span class="sr" aria-describedby="input_${id}_${choice_id}">Status: ${correctness}</span>
% if correctness and not show_correctness=='never': % endif
<span class="sr" aria-describedby="input_${id}_${choice_id}">Status: ${correctness}</span> % endif
</label>
% endfor
<span id="answer_${id}"></span>
</fieldset>
</div>
## Message/hint display block -- empty/invisible unless msg is populated
<div
% if (not msg is UNDEFINED) and (len(msg) > 0):
id="fieldset_message_${id}"
% endif % endif
>
% if (not msg is UNDEFINED) and (len(msg) > 0):
<span id="fieldset_message_title_${id}">Feedback</span>
${msg}
% endif % endif
</label> </div>
% endfor </div>
<span id="answer_${id}"></span>
</fieldset>
% if show_correctness == "never" and (value or status not in ['unsubmitted']): % if show_correctness == "never" and (value or status not in ['unsubmitted']):
<div class="capa_alert">${submitted_message}</div> <div class="capa_alert">${submitted_message}</div>
%endif %endif
......
common/lib/capa/capa/tests/response_xml_factory.py
...@@ -58,6 +58,7 @@ class ResponseXMLFactory(object): ...@@ -58,6 +58,7 @@ class ResponseXMLFactory(object):
script = kwargs.get('script', None) script = kwargs.get('script', None)
num_responses = kwargs.get('num_responses', 1) num_responses = kwargs.get('num_responses', 1)
num_inputs = kwargs.get('num_inputs', 1) num_inputs = kwargs.get('num_inputs', 1)
hints = kwargs.get('hints', None)
# The root is <problem> # The root is <problem>
root = etree.Element("problem") root = etree.Element("problem")
...@@ -83,6 +84,12 @@ class ResponseXMLFactory(object): ...@@ -83,6 +84,12 @@ class ResponseXMLFactory(object):
if not (None == input_element): if not (None == input_element):
response_element.append(input_element) response_element.append(input_element)
# Add hintgroup, if specified
if hints is not None and hasattr(self, 'create_hintgroup_element'):
hintgroup_element = self.create_hintgroup_element(**kwargs)
if hintgroup_element is not None:
response_element.append(hintgroup_element)
# The problem has an explanation of the solution # The problem has an explanation of the solution
if explanation_text: if explanation_text:
explanation = etree.SubElement(root, "solution") explanation = etree.SubElement(root, "solution")
...@@ -161,6 +168,28 @@ class ResponseXMLFactory(object): ...@@ -161,6 +168,28 @@ class ResponseXMLFactory(object):
return group_element return group_element
@staticmethod
def hintgroup_input_xml(**kwargs):
""" Create a <hintgroup> XML element"""
# Gather the troops
choice_names = kwargs.get("choice_names")
hints = kwargs.get("hints")
# Build the <hintgroup> child tree
group_element = etree.Element("hintgroup")
for (choice_name, hint) in zip(choice_names, hints):
choicehint_element = etree.SubElement(group_element, "choicehint")
choicehint_answer = "choice_" + choice_name
choicehint_element.set("answer", choicehint_answer)
choicehint_name = choice_name + "_hint"
choicehint_element.set("name", choicehint_name)
hintpart_element = etree.SubElement(group_element, "hintpart")
hintpart_element.set("on", choicehint_name)
hintpart_element.text = hint
return group_element
class NumericalResponseXMLFactory(ResponseXMLFactory): class NumericalResponseXMLFactory(ResponseXMLFactory):
""" Factory for producing <numericalresponse> XML trees """ """ Factory for producing <numericalresponse> XML trees """
...@@ -618,7 +647,14 @@ class MultipleChoiceResponseXMLFactory(ResponseXMLFactory): ...@@ -618,7 +647,14 @@ class MultipleChoiceResponseXMLFactory(ResponseXMLFactory):
def create_input_element(self, **kwargs): def create_input_element(self, **kwargs):
""" Create the <choicegroup> element""" """ Create the <choicegroup> element"""
kwargs['choice_type'] = 'multiple' kwargs['choice_type'] = 'multiple'
return ResponseXMLFactory.choicegroup_input_xml(**kwargs) choice_group = ResponseXMLFactory.choicegroup_input_xml(**kwargs)
return choice_group
def create_hintgroup_element(self, **kwargs):
""" Create the <hintgroup> element"""
hintgroup_element = ResponseXMLFactory.hintgroup_input_xml(**kwargs)
return hintgroup_element
class TrueFalseResponseXMLFactory(ResponseXMLFactory): class TrueFalseResponseXMLFactory(ResponseXMLFactory):
......
common/lib/capa/capa/tests/test_input_templates.py
...@@ -256,6 +256,36 @@ class ChoiceGroupTemplateTest(TemplateTestCase): ...@@ -256,6 +256,36 @@ class ChoiceGroupTemplateTest(TemplateTestCase):
xpath = "//div[@class='indicator_container']/span" xpath = "//div[@class='indicator_container']/span"
self.assert_no_xpath(xml, xpath, self.context) self.assert_no_xpath(xml, xpath, self.context)
def test_option_marked_incorrect_with_feedback(self):
"""
Test conditions under which a particular option
(not the entire problem) is marked incorrect, with feedback.
"""
conditions = [
{'input_type': 'radio', 'value': '2'},
{'input_type': 'radio', 'value': ['2']}]
self.context['status'] = 'incorrect'
self.context['msg'] = "This is the feedback"
for test_conditions in conditions:
self.context.update(test_conditions)
xml = self.render_to_xml(self.context)
# Should include a choicegroup_incorrect class
xpath = "//label[@class='choicegroup_incorrect']"
self.assert_has_xpath(xml, xpath, self.context)
# Should include a fieldset_message type
xpath = "//div[@id='fieldset_message_" + self.context['id'] + "']"
self.assert_has_xpath(xml, xpath, self.context)
# Should include a fieldset_message_title type
xpath = "//span[@id='fieldset_message_title_" + self.context['id'] + "']"
self.assert_has_xpath(xml, xpath, self.context)
def test_never_show_correctness(self): def test_never_show_correctness(self):
""" """
Test conditions under which we tell the template to Test conditions under which we tell the template to
......
common/lib/capa/capa/tests/test_responsetypes.py
...@@ -94,6 +94,15 @@ class MultiChoiceResponseTest(ResponseTest): ...@@ -94,6 +94,15 @@ class MultiChoiceResponseTest(ResponseTest):
self.assert_grade(problem, 'choice_foil_3', 'incorrect') self.assert_grade(problem, 'choice_foil_3', 'incorrect')
def test_named_multiple_choice_grade_with_hint(self):
problem = self.build_problem(choices=[False],
choice_names=["foil_1"],
hints=["h1"])
# Ensure that we get the expected hint
self.assert_grade(problem, 'choice_foil_1', 'incorrect', 'h1')
class TrueFalseResponseTest(ResponseTest): class TrueFalseResponseTest(ResponseTest):
from capa.tests.response_xml_factory import TrueFalseResponseXMLFactory from capa.tests.response_xml_factory import TrueFalseResponseXMLFactory
xml_factory_class = TrueFalseResponseXMLFactory xml_factory_class = TrueFalseResponseXMLFactory
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment