1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
Worksheet Utility Functions
23
This module provides functions for tutorial and worksheet computations.
26
from storm.locals import And, Asc, Desc
28
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet
30
__all__ = ['get_exercise_status', 'get_exercise_stored_text',
31
'get_exercise_attempts', 'get_exercise_attempt',
34
def get_exercise_status(store, user, exercise, worksheet):
35
"""Given a storm.store, User and Exercise, returns information about
36
the user's performance on that problem.
38
- A boolean, whether they have successfully passed this exercise.
39
- An int, the number of attempts they have made up to and
40
including the first successful attempt (or the total number of
41
attempts, if not yet successful).
43
# A Storm expression denoting all active attempts by this user for this
45
is_relevant = ((ExerciseAttempt.user_id == user.id) &
46
(ExerciseAttempt.exercise_id == exercise.id) &
47
(ExerciseAttempt.active == True) &
48
(ExerciseAttempt.worksheetid == worksheet.id))
50
# Get the first successful active attempt, or None if no success yet.
51
# (For this user, for this exercise).
52
first_success = store.find(ExerciseAttempt, is_relevant,
53
ExerciseAttempt.complete == True
54
).order_by(Asc(ExerciseAttempt.date)).first()
56
if first_success is not None:
57
# Get the total number of active attempts up to and including the
58
# first successful attempt.
59
# (Subsequent attempts don't count, because the user had already
61
num_attempts = store.find(ExerciseAttempt, is_relevant,
62
ExerciseAttempt.date <= first_success.date).count()
64
# User has not yet succeeded.
65
# Get the total number of active attempts.
66
num_attempts = store.find(ExerciseAttempt, is_relevant).count()
68
return first_success is not None, num_attempts
70
def get_exercise_stored_text(store, user, exercise, worksheet):
71
"""Given a storm.store, User and Exercise, returns an
72
ivle.database.ExerciseSave object for the last saved/submitted attempt for
73
this question (note that ExerciseAttempt is a subclass of ExerciseSave).
74
Returns None if the user has not saved or made an attempt on this
76
If the user has both saved and submitted, it returns whichever was
80
# Get the saved text, or None
81
saved = store.find(ExerciseSave,
82
ExerciseSave.user_id == user.id,
83
ExerciseSave.exercise_id == exercise.id,
84
ExerciseSave.worksheetid == worksheet.id).one()
86
# Get the most recent attempt, or None
87
attempt = store.find(ExerciseAttempt,
88
ExerciseAttempt.user_id == user.id,
89
ExerciseAttempt.exercise_id == exercise.id,
90
ExerciseAttempt.worksheetid == worksheet.id,
91
ExerciseAttempt.active == True,
92
).order_by(Asc(ExerciseAttempt.date)).last()
94
# Pick the most recent of these two
96
if attempt is not None:
97
return saved if saved.date > attempt.date else attempt
101
if attempt is not None:
106
def _get_exercise_attempts(store, user, exercise, worksheet, as_of=None,
107
allow_inactive=False):
108
"""Same as get_exercise_attempts, but doesn't convert Storm's iterator
111
# Get the most recent attempt before as_of, or None
112
return store.find(ExerciseAttempt,
113
ExerciseAttempt.user_id == user.id,
114
ExerciseAttempt.exercise_id == exercise.id,
115
ExerciseAttempt.worksheetid == worksheet.id,
116
True if allow_inactive else ExerciseAttempt.active == True,
117
True if as_of is None else ExerciseAttempt.date <= as_of,
118
).order_by(Desc(ExerciseAttempt.date))
120
def get_exercise_attempts(store, user, exercise, worksheet, as_of=None,
121
allow_inactive=False):
122
"""Given a storm.store, User and Exercise, returns a list of
123
ivle.database.ExerciseAttempt objects, one for each attempt made for the
124
exercise, sorted from latest to earliest.
126
as_of: Optional datetime.datetime object. If supplied, only returns
127
attempts made before or at this time.
128
allow_inactive: If True, will return disabled attempts.
130
return list(_get_exercise_attempts(store, user, exercise, worksheet, as_of,
133
def get_exercise_attempt(store, user, exercise, worksheet, as_of=None,
134
allow_inactive=False):
135
"""Given a storm.store, User and Exercise, returns an
136
ivle.database.ExerciseAttempt object for the last submitted attempt for
138
Returns None if the user has not made an attempt on this
141
as_of: Optional datetime.datetime object. If supplied, only returns
142
attempts made before or at this time.
143
allow_inactive: If True, will return disabled attempts.
145
return _get_exercise_attempts(store, user, exercise, worksheet, as_of,
146
allow_inactive).first()
148
def save_exercise(store, user, exercise, worksheet, text, date):
149
"""Save an exercise for a user.
151
Given a store, User, Exercise and text and date, save the text to the
152
database. This will create the ExerciseSave if needed.
154
saved = store.find(ivle.database.ExerciseSave,
155
ivle.database.ExerciseSave.user_id == user.id,
156
ivle.database.ExerciseSave.exercise_id == exercise.id,
157
ivle.database.ExerciseSave.worksheetid == worksheet.id
160
saved = ivle.database.ExerciseSave(user=user, exercise=exercise,
167
def calculate_score(store, user, worksheet):
169
Given a storm.store, User, Exercise and Worksheet, calculates a score for
170
the user on the given worksheet.
171
Returns a 4-tuple of ints, consisting of:
172
(No. mandatory exercises completed,
173
Total no. mandatory exercises,
174
No. optional exercises completed,
175
Total no. optional exercises)
182
# Get the student's pass/fail for each exercise in this worksheet
183
for worksheet_exercise in worksheet.worksheet_exercises:
184
exercise = worksheet_exercise.exercise
185
optional = worksheet_exercise.optional
187
done, _ = get_exercise_status(store, user, exercise)
188
# done is a bool, whether this student has completed that problem
191
if done: opt_done += 1
194
if done: mand_done += 1
196
return mand_done, mand_total, opt_done, opt_total
added
removed
ivle/worksheet.py
