← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/worksheet.py

  • Committer: William Grant
  • Date: 2009-02-23 23:47:02 UTC
  • mfrom: (1099.1.211 new-dispatch)
  • Revision ID: grantw@unimelb.edu.au-20090223234702-db4b1llly46ignwo
Merge from lp:~ivle-dev/ivle/new-dispatch.

Pretty much everything changes. Reread the setup docs. Backup your databases.
Every file is now in a different installed location, the configuration system
is rewritten, the dispatch system is rewritten, URLs are different, the
database is different, worksheets and exercises are no longer on the
filesystem, we use a templating engine, jail service protocols are rewritten,
we don't repeat ourselves, we have authorization rewritten, phpBB is gone,
and probably lots of other things that I cannot remember.

This is certainly the biggest commit I have ever made, and hopefully
the largest I ever will.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/worksheet.py
23
23
This module provides functions for tutorial and worksheet computations.
24
24
"""
25
25
 
26
 
from storm.locals import And, Asc, Desc, Store
27
 
import genshi
28
 
 
 
26
from storm.locals import And, Asc, Desc
29
27
import ivle.database
30
 
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet, \
31
 
                          WorksheetExercise, Exercise
 
28
from ivle.database import ExerciseAttempt, ExerciseSave, Worksheet
32
29
 
33
30
__all__ = ['get_exercise_status', 'get_exercise_stored_text',
34
31
           'get_exercise_attempts', 'get_exercise_attempt',
35
32
          ]
36
33
 
37
 
def get_exercise_status(store, user, worksheet_exercise, as_of=None):
 
34
def get_exercise_status(store, user, worksheet_exercise):
38
35
    """Given a storm.store, User and Exercise, returns information about
39
36
    the user's performance on that problem.
40
 
    @param store: A storm.store
41
 
    @param user: A User.
42
 
    @param worksheet_exercise: An Exercise.
43
 
    @param as_of: Optional datetime. If supplied, gets the status as of as_of.
44
37
    Returns a tuple of:
45
38
        - A boolean, whether they have successfully passed this exercise.
46
39
        - An int, the number of attempts they have made up to and
52
45
    is_relevant = ((ExerciseAttempt.user_id == user.id) &
53
46
            (ExerciseAttempt.ws_ex_id == worksheet_exercise.id) &
54
47
            (ExerciseAttempt.active == True))
55
 
    if as_of is not None:
56
 
        is_relevant &= ExerciseAttempt.date <= as_of
57
48
 
58
49
    # Get the first successful active attempt, or None if no success yet.
59
50
    # (For this user, for this exercise).
168
159
    saved.date = date
169
160
    saved.text = text
170
161
 
171
 
def calculate_score(store, user, worksheet, as_of=None):
 
162
def calculate_score(store, user, worksheet):
172
163
    """
173
164
    Given a storm.store, User, Exercise and Worksheet, calculates a score for
174
165
    the user on the given worksheet.
175
 
    @param store: A storm.store
176
 
    @param user: A User.
177
 
    @param worksheet: A Worksheet.
178
 
    @param as_of: Optional datetime. If supplied, gets the score as of as_of.
179
166
    Returns a 4-tuple of ints, consisting of:
180
167
    (No. mandatory exercises completed,
181
168
     Total no. mandatory exercises,
193
180
        worksheet = worksheet_exercise.worksheet
194
181
        optional = worksheet_exercise.optional
195
182
 
196
 
        done, _ = get_exercise_status(store, user, worksheet_exercise, as_of)
 
183
        done, _ = get_exercise_status(store, user, worksheet_exercise)
197
184
        # done is a bool, whether this student has completed that problem
198
185
        if optional:
199
186
            opt_total += 1
203
190
            if done: mand_done += 1
204
191
 
205
192
    return mand_done, mand_total, opt_done, opt_total
206
 
 
207
 
def calculate_mark(mand_done, mand_total):
208
 
    """Calculate a subject mark, given the result of all worksheets.
209
 
    @param mand_done: The total number of mandatory exercises completed by
210
 
        some student, across all worksheets.
211
 
    @param mand_total: The total number of mandatory exercises across all
212
 
        worksheets in the offering.
213
 
    @return: (percent, mark, mark_total)
214
 
        percent: The percentage of exercises the student has completed, as an
215
 
            integer between 0 and 100 inclusive.
216
 
        mark: The mark the student has received, based on the percentage.
217
 
        mark_total: The total number of marks available (currently hard-coded
218
 
            as 5).
219
 
    """
220
 
    # We want to display a students mark out of 5. However, they are
221
 
    # allowed to skip 1 in 5 questions and still get 'full marks'.
222
 
    # Hence we divide by 16, essentially making 16 percent worth
223
 
    # 1 star, and 80 or above worth 5.
224
 
    if mand_total > 0:
225
 
        percent_int = (100 * mand_done) // mand_total
226
 
    else:
227
 
        # Avoid Div0, just give everyone 0 marks if there are none available
228
 
        percent_int = 0
229
 
    # percent / 16, rounded down, with a maximum mark of 5
230
 
    max_mark = 5
231
 
    mark = min(percent_int // 16, max_mark)
232
 
    return (percent_int, mark, max_mark)
233
 
 
234
 
def update_exerciselist(worksheet):
235
 
    """Runs through the worksheetstream, generating the appropriate
236
 
    WorksheetExercises, and de-activating the old ones."""
237
 
    exercises = []
238
 
    # Turns the worksheet into an xml stream, and then finds all the 
239
 
    # exercise nodes in the stream.
240
 
    worksheetdata = genshi.XML(worksheet.get_xml())
241
 
    for kind, data, pos in worksheetdata:
242
 
        if kind is genshi.core.START:
243
 
            # Data is a tuple of tag name and a list of name->value tuples
244
 
            if data[0] == 'exercise':
245
 
                src = ""
246
 
                optional = False
247
 
                for attr in data[1]:
248
 
                    if attr[0] == 'src':
249
 
                        src = attr[1]
250
 
                    if attr[0] == 'optional':
251
 
                        optional = attr[1] == 'true'
252
 
                if src != "":
253
 
                    exercises.append((src, optional))
254
 
    ex_num = 0
255
 
    # Set all current worksheet_exercises to be inactive
256
 
    db_worksheet_exercises = Store.of(worksheet).find(WorksheetExercise,
257
 
        WorksheetExercise.worksheet_id == worksheet.id)
258
 
    for worksheet_exercise in db_worksheet_exercises:
259
 
        worksheet_exercise.active = False
260
 
    
261
 
    for exerciseid, optional in exercises:
262
 
        worksheet_exercise = Store.of(worksheet).find(WorksheetExercise,
263
 
            WorksheetExercise.worksheet_id == worksheet.id,
264
 
            Exercise.id == WorksheetExercise.exercise_id,
265
 
            Exercise.id == exerciseid).one()
266
 
        if worksheet_exercise is None:
267
 
            exercise = Store.of(worksheet).find(Exercise,
268
 
                Exercise.id == exerciseid
269
 
            ).one()
270
 
            if exercise is None:
271
 
                raise NotFound()
272
 
            worksheet_exercise = WorksheetExercise()
273
 
            worksheet_exercise.worksheet_id = worksheet.id
274
 
            worksheet_exercise.exercise_id = exercise.id
275
 
            Store.of(worksheet).add(worksheet_exercise)
276
 
        worksheet_exercise.active = True
277
 
        worksheet_exercise.seq_no = ex_num
278
 
        worksheet_exercise.optional = optional
279