Newer
Older
# -*- coding: utf-8 -*-
from __future__ import division
__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"
__license__ = """
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
from django.shortcuts import ( # noqa
redirect, get_object_or_404)
from django.contrib import messages # noqa
from django.core.exceptions import (
PermissionDenied, SuspiciousOperation, ObjectDoesNotExist)
from django.db import connection
from django import forms
from django.db import transaction
from django.core.urlresolvers import reverse
from crispy_forms.layout import Submit
from course.utils import course_view, render_course_page
from course.models import (
Participation, participation_role, participation_status,
GradingOpportunity, GradeChange, GradeStateMachine,
# {{{ student grade book
@course_view
def view_participant_grades(pctx, participation_id=None):
if pctx.participation is None:
raise PermissionDenied("must be enrolled to view grades")
if participation_id is not None:
grade_participation = Participation.objects.get(id=int(participation_id))
else:
grade_participation = pctx.participation
if pctx.role in [
participation_role.instructor,
participation_role.teaching_assistant]:
elif pctx.role == participation_role.student:
if grade_participation != pctx.participation:
raise PermissionDenied("may not view other people's grades")
# NOTE: It's important that these two queries are sorted consistently,
# also consistently with the code below.
grading_opps = list((GradingOpportunity.objects
.filter(
course=pctx.course,
shown_in_grade_book=True,
)
.order_by("identifier")))
grade_changes = list(GradeChange.objects
.filter(
opportunity__course=pctx.course,
opportunity__shown_in_grade_book=True)
.order_by(
"participation__id",
.select_related("participation")
.select_related("participation__user")
.select_related("opportunity"))
idx = 0
grade_table = []
for opp in grading_opps:
if is_student_viewing:
if not (opp.shown_in_grade_book
and opp.shown_in_student_grade_book):
continue
else:
if not opp.shown_in_grade_book:
continue
while (
idx < len(grade_changes)
and grade_changes[idx].opportunity.identifier < opp.identifier
):
idx += 1
my_grade_changes = []
while (
idx < len(grade_changes)
and grade_changes[idx].opportunity.pk == opp.pk):
my_grade_changes.append(grade_changes[idx])
idx += 1
state_machine = GradeStateMachine()
state_machine.consume(my_grade_changes)
grade_table.append(
GradeInfo(
opportunity=opp,
grade_state_machine=state_machine))
return render_course_page(pctx, "course/gradebook-participant.html", {
"grade_table": grade_table,
"grade_participation": grade_participation,
"grading_opportunities": grading_opps,
"grade_state_change_types": grade_state_change_types,
})
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# {{{ participant list
@course_view
def view_participant_list(pctx):
if pctx.role not in [
participation_role.instructor,
participation_role.teaching_assistant]:
raise PermissionDenied("must be instructor or TA to view grades")
participations = list(Participation.objects
.filter(
course=pctx.course,
status=participation_status.active)
.order_by("id")
.select_related("user"))
return render_course_page(pctx, "course/gradebook-participant-list.html", {
"participations": participations,
})
# }}}
# {{{ grading opportunity list
@course_view
def view_grading_opportunity_list(pctx):
if pctx.role not in [
participation_role.instructor,
participation_role.teaching_assistant]:
raise PermissionDenied("must be instructor or TA to view grades")
grading_opps = list((GradingOpportunity.objects
.filter(
course=pctx.course,
shown_in_grade_book=True,
)
.order_by("identifier")))
return render_course_page(pctx, "course/gradebook-opp-list.html", {
"grading_opps": grading_opps,
})
# }}}
class GradeInfo:
def __init__(self, opportunity, grade_state_machine):
self.opportunity = opportunity
self.grade_state_machine = grade_state_machine
# NOTE: It's important that these queries are sorted consistently,
# also consistently with the code below.
grading_opps = list((GradingOpportunity.objects
shown_in_grade_book=True,
)
.order_by("identifier")))
participations = list(Participation.objects
.filter(
status=participation_status.active)
.select_related("user"))
grade_changes = list(GradeChange.objects
"opportunity__identifier",
"grade_time")
.select_related("participation")
.select_related("participation__user")
.select_related("opportunity"))
grade_table = []
for participation in participations:
and grade_changes[idx].participation.id < participation.id):
grade_row = []
for opp in grading_opps:
while (
idx < len(grade_changes)
and grade_changes[idx].participation.pk == participation.pk
and grade_changes[idx].opportunity.identifier < opp.identifier
):
idx += 1
my_grade_changes = []
while (
idx < len(grade_changes)
and grade_changes[idx].opportunity.pk == opp.pk
and grade_changes[idx].participation.pk == participation.pk):
my_grade_changes.append(grade_changes[idx])
idx += 1
state_machine = GradeStateMachine()
grade_row.append(
GradeInfo(
opportunity=opp,
grade_state_machine=state_machine))
grade_table.append(grade_row)
return participations, grading_opps, grade_table
@course_view
def view_gradebook(pctx):
if pctx.role not in [
participation_role.instructor,
participation_role.teaching_assistant]:
raise PermissionDenied("must be instructor or TA to view grades")
participations, grading_opps, grade_table = get_grade_table(pctx.course)
grade_table = sorted(zip(participations, grade_table),
key=lambda (participation, grades):
(participation.user.last_name.lower(),
participation.user.first_name.lower()))
return render_course_page(pctx, "course/gradebook.html", {
"grade_table": grade_table,
"grading_opportunities": grading_opps,
"participations": participations,
"grade_state_change_types": grade_state_change_types,
})
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
@course_view
def export_gradebook_csv(pctx):
if pctx.role not in [
participation_role.instructor,
participation_role.teaching_assistant]:
raise PermissionDenied("must be instructor or TA to export grades")
participations, grading_opps, grade_table = get_grade_table(pctx.course)
from six import BytesIO
csvfile = BytesIO()
import unicodecsv
fieldnames = ['user_name', 'last_name', 'first_name'] + [
gopp.identifier for gopp in grading_opps]
writer = unicodecsv.writer(csvfile, encoding="utf-8")
writer.writerow(fieldnames)
for participation, grades in zip(participations, grade_table):
writer.writerow([
participation.user.username,
participation.user.last_name,
participation.user.first_name,
] + [grade_info.grade_state_machine.stringify_machine_readable_state()
for grade_info in grades])
csvfile.getvalue(),
content_type="text/plain; charset=utf-8")
# {{{ grades by grading opportunity
class OpportunityGradeInfo(object):
def __init__(self, grade_state_machine, flow_sessions):
self.grade_state_machine = grade_state_machine
class ModifySessionsForm(StyledForm):
def __init__(self, session_rule_tags, *args, **kwargs):
super(ModifySessionsForm, self).__init__(*args, **kwargs)
self.fields["rule_tag"] = forms.ChoiceField(
(rule_tag, str(rule_tag))
for rule_tag in session_rule_tags))
self.fields["past_due_only"] = forms.BooleanField(
required=False,
initial=True,
help_text="Only act on in-progress sessions that are past "
"their access rule's due date (applies to 'expire' and 'end')")
self.helper.add_input(
Submit("expire", "Expire sessions",
css_class="col-lg-offset-2"))
self.helper.add_input(
Submit("end", "End sessions and grade"))
self.helper.add_input(
Submit("regrade", "Regrade ended sessions"))
self.helper.add_input(
Submit("recalculate", "Recalculate grades of ended sessions"))
@transaction.atomic
def expire_in_progress_sessions(repo, course, flow_id, rule_tag, now_datetime,
past_due_only):
sessions = (FlowSession.objects
.filter(
course=course,
flow_id=flow_id,
participation__isnull=False,
access_rules_tag=rule_tag,
in_progress=True,
))
count = 0
from course.flow import expire_flow_session_standalone
for session in sessions:
if expire_flow_session_standalone(repo, course, session, now_datetime,
past_due_only=past_due_only):
return count
def finish_in_progress_sessions(repo, course, flow_id, rule_tag, now_datetime,
past_due_only):
sessions = (FlowSession.objects
.filter(
course=course,
flow_id=flow_id,
participation__isnull=False,
access_rules_tag=rule_tag,
in_progress=True,
))
from course.flow import finish_flow_session_standalone
for session in sessions:
if finish_flow_session_standalone(repo, course, session,
now_datetime=now_datetime, past_due_only=past_due_only):
@transaction.atomic
def regrade_ended_sessions(repo, course, flow_id, rule_tag):
sessions = (FlowSession.objects
.filter(
course=course,
flow_id=flow_id,
participation__isnull=False,
access_rules_tag=rule_tag,
in_progress=False,
))
count = 0
from course.flow import regrade_session
for session in sessions:
regrade_session(repo, course, session)
count += 1
return count
def recalculate_ended_sessions(repo, course, flow_id, rule_tag):
sessions = (FlowSession.objects
.filter(
course=course,
flow_id=flow_id,
participation__isnull=False,
access_rules_tag=rule_tag,
in_progress=False,
))
count = 0
from course.flow import recalculate_session_grade
for session in sessions:
recalculate_session_grade(repo, course, session)
count += 1
return count
RULE_TAG_NONE_STRING = "<<<NONE>>>"
def mangle_session_access_rule_tag(rule_tag):
if rule_tag is None:
return RULE_TAG_NONE_STRING
@course_view
def view_grades_by_opportunity(pctx, opp_id):
from course.views import get_now_or_fake_time
now_datetime = get_now_or_fake_time(pctx.request)
if pctx.role not in [
participation_role.instructor,
participation_role.teaching_assistant]:
raise PermissionDenied("must be instructor or TA to view grades")
opportunity = get_object_or_404(GradingOpportunity, id=int(opp_id))
if pctx.course != opportunity.course:
raise SuspiciousOperation("opportunity from wrong course")
# {{{ batch sessions form
if pctx.role == participation_role.instructor and opportunity.flow_id:
cursor = connection.cursor()
cursor.execute("select distinct access_rules_tag from course_flowsession "
"order by access_rules_tag", (pctx.course.id, opportunity.flow_id))
session_rule_tags = [
mangle_session_access_rule_tag(row[0]) for row in cursor.fetchall()]
request = pctx.request
if request.method == "POST":
session_rule_tags, request.POST, request.FILES)
if "expire" in request.POST:
op = "expire"
elif "end" in request.POST:
op = "end"
elif "regrade" in request.POST:
op = "regrade"
elif "recalculate" in request.POST:
op = "recalculate"
else:
raise SuspiciousOperation("invalid operation")
rule_tag = batch_session_ops_form.cleaned_data["rule_tag"]
past_due_only = batch_session_ops_form.cleaned_data["past_due_only"]
if rule_tag == RULE_TAG_NONE_STRING:
rule_tag = None
if op == "expire":
count = expire_in_progress_sessions(
pctx.repo, pctx.course, opportunity.flow_id,
rule_tag, now_datetime,
past_due_only=past_due_only)
messages.add_message(pctx.request, messages.SUCCESS,
"%d session(s) expired." % count)
elif op == "end":
count = finish_in_progress_sessions(
pctx.repo, pctx.course, opportunity.flow_id,
rule_tag, now_datetime,
past_due_only=past_due_only)
messages.add_message(pctx.request, messages.SUCCESS,
"%d session(s) ended." % count)
elif op == "regrade":
count = regrade_ended_sessions(
pctx.repo, pctx.course, opportunity.flow_id,
messages.add_message(pctx.request, messages.SUCCESS,
"%d session(s) regraded." % count)
elif op == "recalculate":
count = recalculate_ended_sessions(
pctx.repo, pctx.course, opportunity.flow_id,
messages.add_message(pctx.request, messages.SUCCESS,
else:
raise SuspiciousOperation("invalid operation")
except Exception as e:
messages.add_message(pctx.request, messages.ERROR,
batch_session_ops_form = ModifySessionsForm(session_rule_tags)
# NOTE: It's important that these queries are sorted consistently,
# also consistently with the code below.
participations = list(Participation.objects
.filter(
course=pctx.course,
status=participation_status.active)
.select_related("user"))
grade_changes = list(GradeChange.objects
.filter(opportunity=opportunity)
.order_by(
.select_related("participation")
.select_related("participation__user")
.select_related("opportunity"))
grade_table = []
for participation in participations:
while (
idx < len(grade_changes)
and grade_changes[idx].participation.id < participation.id):
idx += 1
my_grade_changes = []
while (
idx < len(grade_changes)
and grade_changes[idx].participation.pk == participation.pk):
my_grade_changes.append(grade_changes[idx])
idx += 1
state_machine = GradeStateMachine()
state_machine.consume(my_grade_changes)
if opportunity.flow_id:
flow_sessions = (FlowSession.objects
.filter(
participation=participation,
flow_id=opportunity.flow_id,
)
.order_by("start_time"))
for fsession in flow_sessions:
total_sessions += 1
if not fsession.in_progress:
finished_sessions += 1
grade_table.append(
OpportunityGradeInfo(
grade_state_machine=state_machine,
flow_sessions=flow_sessions))
grade_table = sorted(zip(participations, grade_table),
key=lambda (participation, grades):
(participation.user.last_name.lower(),
participation.user.first_name.lower()))
return render_course_page(pctx, "course/gradebook-by-opp.html", {
"opportunity": opportunity,
"participations": participations,
"grade_state_change_types": grade_state_change_types,
"grade_table": grade_table,
"total_sessions": total_sessions,
"finished_sessions": finished_sessions,
# {{{ view single grade
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
def average_grade(opportunity):
grade_changes = (GradeChange.objects
.filter(opportunity=opportunity)
.order_by(
"participation__id",
"grade_time")
.select_related("participation")
.select_related("opportunity"))
grades = []
my_grade_changes = []
def finalize():
if not my_grade_changes:
return
state_machine = GradeStateMachine()
state_machine.consume(my_grade_changes)
percentage = state_machine.percentage()
if percentage is not None:
grades.append(percentage)
del my_grade_changes[:]
last_participation = None
for gchange in grade_changes:
if last_participation != gchange.participation:
finalize()
last_participation = gchange.participation
my_grade_changes.append(gchange)
finalize()
if grades:
return sum(grades)/len(grades), len(grades)
else:
return None, 0
@course_view
def view_single_grade(pctx, participation_id, opportunity_id):
from course.views import get_now_or_fake_time
now_datetime = get_now_or_fake_time(pctx.request)
participation = get_object_or_404(Participation,
id=int(participation_id))
if participation.course != pctx.course:
raise SuspiciousOperation("participation does not match course")
opportunity = get_object_or_404(GradingOpportunity, id=int(opportunity_id))
if pctx.role in [
participation_role.instructor,
participation_role.teaching_assistant]:
messages.add_message(pctx.request, messages.INFO,
"This grade is not shown in the grade book.")
if not opportunity.shown_in_student_grade_book:
messages.add_message(pctx.request, messages.INFO,
"This grade is not shown in the student grade book.")
elif pctx.role == participation_role.student:
if participation != pctx.participation:
raise PermissionDenied("may not view other people's grades")
if not (opportunity.shown_in_grade_book
and opportunity.shown_in_student_grade_book):
raise PermissionDenied("grade has not been released")
else:
raise PermissionDenied()
if pctx.role in [
participation_role.instructor,
participation_role.teaching_assistant]:
allow_session_actions = True
request = pctx.request
if pctx.request.method == "POST":
action_re = re.compile("^([a-z]+)_([0-9]+)$")
for key in request.POST.keys():
action_match = action_re.match(key)
if action_match:
break
if not action_match:
raise SuspiciousOperation("unknown action")
session = FlowSession.objects.get(id=int(action_match.group(2)))
op = action_match.group(1)
from course.flow import (
reopen_session,
regrade_session,
expire_flow_session_standalone,
finish_flow_session_standalone)
try:
if op == "expire":
expire_flow_session_standalone(
pctx.repo, pctx.course, session, now_datetime)
messages.add_message(pctx.request, messages.SUCCESS,
"Session expired.")
elif op == "end":
Andreas Klöckner
committed
pctx.repo, pctx.course, session,
now_datetime=now_datetime)
messages.add_message(pctx.request, messages.SUCCESS,
"Session ended.")
elif op == "reopen":
reopen_session(session)
messages.add_message(pctx.request, messages.SUCCESS,
"Session reopened.")
elif op == "regrade":
regrade_session(
pctx.repo, pctx.course, session)
messages.add_message(pctx.request, messages.SUCCESS,
"Session regraded.")
elif op == "recalculate":
recalculate_session_grade(
pctx.repo, pctx.course, session)
messages.add_message(pctx.request, messages.SUCCESS,
else:
raise SuspiciousOperation("invalid session operation")
except Exception as e:
messages.add_message(pctx.request, messages.ERROR,
else:
allow_session_actions = False
# }}}
grade_changes = list(GradeChange.objects
.filter(
opportunity=opportunity,
participation=participation)
.select_related("participation")
.select_related("participation__user")
.select_related("creator")
.select_related("opportunity"))
state_machine = GradeStateMachine()
state_machine.consume(grade_changes, set_is_superseded=True)
flow_sessions = list(FlowSession.objects
.filter(
participation=participation,
flow_id=opportunity.flow_id,
)
.order_by("start_time"))
from collections import namedtuple
SessionProperties = namedtuple( # noqa
"SessionProperties",
["due", "grade_description"])
from course.utils import get_session_grading_rule
from course.content import get_flow_desc
try:
flow_desc = get_flow_desc(pctx.repo, pctx.course,
opportunity.flow_id, pctx.course_commit_sha)
except ObjectDoesNotExist:
flow_sessions_and_session_properties = None
else:
flow_sessions_and_session_properties = []
for session in flow_sessions:
grading_rule = get_session_grading_rule(
session, pctx.role, flow_desc, now_datetime)
session_properties = SessionProperties(
due=grading_rule.due,
grade_description=grading_rule.description)
flow_sessions_and_session_properties.append(
(session, session_properties))
flow_sessions_and_session_properties = None
avg_grade_percentage, avg_grade_population = average_grade(opportunity)
return render_course_page(pctx, "course/gradebook-single.html", {
"opportunity": opportunity,
"avg_grade_percentage": avg_grade_percentage,
"avg_grade_population": avg_grade_population,
"grade_participation": participation,
"grade_state_change_types": grade_state_change_types,
"grade_changes": grade_changes,
"flow_sessions_and_session_properties": flow_sessions_and_session_properties,
"allow_session_actions": allow_session_actions,
"show_privileged_info": pctx.role in [
participation_role.instructor,
participation_role.teaching_assistant
],
# {{{ import grades
class ImportGradesForm(StyledForm):
def __init__(self, course, *args, **kwargs):
super(ImportGradesForm, self).__init__(*args, **kwargs)
self.fields["grading_opportunity"] = forms.ModelChoiceField(
queryset=(GradingOpportunity.objects
.filter(course=course)
.order_by("identifier")),
help_text="Click to <a href='%s' target='_blank'>create</a> "
"a new grading opportunity. Reload this form when done."
% reverse("admin:course_gradingopportunity_add"))
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
self.fields["attempt_id"] = forms.CharField(
initial="main",
required=True)
self.fields["file"] = forms.FileField()
self.fields["format"] = forms.ChoiceField(
choices=(
("csvhead", "CSV with Header"),
("csv", "CSV"),
))
self.fields["id_column"] = forms.IntegerField(
help_text="1-based column index for the Email or NetID "
"used to locate student record",
min_value=1)
self.fields["points_column"] = forms.IntegerField(
help_text="1-based column index for the (numerical) grade",
min_value=1)
self.fields["feedback_column"] = forms.IntegerField(
help_text="1-based column index for further (textual) feedback",
min_value=1, required=False)
self.fields["max_points"] = forms.DecimalField(
initial=100)
self.helper.add_input(
Submit("preview", "Preview",
css_class="col-lg-offset-2"))
self.helper.add_input(
Submit("import", "Import"))
class ParticipantNotFound(ValueError):
pass
def find_participant_from_id(course, id_str):
matches = (Participation.objects
.filter(
course=course,
.select_related("user"))
surviving_matches = []
for match in matches:
surviving_matches.append(match)
continue
at_index = email.index("@")
assert at_index > 0
uid = email[:at_index]
if uid == id_str:
surviving_matches.append(match)
continue
if not surviving_matches:
raise ParticipantNotFound(
"no participant found for '%s'" % id_str)
raise ParticipantNotFound(
"more than one participant found for '%s'" % id_str)
def fix_decimal(s):
if "," in s and "." not in s:
comma_count = len([c for c in s if c == ","])
if comma_count == 1:
return s.replace(",", ".")
else:
return s
else:
return s
def csv_to_grade_changes(
log_lines,
course, grading_opportunity, attempt_id, file_contents,
id_column, points_column, feedback_column, max_points,
creator, grade_time, has_header):
result = []
import csv
spamreader = csv.reader(file_contents)
for row in spamreader:
if has_header:
has_header = False
continue
gchange = GradeChange()
gchange.opportunity = grading_opportunity
try:
gchange.participation = find_participant_from_id(
course, row[id_column-1])
except ParticipantNotFound as e:
log_lines.append(e)
gchange.state = grade_state_change_types.graded
gchange.attempt_id = attempt_id
points_str = row[points_column-1].strip()
# Moodle's "NULL" grades look like this.
if points_str in ["-", ""]:
gchange.points = None
else:
gchange.points = float(fix_decimal(points_str))
gchange.max_points = max_points
if feedback_column is not None:
gchange.comment = row[feedback_column-1]
gchange.creator = creator
gchange.grade_time = grade_time
last_grades = (GradeChange.objects
.filter(
opportunity=grading_opportunity,
participation=gchange.participation,
attempt_id=gchange.attempt_id)
.order_by("-grade_time")[:1])
if last_grades.count():
last_grade, = last_grades
if last_grade.state == grade_state_change_types.graded:
updated = []
if last_grade.points != gchange.points:
updated.append("points")
if last_grade.max_points != gchange.max_points:
updated.append("max_points")
if last_grade.comment != gchange.comment:
updated.append("comment")